@polyv/utils 2.0.0-beta.5 → 2.2.0-beta.1

package/dist/cjs/event.d.ts

@@ -0,0 +1,113 @@
+/**
+ * 本模块提供事件触发器类。
+ * @packageDocumentation
+ *
+ * @example
+ * ```js
+ * import { EventEmitter } from '@polyv/utils/es/event';
+ *
+ * const emitter = new EventEmitter();
+ * const context = { name: 'my name' };
+ *
+ * function eventHandler(e) {
+ *   console.log(e);
+ *   console.log(this === context); // true
+ * }
+ *
+ * // listen event
+ * emitter.on('foo', eventHandler, context);
+ *
+ * // listen once event
+ * emitter.once('foo', eventHandler, context);
+ *
+ * // fire event
+ * emitter.emit('foo', { a: 1 });
+ *
+ * // unlisten event
+ * emitter.off('foo', eventHandler);
+ *
+ * // ---------- use typescript define event parameter types ---------- //
+ * type EventParams = {
+ *   foo: string;
+ *   boo: number;
+ * };
+ *
+ * const emitter = new EventEmitter<EventParams>();
+ *
+ * emitter.on('foo', (e) => {}); // 'e' has inferred type 'string'
+ *
+ * emitter.emit('foo', 18); // Error: Argument of type 'number' is not assignable to parameter of type 'string'. (2345)
+ *
+ * // ---------- use typescript define event enum ---------- //
+ * enum TestEvent {
+ *   Foo = 'foo',
+ *   Bar = 'bar',
+ * }
+ *
+ * type TestEventParams = {
+ *   [TestEvent.Foo]: string;
+ *   [TestEvent.Bar]: number;
+ * };
+ *
+ * const emitter = new EventEmitter<TestEventParams, TestEvent>();
+ *
+ * emitter.emit(TestEvent.Foo, 'abc'); // ok
+ *
+ * emitter.emit('foo', 'abc'); // Error: Argument of type "'foo'" is not assignable to parameter of type 'TestEvent'. (2345)
+ * ```
+ */
+/**
+ * 事件类型
+ */
+export declare type EventType = string | symbol;
+/**
+ * 事件参数关系类型
+ */
+export declare type EventRelationsType = Record<EventType, unknown>;
+/**
+ * 事件回调函数类型
+ */
+export declare type EventHandler<Relations extends EventRelationsType, E extends EventType> = (params: Relations[E]) => unknown;
+export declare class EventEmitter<Relations extends EventRelationsType = EventRelationsType, Events extends EventType = string> {
+    /**
+     * 事件回调存储器
+     * @ignore
+     */
+    private __eventStore;
+    /**
+     * 添加监听事件
+     * @ignore
+     */
+    private __addOnEvent;
+    /**
+     * 监听事件
+     * @param event 事件名
+     * @param handler 回调函数
+     * @param context this 上下文
+     */
+    on<E extends Events>(event: E, handler: EventHandler<Relations, E>, context?: unknown): void;
+    /**
+     * 监听事件（一次性）
+     * @param event 事件名
+     * @param handler 回调函数
+     * @param context this 上下文
+     */
+    once<E extends Events>(event: E, handler: EventHandler<Relations, E>, context?: unknown): void;
+    /**
+     * 移除事件监听
+     * @param event 事件名
+     * @param handler 回调函数
+     */
+    off<E extends Events>(event: E, handler: unknown): void;
+    /**
+     * 触发事件
+     * @param event 事件名
+     * @param params 回调参数
+     */
+    emit<E extends Events>(event: E, params: Relations[E]): void;
+    emit<E extends Events>(event: undefined extends Relations[E] ? E : never): void;
+    /**
+     * 销毁实例
+     */
+    destroy(): void;
+}

package/dist/cjs/event.js

@@ -0,0 +1 @@
+"use strict";Object.defineProperty(exports,"__esModule",{value:!0}),exports.EventEmitter=void 0;var EventEmitter=function(){function t(){this.__eventStore={}}return t.prototype.__addOnEvent=function(t,e,n,o){if(e&&n){var r=this.__eventStore[e];r||(r=[]),r.push({type:t,handler:n,callbackHandler:n.bind(o)}),this.__eventStore[e]=r}},t.prototype.on=function(t,e,n){void 0===n&&(n=this),this.__addOnEvent("normal",t,e,n)},t.prototype.once=function(t,e,n){void 0===n&&(n=this),this.__addOnEvent("once",t,e,n)},t.prototype.off=function(t,e){var n=this.__eventStore[t];n&&(n=n.filter((function(t){return t.handler!==e})),this.__eventStore[t]=n)},t.prototype.emit=function(t,e){var n=this,o=this.__eventStore[t];o&&o.forEach((function(o){var r=o.type,i=o.handler,v=o.callbackHandler;"function"==typeof v&&v(e),"once"===r&&n.off(t,i)}))},t.prototype.destroy=function(){this.__eventStore={}},t}();exports.EventEmitter=EventEmitter;

package/dist/cjs/image.d.ts

@@ -0,0 +1,49 @@
+/**
+ * 本模块提供图片操作相关方法。
+ * @packageDocumentation
+ */
+/**
+ * 检查当前浏览器是否支持 WebP 格式。
+ * @returns 当前浏览器是否支持 WebP 格式。
+ */
+export declare function supportWebP(): boolean;
+/**
+ * 检查当前浏览器是否支持 AVIF 格式（注意，本函数是异步函数）。
+ * @returns 当前浏览器是否支持 AVIF 格式。
+ */
+export declare function supportAVIF(): Promise<boolean>;
+/**
+ * 压缩选项。
+ */
+export interface IOSSCompressOptions {
+    /**
+     * 压缩后的图片宽度。
+     */
+    width?: number;
+    /**
+     * 压缩后的图片高度。
+     */
+    height?: number;
+    /**
+     * 是否允许转换为 WebP。
+     */
+    allowWebP?: boolean;
+    /**
+     * 是否允许转换为 AVIF。
+     */
+    allowAVIF?: boolean;
+}
+/**
+ * 如果指定图片 URL 的域名是 OSS 域名，则追加 OSS 图片压缩参数。
+ * @param url 指定图片 URL。
+ * @param options 压缩选项。
+ * @returns 处理后的图片 URL。
+ * @example
+ * ```javascript
+ * ossCompress(url, {
+ *   width: 300,
+ *   allowWebp: true
+ * });
+ * ```
+ */
+export declare function ossCompress(url: string, options: IOSSCompressOptions): string;

package/dist/cjs/image.js

@@ -0,0 +1 @@
+"use strict";function supportWebP(){var A=document.createElement("canvas");if(A.getContext&&A.getContext("2d")){var e="image/webp";return 0===A.toDataURL(e).indexOf("data:"+e)}return!1}function supportAVIF(){return new Promise((function(A){var e=new Image;e.src="data:image/avif;base64,AAAAIGZ0eXBhdmlmAAAAAGF2aWZtaWYxbWlhZk1BMUIAAADybWV0YQAAAAAAAAAoaGRscgAAAAAAAAAAcGljdAAAAAAAAAAAAAAAAGxpYmF2aWYAAAAADnBpdG0AAAAAAAEAAAAeaWxvYwAAAABEAAABAAEAAAABAAABGgAAAB0AAAAoaWluZgAAAAAAAQAAABppbmZlAgAAAAABAABhdjAxQ29sb3IAAAAAamlwcnAAAABLaXBjbwAAABRpc3BlAAAAAAAAAAIAAAACAAAAEHBpeGkAAAAAAwgICAAAAAxhdjFDgQ0MAAAAABNjb2xybmNseAACAAIAAYAAAAAXaXBtYQAAAAAAAAABAAEEAQKDBAAAACVtZGF0EgAKCBgANogQEAwgMg8f8D///8WfhwB8+ErK42A=",e.onerror=function(){A(!1)},e.onload=function(){A(!0)},setTimeout((function(){A(!1)}),1e3)}))}function ossCompress(A,e){var t=document.createElement("a");t.href=A;var o=t.search;if("liveimages.videocc.net"!==t.hostname.toLowerCase()||/(?:\?|&)x-oss-process(?:=|&|$)/.test(o))return A;var s="";return null==e.width&&null==e.height||(s+="/resize,mfit",e.width&&(s+=",w_"+e.width),e.height&&(s+=",h_"+e.height),s+=",limit_1"),e.allowAVIF?s+="/format,avif":e.allowWebP&&(s+="/format,webp"),s&&(s="x-oss-process=image"+s,A+=(-1===A.indexOf("?")?"?":"&")+s),A}Object.defineProperty(exports,"__esModule",{value:!0}),exports.ossCompress=exports.supportAVIF=exports.supportWebP=void 0,exports.supportWebP=supportWebP,exports.supportAVIF=supportAVIF,exports.ossCompress=ossCompress;

package/dist/cjs/net.d.ts

@@ -21,7 +21,7 @@ export declare function startsWithProtocol(str: string, protocols?: string[]): b
 /**
  * 替换目标字符串中的 URL 协议。如果字符串中不包含协议，则加上协议。
  * @param url 目标字符串。
- * @param protocol 协议。
+ * @param protocol 协议（不含冒号和斜杠）。
  * @return 替换结果。
  * @example
  * ```javascript
@@ -30,3 +30,14 @@ export declare function startsWithProtocol(str: string, protocols?: string[]): b
  * ```
  */
 export declare function changeProtocol(url: string, protocol: string): string;
+/**
+ * 标准化（如果当前页面协议为 http，则为 http，否则为 https）目标字符串中的 URL 协议。
+ * @param url 目标字符串。
+ * @returns 标准化结果。
+ * ```javascript
+ * // 当前页面协议为 http 时，结果是 'http://abc.com'
+ * // 否则结果是 'https://abc.com'
+ * normalizeProtocol('http://abc.com');
+ * ```
+ */
+export declare function normalizeProtocol(url: string): string;

package/dist/cjs/net.js

@@ -1 +1 @@
-"use strict";Object.defineProperty(exports,"__esModule",{value:!0}),exports.changeProtocol=exports.startsWithProtocol=void 0;var reProtocol=/^(?:([a-z]+):)?\/{2,3}/i;function startsWithProtocol(o,t){var r=reProtocol.test(o);if(r&&t){for(var e=(RegExp.$1||"").toLowerCase(),c=t.length-1;c>=0;c--)if(e===t[c].toLowerCase())return!0;return!1}return r}function changeProtocol(o,t){return reProtocol.test(t)||(t+="://"),startsWithProtocol(o)?o.replace(reProtocol,t):t+o}exports.startsWithProtocol=startsWithProtocol,exports.changeProtocol=changeProtocol;
+"use strict";Object.defineProperty(exports,"__esModule",{value:!0}),exports.normalizeProtocol=exports.changeProtocol=exports.startsWithProtocol=void 0;var reProtocol=/^(?:([a-z]+):)?\/{2,3}/i;function startsWithProtocol(o,t){var r=reProtocol.test(o);if(r&&t){for(var e=(RegExp.$1||"").toLowerCase(),c=t.length-1;c>=0;c--)if(e===t[c].toLowerCase())return!0;return!1}return r}function changeProtocol(o,t){return reProtocol.test(t)||(t+="://"),startsWithProtocol(o)?o.replace(reProtocol,t):t+o}function normalizeProtocol(o){return changeProtocol(o,"http:"===window.location.protocol?"http":"https")}exports.startsWithProtocol=startsWithProtocol,exports.changeProtocol=changeProtocol,exports.normalizeProtocol=normalizeProtocol;

package/dist/es/event.d.ts

@@ -0,0 +1,113 @@
+/**
+ * 本模块提供事件触发器类。
+ * @packageDocumentation
+ *
+ * @example
+ * ```js
+ * import { EventEmitter } from '@polyv/utils/es/event';
+ *
+ * const emitter = new EventEmitter();
+ * const context = { name: 'my name' };
+ *
+ * function eventHandler(e) {
+ *   console.log(e);
+ *   console.log(this === context); // true
+ * }
+ *
+ * // listen event
+ * emitter.on('foo', eventHandler, context);
+ *
+ * // listen once event
+ * emitter.once('foo', eventHandler, context);
+ *
+ * // fire event
+ * emitter.emit('foo', { a: 1 });
+ *
+ * // unlisten event
+ * emitter.off('foo', eventHandler);
+ *
+ * // ---------- use typescript define event parameter types ---------- //
+ * type EventParams = {
+ *   foo: string;
+ *   boo: number;
+ * };
+ *
+ * const emitter = new EventEmitter<EventParams>();
+ *
+ * emitter.on('foo', (e) => {}); // 'e' has inferred type 'string'
+ *
+ * emitter.emit('foo', 18); // Error: Argument of type 'number' is not assignable to parameter of type 'string'. (2345)
+ *
+ * // ---------- use typescript define event enum ---------- //
+ * enum TestEvent {
+ *   Foo = 'foo',
+ *   Bar = 'bar',
+ * }
+ *
+ * type TestEventParams = {
+ *   [TestEvent.Foo]: string;
+ *   [TestEvent.Bar]: number;
+ * };
+ *
+ * const emitter = new EventEmitter<TestEventParams, TestEvent>();
+ *
+ * emitter.emit(TestEvent.Foo, 'abc'); // ok
+ *
+ * emitter.emit('foo', 'abc'); // Error: Argument of type "'foo'" is not assignable to parameter of type 'TestEvent'. (2345)
+ * ```
+ */
+/**
+ * 事件类型
+ */
+export declare type EventType = string | symbol;
+/**
+ * 事件参数关系类型
+ */
+export declare type EventRelationsType = Record<EventType, unknown>;
+/**
+ * 事件回调函数类型
+ */
+export declare type EventHandler<Relations extends EventRelationsType, E extends EventType> = (params: Relations[E]) => unknown;
+export declare class EventEmitter<Relations extends EventRelationsType = EventRelationsType, Events extends EventType = string> {
+    /**
+     * 事件回调存储器
+     * @ignore
+     */
+    private __eventStore;
+    /**
+     * 添加监听事件
+     * @ignore
+     */
+    private __addOnEvent;
+    /**
+     * 监听事件
+     * @param event 事件名
+     * @param handler 回调函数
+     * @param context this 上下文
+     */
+    on<E extends Events>(event: E, handler: EventHandler<Relations, E>, context?: unknown): void;
+    /**
+     * 监听事件（一次性）
+     * @param event 事件名
+     * @param handler 回调函数
+     * @param context this 上下文
+     */
+    once<E extends Events>(event: E, handler: EventHandler<Relations, E>, context?: unknown): void;
+    /**
+     * 移除事件监听
+     * @param event 事件名
+     * @param handler 回调函数
+     */
+    off<E extends Events>(event: E, handler: unknown): void;
+    /**
+     * 触发事件
+     * @param event 事件名
+     * @param params 回调参数
+     */
+    emit<E extends Events>(event: E, params: Relations[E]): void;
+    emit<E extends Events>(event: undefined extends Relations[E] ? E : never): void;
+    /**
+     * 销毁实例
+     */
+    destroy(): void;
+}

package/dist/es/event.js

@@ -0,0 +1 @@
+export class EventEmitter{constructor(){this.__eventStore={}}__addOnEvent(t,e,n,o){if(!e||!n)return;let r=this.__eventStore[e];r||(r=[]),r.push({type:t,handler:n,callbackHandler:n.bind(o)}),this.__eventStore[e]=r}on(t,e,n=this){this.__addOnEvent("normal",t,e,n)}once(t,e,n=this){this.__addOnEvent("once",t,e,n)}off(t,e){let n=this.__eventStore[t];n&&(n=n.filter((t=>t.handler!==e)),this.__eventStore[t]=n)}emit(t,e){const n=this.__eventStore[t];n&&n.forEach((n=>{const{type:o,handler:r,callbackHandler:_}=n;"function"==typeof _&&_(e),"once"===o&&this.off(t,r)}))}destroy(){this.__eventStore={}}}

package/dist/es/image.d.ts

@@ -0,0 +1,49 @@
+/**
+ * 本模块提供图片操作相关方法。
+ * @packageDocumentation
+ */
+/**
+ * 检查当前浏览器是否支持 WebP 格式。
+ * @returns 当前浏览器是否支持 WebP 格式。
+ */
+export declare function supportWebP(): boolean;
+/**
+ * 检查当前浏览器是否支持 AVIF 格式（注意，本函数是异步函数）。
+ * @returns 当前浏览器是否支持 AVIF 格式。
+ */
+export declare function supportAVIF(): Promise<boolean>;
+/**
+ * 压缩选项。
+ */
+export interface IOSSCompressOptions {
+    /**
+     * 压缩后的图片宽度。
+     */
+    width?: number;
+    /**
+     * 压缩后的图片高度。
+     */
+    height?: number;
+    /**
+     * 是否允许转换为 WebP。
+     */
+    allowWebP?: boolean;
+    /**
+     * 是否允许转换为 AVIF。
+     */
+    allowAVIF?: boolean;
+}
+/**
+ * 如果指定图片 URL 的域名是 OSS 域名，则追加 OSS 图片压缩参数。
+ * @param url 指定图片 URL。
+ * @param options 压缩选项。
+ * @returns 处理后的图片 URL。
+ * @example
+ * ```javascript
+ * ossCompress(url, {
+ *   width: 300,
+ *   allowWebp: true
+ * });
+ * ```
+ */
+export declare function ossCompress(url: string, options: IOSSCompressOptions): string;

package/dist/es/image.js

@@ -0,0 +1 @@
+export function supportWebP(){const A=document.createElement("canvas");if(A.getContext&&A.getContext("2d")){const e="image/webp";return 0===A.toDataURL(e).indexOf("data:"+e)}return!1}export function supportAVIF(){return new Promise((A=>{const e=new Image;e.src="data:image/avif;base64,AAAAIGZ0eXBhdmlmAAAAAGF2aWZtaWYxbWlhZk1BMUIAAADybWV0YQAAAAAAAAAoaGRscgAAAAAAAAAAcGljdAAAAAAAAAAAAAAAAGxpYmF2aWYAAAAADnBpdG0AAAAAAAEAAAAeaWxvYwAAAABEAAABAAEAAAABAAABGgAAAB0AAAAoaWluZgAAAAAAAQAAABppbmZlAgAAAAABAABhdjAxQ29sb3IAAAAAamlwcnAAAABLaXBjbwAAABRpc3BlAAAAAAAAAAIAAAACAAAAEHBpeGkAAAAAAwgICAAAAAxhdjFDgQ0MAAAAABNjb2xybmNseAACAAIAAYAAAAAXaXBtYQAAAAAAAAABAAEEAQKDBAAAACVtZGF0EgAKCBgANogQEAwgMg8f8D///8WfhwB8+ErK42A=",e.onerror=()=>{A(!1)},e.onload=()=>{A(!0)},setTimeout((()=>{A(!1)}),1e3)}))}export function ossCompress(A,e){const t=document.createElement("a");t.href=A;const o=t.search;if("liveimages.videocc.net"!==t.hostname.toLowerCase()||/(?:\?|&)x-oss-process(?:=|&|$)/.test(o))return A;let a="";return null==e.width&&null==e.height||(a+="/resize,mfit",e.width&&(a+=",w_"+e.width),e.height&&(a+=",h_"+e.height),a+=",limit_1"),e.allowAVIF?a+="/format,avif":e.allowWebP&&(a+="/format,webp"),a&&(a="x-oss-process=image"+a,A+=(-1===A.indexOf("?")?"?":"&")+a),A}

package/dist/es/net.d.ts

@@ -21,7 +21,7 @@ export declare function startsWithProtocol(str: string, protocols?: string[]): b
 /**
  * 替换目标字符串中的 URL 协议。如果字符串中不包含协议，则加上协议。
  * @param url 目标字符串。
- * @param protocol 协议。
+ * @param protocol 协议（不含冒号和斜杠）。
  * @return 替换结果。
  * @example
  * ```javascript
@@ -30,3 +30,14 @@ export declare function startsWithProtocol(str: string, protocols?: string[]): b
  * ```
  */
 export declare function changeProtocol(url: string, protocol: string): string;
+/**
+ * 标准化（如果当前页面协议为 http，则为 http，否则为 https）目标字符串中的 URL 协议。
+ * @param url 目标字符串。
+ * @returns 标准化结果。
+ * ```javascript
+ * // 当前页面协议为 http 时，结果是 'http://abc.com'
+ * // 否则结果是 'https://abc.com'
+ * normalizeProtocol('http://abc.com');
+ * ```
+ */
+export declare function normalizeProtocol(url: string): string;

package/dist/es/net.js

@@ -1 +1 @@
-const reProtocol=/^(?:([a-z]+):)?\/{2,3}/i;export function startsWithProtocol(o,t){const r=reProtocol.test(o);if(r&&t){const o=(RegExp.$1||"").toLowerCase();for(let r=t.length-1;r>=0;r--)if(o===t[r].toLowerCase())return!0;return!1}return r}export function changeProtocol(o,t){return reProtocol.test(t)||(t+="://"),startsWithProtocol(o)?o.replace(reProtocol,t):t+o}
+const reProtocol=/^(?:([a-z]+):)?\/{2,3}/i;export function startsWithProtocol(o,t){const r=reProtocol.test(o);if(r&&t){const o=(RegExp.$1||"").toLowerCase();for(let r=t.length-1;r>=0;r--)if(o===t[r].toLowerCase())return!0;return!1}return r}export function changeProtocol(o,t){return reProtocol.test(t)||(t+="://"),startsWithProtocol(o)?o.replace(reProtocol,t):t+o}export function normalizeProtocol(o){return changeProtocol(o,"http:"===window.location.protocol?"http":"https")}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@polyv/utils",
-  "version": "2.0.0-beta.5",
+  "version": "2.2.0-beta.1",
   "description": "Utility functions of Polyv frontend development.",
   "keywords": [
     "polyv",