@odinlin/utils 0.0.2 → 1.0.1

package/dist/node/request/interceptors.node.js

@@ -0,0 +1,63 @@
+import { isNull, isString } from "../is/isPrimitive.js";
+import { isJSONString } from "../is/isJSON.js";
+import { FileBuffer } from "../file/fileBuffer.node.js";
+import { Request } from "./instance.js";
+import { AxiosError } from "axios";
+
+//#region src/request/interceptors.node.ts
+/**
+* 预设拦截器 - 响应耗时
+*/
+const presetInterceptorWithResponseLog = { response: {
+	onFulfilled(res) {
+		const { config } = res;
+		const requestId = config.headers["X-Request-Id"];
+		Request.getOptionValue(config, "enableTimeConsuming") && console.timeEnd(`[presetInterceptorWithLog] ${requestId}`);
+		return res;
+	},
+	onRejected(err) {
+		const requestId = err.config.headers["X-Request-Id"];
+		Request.getOptionValue(err.config, "enableTimeConsuming") && console.timeEnd(`[presetInterceptorWithLog] ${requestId}`);
+		throw err;
+	}
+} };
+/**
+* 预设拦截器 - 响应尝试 JSON 解析，若解析成功，则将解析结果赋值给 res.dataJSON，不会影响后续拦截器的参数
+* @description 若 responseType 为 json 或 forcedJSONParsing 为 true ，则尝试解析响应体为 JSON 字符串
+* @description 其中前提是通过 `transformResponse: []` 覆盖内置的默认 transformResponse 函数
+*/
+const presetInterceptorWithResponseJSON = { response: { async onFulfilled(res) {
+	const { config, request, data } = res;
+	const allowJSONRequested = config.responseType === "json" || (config.transitional?.forcedJSONParsing ?? true);
+	let tempData = null;
+	if (isString(data) && allowJSONRequested) tempData = data;
+	else if (FileBuffer.isBlob(data) && data.type === "application/json" && allowJSONRequested) tempData = (await FileBuffer.fromBlob(data)).toString();
+	if (isNull(tempData)) return res;
+	const [err, json] = isJSONString(tempData, config.parseReviver);
+	if (err) {
+		if (!(config.transitional?.silentJSONParsing ?? false)) throw err.name === "SyntaxError" ? AxiosError.from(err, AxiosError.ERR_BAD_RESPONSE, config, request, res) : err;
+		return res;
+	}
+	res.dataJSON = json;
+	return res;
+} } };
+/**
+* 预设拦截器 - 请求耗时
+*/
+const presetInterceptorWithRequestLog = { request: { onFulfilled(config) {
+	const requestId = Date.now().toString();
+	config.headers["X-Request-Id"] = requestId;
+	Request.getOptionValue(config, "enableTimeConsuming") && console.time(`[presetInterceptorWithLog] ${requestId}`);
+	return config;
+} } };
+/**
+* 预设拦截器 - 请求认证
+*/
+const presetInterceptorWithRequestAuth = { request: { onFulfilled(config) {
+	config.headers.setAuthorization(`Bearer ${sessionStorage.getItem("Authorization") || ""}`);
+	return config;
+} } };
+
+//#endregion
+export { presetInterceptorWithRequestAuth, presetInterceptorWithRequestLog, presetInterceptorWithResponseJSON, presetInterceptorWithResponseLog };
+//# sourceMappingURL=interceptors.node.js.map

package/dist/node/request/interceptors.node.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"interceptors.node.js","names":["presetInterceptorWithResponseLog: AxiosInterceptorParameters","presetInterceptorWithResponseJSON: AxiosInterceptorParameters","tempData: string | null","presetInterceptorWithRequestLog: AxiosInterceptorParameters","presetInterceptorWithRequestAuth: AxiosInterceptorParameters"],"sources":["../../../src/request/interceptors.node.ts"],"sourcesContent":["/* eslint-disable no-console */\nimport type { AxiosInterceptorParameters } from './interface'\nimport { AxiosError } from 'axios'\nimport { FileBuffer } from '../file/node'\nimport { isJSONString, isNull, isString } from '../is'\nimport { Request } from './instance'\n\n/**\n * 预设拦截器 - 响应耗时\n */\nexport const presetInterceptorWithResponseLog: AxiosInterceptorParameters = {\n  response: {\n    onFulfilled(res) {\n      const { config } = res\n      const requestId = config.headers['X-Request-Id']\n      const enableTimeConsuming = Request.getOptionValue<boolean | undefined>(config, 'enableTimeConsuming')\n      enableTimeConsuming && console.timeEnd(`[presetInterceptorWithLog] ${requestId}`)\n      return res\n    },\n    onRejected(err) {\n      const requestId = err.config.headers['X-Request-Id']\n      const enableTimeConsuming = Request.getOptionValue<boolean | undefined>(err.config, 'enableTimeConsuming')\n      enableTimeConsuming && console.timeEnd(`[presetInterceptorWithLog] ${requestId}`)\n      throw err\n    },\n  },\n}\n\n/**\n * 预设拦截器 - 响应尝试 JSON 解析，若解析成功，则将解析结果赋值给 res.dataJSON，不会影响后续拦截器的参数\n * @description 若 responseType 为 json 或 forcedJSONParsing 为 true ，则尝试解析响应体为 JSON 字符串\n * @description 其中前提是通过 `transformResponse: []` 覆盖内置的默认 transformResponse 函数\n */\nexport const presetInterceptorWithResponseJSON: AxiosInterceptorParameters = {\n  response: {\n    async onFulfilled(res) {\n      const { config, request, data } = res\n      const responseType = config.responseType\n      const JSONRequested = responseType === 'json'\n      const allowJSONRequested = JSONRequested || (config.transitional?.forcedJSONParsing ?? true)\n\n      let tempData: string | null = null\n      // 类型为字符串，且 allowJSONRequested 为 true ，则尝试解析\n      if (isString(data) && allowJSONRequested) {\n        tempData = data\n      }\n      // 类型为 Blob ，且 mime type 为 application/json ，且 allowJSONRequested 为 true ，则尝试解析\n      else if (FileBuffer.isBlob(data) && data.type === 'application/json' && allowJSONRequested) {\n        const buf = await FileBuffer.fromBlob(data)\n        tempData = buf.toString()\n      }\n\n      // 不满足上述条件，直接返回\n      if (isNull(tempData)) return res\n      // 通过 parseReviver 尝试解析 tempData 字符串\n      const [err, json] = isJSONString<any>(tempData, config.parseReviver)\n      // 优先处理错误，若 silentJSONParsing 为 false ，则抛出错误；否则返回原始值\n      if (err) {\n        const silentJSONParsing = config.transitional?.silentJSONParsing ?? false\n        if (!silentJSONParsing) {\n          throw err.name === 'SyntaxError' ? AxiosError.from(err, AxiosError.ERR_BAD_RESPONSE, config, request, res) : err\n        }\n        return res\n      }\n      // 若解析成功，则返回解析结果\n      (res as any).dataJSON = json\n      return res\n    },\n  },\n}\n\n/**\n * 预设拦截器 - 请求耗时\n */\nexport const presetInterceptorWithRequestLog: AxiosInterceptorParameters = {\n  request: {\n    onFulfilled(config) {\n      const requestId = Date.now().toString()\n      config.headers['X-Request-Id'] = requestId\n      const enableTimeConsuming = Request.getOptionValue<boolean | undefined>(config, 'enableTimeConsuming')\n      enableTimeConsuming && console.time(`[presetInterceptorWithLog] ${requestId}`)\n      return config\n    },\n  },\n}\n\n/**\n * 预设拦截器 - 请求认证\n */\nexport const presetInterceptorWithRequestAuth: AxiosInterceptorParameters = {\n  request: {\n    onFulfilled(config) {\n      config.headers.setAuthorization(`Bearer ${sessionStorage.getItem('Authorization') || ''}`)\n      return config\n    },\n  },\n}\n"],"mappings":";;;;;;;;;;AAUA,MAAaA,mCAA+D,EAC1E,UAAU;CACR,YAAY,KAAK;EACf,MAAM,EAAE,WAAW;EACnB,MAAM,YAAY,OAAO,QAAQ;AAEjC,EAD4B,QAAQ,eAAoC,QAAQ,sBAAsB,IAC/E,QAAQ,QAAQ,8BAA8B,YAAY;AACjF,SAAO;;CAET,WAAW,KAAK;EACd,MAAM,YAAY,IAAI,OAAO,QAAQ;AAErC,EAD4B,QAAQ,eAAoC,IAAI,QAAQ,sBAAsB,IACnF,QAAQ,QAAQ,8BAA8B,YAAY;AACjF,QAAM;;CAET,EACF;;;;;;AAOD,MAAaC,oCAAgE,EAC3E,UAAU,EACR,MAAM,YAAY,KAAK;CACrB,MAAM,EAAE,QAAQ,SAAS,SAAS;CAGlC,MAAM,qBAFe,OAAO,iBACW,WACM,OAAO,cAAc,qBAAqB;CAEvF,IAAIC,WAA0B;AAE9B,KAAI,SAAS,KAAK,IAAI,mBACpB,YAAW;UAGJ,WAAW,OAAO,KAAK,IAAI,KAAK,SAAS,sBAAsB,mBAEtE,aADY,MAAM,WAAW,SAAS,KAAK,EAC5B,UAAU;AAI3B,KAAI,OAAO,SAAS,CAAE,QAAO;CAE7B,MAAM,CAAC,KAAK,QAAQ,aAAkB,UAAU,OAAO,aAAa;AAEpE,KAAI,KAAK;AAEP,MAAI,EADsB,OAAO,cAAc,qBAAqB,OAElE,OAAM,IAAI,SAAS,gBAAgB,WAAW,KAAK,KAAK,WAAW,kBAAkB,QAAQ,SAAS,IAAI,GAAG;AAE/G,SAAO;;AAGT,CAAC,IAAY,WAAW;AACxB,QAAO;GAEV,EACF;;;;AAKD,MAAaC,kCAA8D,EACzE,SAAS,EACP,YAAY,QAAQ;CAClB,MAAM,YAAY,KAAK,KAAK,CAAC,UAAU;AACvC,QAAO,QAAQ,kBAAkB;AAEjC,CAD4B,QAAQ,eAAoC,QAAQ,sBAAsB,IAC/E,QAAQ,KAAK,8BAA8B,YAAY;AAC9E,QAAO;GAEV,EACF;;;;AAKD,MAAaC,mCAA+D,EAC1E,SAAS,EACP,YAAY,QAAQ;AAClB,QAAO,QAAQ,iBAAiB,UAAU,eAAe,QAAQ,gBAAgB,IAAI,KAAK;AAC1F,QAAO;GAEV,EACF"}

package/dist/node/request/interface.d.ts

@@ -0,0 +1,54 @@
+import { Axios, AxiosRequestConfig, CreateAxiosDefaults } from "axios";
+
+//#region src/request/interface.d.ts
+
+/**
+ * 提取 axios 拦截器参数类型
+ */
+interface AxiosInterceptorParameters {
+  /** 请求拦截器 */
+  request?: {
+    onFulfilled?: Parameters<Axios['interceptors']['request']['use']>[0];
+    onRejected?: Parameters<Axios['interceptors']['request']['use']>[1];
+    options?: Parameters<Axios['interceptors']['request']['use']>[2];
+  };
+  /** 响应拦截器 */
+  response?: {
+    onFulfilled?: Parameters<Axios['interceptors']['response']['use']>[0];
+    onRejected?: Parameters<Axios['interceptors']['response']['use']>[1];
+  };
+}
+/**
+ * 包装 axios.create 参数，额外传递自定义参数
+ * @function 1. 支持将额外的自定义 options 合并到 fetchOptions 并往下传递
+ * @function 2. 待注册的自定义拦截器
+ */
+interface AxiosCreateDefaultsWrapper<CustomOptions extends Record<string, any> = Record<string, any>, ReqData = any> extends CreateAxiosDefaults<ReqData> {
+  /** custom 可在拦截器内传递的配置选项 */
+  options?: CustomOptions;
+  /** custom 待注册的自定义拦截器 - 拦截器 request 先注册后执行，拦截器 response 先注册先执行 */
+  interceptors?: Array<AxiosInterceptorParameters>;
+}
+/**
+ * 包装 axios 请求体
+ * @function 1. 支持 params 泛型
+ * @function 2. 支持 argsRegexp、args 实现动态路径
+ * @function 3. 支持将额外的自定义 options 合并到 fetchOptions 并往下传递
+ */
+interface AxiosRequestConfigWrapper<CustomOptions extends Record<string, any> = Record<string, any>, ReqData = any, ReqParams = any, ReqArgs extends Record<string, any> = Record<string, any>> extends AxiosRequestConfig<ReqData> {
+  /** override 指定 query 参数的类型定义 */
+  params?: ReqParams;
+  /** custom 动态路径匹配规则 */
+  argsRegexp?: RegExp;
+  /** custom 动态路径匹配对象 */
+  args?: ReqArgs;
+  /** custom 可在拦截器内传递的配置选项 */
+  options?: CustomOptions;
+}
+/**
+ * 包装 axios 响应体，参考 await-to-js 包装 promise 实现错误优先，并实现类型收窄
+ */
+type AxiosResponseWrapper<E extends Error, R = any> = [null, R] | [E, undefined];
+//#endregion
+export { AxiosCreateDefaultsWrapper, AxiosInterceptorParameters, AxiosRequestConfigWrapper, AxiosResponseWrapper };
+//# sourceMappingURL=interface.d.ts.map

package/dist/node/request/interface.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"interface.d.ts","names":[],"sources":["../../../src/request/interface.ts"],"sourcesContent":[],"mappings":";;;;;;AAKA;AAG6B,UAHZ,0BAAA,CAGY;EAAX;EACU,OAAA,CAAA,EAAA;IAAX,WAAA,CAAA,EADC,UACD,CADY,KACZ,CAAA,cAAA,CAAA,CAAA,SAAA,CAAA,CAAA,KAAA,CAAA,CAAA,CAAA,CAAA,CAAA;IACQ,UAAA,CAAA,EADR,UACQ,CADG,KACH,CAAA,cAAA,CAAA,CAAA,SAAA,CAAA,CAAA,KAAA,CAAA,CAAA,CAAA,CAAA,CAAA;IAAX,OAAA,CAAA,EAAA,UAAA,CAAW,KAAX,CAAA,cAAA,CAAA,CAAA,SAAA,CAAA,CAAA,KAAA,CAAA,CAAA,CAAA,CAAA,CAAA;EAIe,CAAA;EAAX;EACU,QAAA,CAAA,EAAA;IAAX,WAAA,CAAA,EADC,UACD,CADY,KACZ,CAAA,cAAA,CAAA,CAAA,UAAA,CAAA,CAAA,KAAA,CAAA,CAAA,CAAA,CAAA,CAAA;IAAU,UAAA,CAAA,EAAV,UAAU,CAAC,KAAD,CAAA,cAAA,CAAA,CAAA,UAAA,CAAA,CAAA,KAAA,CAAA,CAAA,CAAA,CAAA,CAAA;EASV,CAAA;;;;;;;AAAmH,UAAnH,0BAAmH,CAAA,sBAAlE,MAAkE,CAAA,MAAA,EAAA,GAAA,CAAA,GAA5C,MAA4C,CAAA,MAAA,EAAA,GAAA,CAAA,EAAA,UAAA,GAAA,CAAA,SAAA,mBAAA,CAAoB,OAApB,CAAA,CAAA;EAAmB;EAatI,OAAA,CAAA,EAXL,aAWK;EAAgD;EAAsB,YAAA,CAAA,EATtE,KASsE,CAThE,0BASgE,CAAA;;;;;;;;AAC7E,UADO,yBACP,CAAA,sBADuD,MACvD,CAAA,MAAA,EAAA,GAAA,CAAA,GAD6E,MAC7E,CAAA,MAAA,EAAA,GAAA,CAAA,EAAA,UAAA,GAAA,EAAA,YAAA,GAAA,EAAA,gBADkJ,MAClJ,CAAA,MAAA,EAAA,GAAA,CAAA,GADwK,MACxK,CAAA,MAAA,EAAA,GAAA,CAAA,CAAA,SAAA,kBAAA,CAAmB,OAAnB,CAAA,CAAA;EAAkB;EAchB,MAAA,CAAA,EAZD,SAYC;EAA+B;EAAyB,UAAA,CAAA,EAVrD,MAUqD;EAAM;EAAC,IAAA,CAAA,EARlE,OAQkE;;YAN/D;;;;;KAMA,+BAA+B,yBAAyB,MAAM"}

package/dist/node/request/node.cjs

@@ -0,0 +1,8 @@
+const require_instance = require('./instance.cjs');
+const require_interceptors_node = require('./interceptors.node.cjs');
+
+exports.Request = require_instance.Request;
+exports.presetInterceptorWithRequestAuth = require_interceptors_node.presetInterceptorWithRequestAuth;
+exports.presetInterceptorWithRequestLog = require_interceptors_node.presetInterceptorWithRequestLog;
+exports.presetInterceptorWithResponseJSON = require_interceptors_node.presetInterceptorWithResponseJSON;
+exports.presetInterceptorWithResponseLog = require_interceptors_node.presetInterceptorWithResponseLog;

package/dist/node/request/node.d.ts

@@ -0,0 +1,4 @@
+import { AxiosCreateDefaultsWrapper, AxiosInterceptorParameters, AxiosRequestConfigWrapper, AxiosResponseWrapper } from "./interface.js";
+import { presetInterceptorWithRequestAuth, presetInterceptorWithRequestLog, presetInterceptorWithResponseJSON, presetInterceptorWithResponseLog } from "./interceptors.node.js";
+import { Request } from "./instance.js";
+export { AxiosCreateDefaultsWrapper, AxiosInterceptorParameters, AxiosRequestConfigWrapper, AxiosResponseWrapper, Request, presetInterceptorWithRequestAuth, presetInterceptorWithRequestLog, presetInterceptorWithResponseJSON, presetInterceptorWithResponseLog };

package/dist/node/request/node.js

@@ -0,0 +1,4 @@
+import { Request } from "./instance.js";
+import { presetInterceptorWithRequestAuth, presetInterceptorWithRequestLog, presetInterceptorWithResponseJSON, presetInterceptorWithResponseLog } from "./interceptors.node.js";
+
+export { Request, presetInterceptorWithRequestAuth, presetInterceptorWithRequestLog, presetInterceptorWithResponseJSON, presetInterceptorWithResponseLog };

package/dist/node/string/className.cjs

@@ -0,0 +1,13 @@
+const require_rolldown_runtime = require('../_virtual/rolldown_runtime.cjs');
+let classnames = require("classnames");
+classnames = require_rolldown_runtime.__toESM(classnames);
+let clsx = require("clsx");
+clsx = require_rolldown_runtime.__toESM(clsx);
+
+//#region src/string/className.ts
+const stringClsn = (...args) => (0, classnames.default)(...args);
+const stringClsx = clsx.default;
+
+//#endregion
+exports.stringClsn = stringClsn;
+exports.stringClsx = stringClsx;

package/dist/node/string/className.d.ts

@@ -0,0 +1,11 @@
+import { Argument } from "classnames";
+import clsx, { ClassValue } from "clsx";
+
+//#region src/string/className.d.ts
+type StringClsnValue = Argument;
+type StringClsxValue = ClassValue;
+declare const stringClsn: (...args: Argument[]) => string;
+declare const stringClsx: typeof clsx;
+//#endregion
+export { StringClsnValue, StringClsxValue, stringClsn, stringClsx };
+//# sourceMappingURL=className.d.ts.map

package/dist/node/string/className.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"className.d.ts","names":[],"sources":["../../../src/string/className.ts"],"sourcesContent":[],"mappings":";;;;KAKY,eAAA,GAAkB;AAAlB,KACA,eAAA,GAAkB,UADA;AAClB,cAEC,UAFc,EAAG,CAAA,GAAA,IAAA,EAEM,QAFI,EAAA,EAAA,GAAA,MAAA;AAE3B,cACA,UADuB,EAAA,OACb,IADqB"}

package/dist/node/string/className.js

@@ -0,0 +1,10 @@
+import clsn from "classnames";
+import clsx from "clsx";
+
+//#region src/string/className.ts
+const stringClsn = (...args) => clsn(...args);
+const stringClsx = clsx;
+
+//#endregion
+export { stringClsn, stringClsx };
+//# sourceMappingURL=className.js.map

package/dist/node/string/className.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"className.js","names":[],"sources":["../../../src/string/className.ts"],"sourcesContent":["import type { Argument } from 'classnames'\nimport type { ClassValue } from 'clsx'\nimport clsn from 'classnames'\nimport clsx from 'clsx'\n\nexport type StringClsnValue = Argument\nexport type StringClsxValue = ClassValue\n\nexport const stringClsn = (...args: Argument[]): string => clsn(...args)\nexport const stringClsx = clsx\n"],"mappings":";;;;AAQA,MAAa,cAAc,GAAG,SAA6B,KAAK,GAAG,KAAK;AACxE,MAAa,aAAa"}

package/dist/node/string/index.cjs

@@ -0,0 +1,7 @@
+const require_className = require('./className.cjs');
+const require_proto = require('./proto.cjs');
+
+exports.stringClsn = require_className.stringClsn;
+exports.stringClsx = require_className.stringClsx;
+exports.stringReplaceParametersWithObj = require_proto.stringReplaceParametersWithObj;
+exports.stringSliceParametersWithSort = require_proto.stringSliceParametersWithSort;

package/dist/node/string/index.d.ts

@@ -0,0 +1,3 @@
+import { StringClsnValue, StringClsxValue, stringClsn, stringClsx } from "./className.js";
+import { stringReplaceParametersWithObj, stringSliceParametersWithSort } from "./proto.js";
+export { StringClsnValue, StringClsxValue, stringClsn, stringClsx, stringReplaceParametersWithObj, stringSliceParametersWithSort };

package/dist/node/string/index.js

@@ -0,0 +1,4 @@
+import { stringClsn, stringClsx } from "./className.js";
+import { stringReplaceParametersWithObj, stringSliceParametersWithSort } from "./proto.js";
+
+export { stringClsn, stringClsx, stringReplaceParametersWithObj, stringSliceParametersWithSort };

package/dist/node/string/proto.cjs

@@ -0,0 +1,37 @@
+const require_rolldown_runtime = require('../_virtual/rolldown_runtime.cjs');
+const require_isPrimitive = require('../is/isPrimitive.cjs');
+let es_toolkit = require("es-toolkit");
+
+//#region src/string/proto.ts
+/**
+* 方法 `String.prototype.replace` 的第二个参数的快捷实现，可根据对象的键值对进行替换
+*
+* @example args =  [ 'h', 0, 'hello' ]
+* @example args =  [ '[h]', 'h', 0, '[h][e][l][l][o]' ]
+*/
+function stringReplaceParametersWithObj(obj) {
+	return (...args) => {
+		const substring = (0, es_toolkit.at)(args, [-3])[0];
+		if (substring && Object.prototype.hasOwnProperty.call(obj, substring)) return obj[substring];
+		return (0, es_toolkit.head)(args);
+	};
+}
+/**
+* 方法 `String.prototype.slice` 的参数，额外支持索引区间排序问题
+*
+* @reference https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String/slice
+* @reference https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String/substring
+* @reference https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String/substr
+*/
+function stringSliceParametersWithSort(start, end) {
+	const startArg = Number.isSafeInteger(start) ? start : 0;
+	const endArg = !require_isPrimitive.isNotNumber(end) ? end : 0;
+	if (require_isPrimitive.isUndefined(endArg)) return [startArg];
+	if (startArg >= 0 && endArg < 0) return [startArg, endArg];
+	if (startArg < 0 && endArg >= 0) return [endArg, startArg];
+	return [startArg, endArg].sort((a, b) => a - b);
+}
+
+//#endregion
+exports.stringReplaceParametersWithObj = stringReplaceParametersWithObj;
+exports.stringSliceParametersWithSort = stringSliceParametersWithSort;

package/dist/node/string/proto.d.ts

@@ -0,0 +1,19 @@
+//#region src/string/proto.d.ts
+/**
+ * 方法 `String.prototype.replace` 的第二个参数的快捷实现，可根据对象的键值对进行替换
+ *
+ * @example args =  [ 'h', 0, 'hello' ]
+ * @example args =  [ '[h]', 'h', 0, '[h][e][l][l][o]' ]
+ */
+declare function stringReplaceParametersWithObj(obj: Record<string, string>): (...args: any[]) => string;
+/**
+ * 方法 `String.prototype.slice` 的参数，额外支持索引区间排序问题
+ *
+ * @reference https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String/slice
+ * @reference https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String/substring
+ * @reference https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String/substr
+ */
+declare function stringSliceParametersWithSort(start?: number, end?: number): [number, number?];
+//#endregion
+export { stringReplaceParametersWithObj, stringSliceParametersWithSort };
+//# sourceMappingURL=proto.d.ts.map

package/dist/node/string/proto.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"proto.d.ts","names":[],"sources":["../../../src/string/proto.ts"],"sourcesContent":[],"mappings":";;AASA;AAiBA;;;;iBAjBgB,8BAAA,MAAoC;;;;;;;;iBAiBpC,6BAAA"}

package/dist/node/string/proto.js

@@ -0,0 +1,36 @@
+import { isNotNumber, isUndefined as isUndefined$1 } from "../is/isPrimitive.js";
+import { at, head } from "es-toolkit";
+
+//#region src/string/proto.ts
+/**
+* 方法 `String.prototype.replace` 的第二个参数的快捷实现，可根据对象的键值对进行替换
+*
+* @example args =  [ 'h', 0, 'hello' ]
+* @example args =  [ '[h]', 'h', 0, '[h][e][l][l][o]' ]
+*/
+function stringReplaceParametersWithObj(obj) {
+	return (...args) => {
+		const substring = at(args, [-3])[0];
+		if (substring && Object.prototype.hasOwnProperty.call(obj, substring)) return obj[substring];
+		return head(args);
+	};
+}
+/**
+* 方法 `String.prototype.slice` 的参数，额外支持索引区间排序问题
+*
+* @reference https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String/slice
+* @reference https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String/substring
+* @reference https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String/substr
+*/
+function stringSliceParametersWithSort(start, end) {
+	const startArg = Number.isSafeInteger(start) ? start : 0;
+	const endArg = !isNotNumber(end) ? end : 0;
+	if (isUndefined$1(endArg)) return [startArg];
+	if (startArg >= 0 && endArg < 0) return [startArg, endArg];
+	if (startArg < 0 && endArg >= 0) return [endArg, startArg];
+	return [startArg, endArg].sort((a, b) => a - b);
+}
+
+//#endregion
+export { stringReplaceParametersWithObj, stringSliceParametersWithSort };
+//# sourceMappingURL=proto.js.map

package/dist/node/string/proto.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"proto.js","names":["isUndefined"],"sources":["../../../src/string/proto.ts"],"sourcesContent":["import { at, head } from 'es-toolkit'\nimport { isNotNumber, isUndefined } from '../is'\n\n/**\n * 方法 `String.prototype.replace` 的第二个参数的快捷实现，可根据对象的键值对进行替换\n *\n * @example args =  [ 'h', 0, 'hello' ]\n * @example args =  [ '[h]', 'h', 0, '[h][e][l][l][o]' ]\n */\nexport function stringReplaceParametersWithObj(obj: Record<string, string>) {\n  return (...args: any[]): string => {\n    const substring = at(args, [-3])[0]\n    if (substring && Object.prototype.hasOwnProperty.call(obj, substring)) {\n      return obj[substring]\n    }\n    return head(args)\n  }\n}\n\n/**\n * 方法 `String.prototype.slice` 的参数，额外支持索引区间排序问题\n *\n * @reference https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String/slice\n * @reference https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String/substring\n * @reference https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String/substr\n */\nexport function stringSliceParametersWithSort(start?: number, end?: number): [number, number?] {\n  const startArg = (Number.isSafeInteger(start) ? start : 0) as number // 不允许 undefined\n  const endArg = !isNotNumber(end) ? end : 0 // 允许 undefined\n\n  if (isUndefined(endArg)) {\n    return [startArg]\n  }\n  if (startArg >= 0 && endArg < 0) {\n    return [startArg, endArg]\n  }\n  if (startArg < 0 && endArg >= 0) {\n    return [endArg, startArg]\n  }\n  // 相同区间按数值大小升序排列\n  return ([startArg, endArg].sort((a, b) => a - b)) as [number, number]\n}\n"],"mappings":";;;;;;;;;;AASA,SAAgB,+BAA+B,KAA6B;AAC1E,SAAQ,GAAG,SAAwB;EACjC,MAAM,YAAY,GAAG,MAAM,CAAC,GAAG,CAAC,CAAC;AACjC,MAAI,aAAa,OAAO,UAAU,eAAe,KAAK,KAAK,UAAU,CACnE,QAAO,IAAI;AAEb,SAAO,KAAK,KAAK;;;;;;;;;;AAWrB,SAAgB,8BAA8B,OAAgB,KAAiC;CAC7F,MAAM,WAAY,OAAO,cAAc,MAAM,GAAG,QAAQ;CACxD,MAAM,SAAS,CAAC,YAAY,IAAI,GAAG,MAAM;AAEzC,KAAIA,cAAY,OAAO,CACrB,QAAO,CAAC,SAAS;AAEnB,KAAI,YAAY,KAAK,SAAS,EAC5B,QAAO,CAAC,UAAU,OAAO;AAE3B,KAAI,WAAW,KAAK,UAAU,EAC5B,QAAO,CAAC,QAAQ,SAAS;AAG3B,QAAQ,CAAC,UAAU,OAAO,CAAC,MAAM,GAAG,MAAM,IAAI,EAAE"}

package/dist/node/tree/index.cjs

@@ -0,0 +1,7 @@
+const require_treeFilter = require('./treeFilter.cjs');
+const require_treeFlatten = require('./treeFlatten.cjs');
+const require_treeGenerate = require('./treeGenerate.cjs');
+
+exports.treeFilter = require_treeFilter.treeFilter;
+exports.treeFlatten = require_treeFlatten.treeFlatten;
+exports.treeGenerate = require_treeGenerate.treeGenerate;

package/dist/node/tree/index.d.ts

@@ -0,0 +1,5 @@
+import { TreeFilterParams, TreeOptions } from "./interface.js";
+import { treeFilter } from "./treeFilter.js";
+import { treeFlatten } from "./treeFlatten.js";
+import { treeGenerate } from "./treeGenerate.js";
+export { TreeFilterParams, TreeOptions, treeFilter, treeFlatten, treeGenerate };

package/dist/node/tree/index.js

@@ -0,0 +1,5 @@
+import { treeFilter } from "./treeFilter.js";
+import { treeFlatten } from "./treeFlatten.js";
+import { treeGenerate } from "./treeGenerate.js";
+
+export { treeFilter, treeFlatten, treeGenerate };

package/dist/node/tree/interface.d.ts

@@ -0,0 +1,40 @@
+//#region src/tree/interface.d.ts
+/**
+ * 树形结构过滤函数的参数
+ */
+interface TreeFilterParams {
+  /** 树节点 */
+  node: any;
+  /** 树节点当前层级的索引 */
+  index: number;
+  /** 树节点层级 */
+  level: number;
+}
+/**
+ * 树形相关函数的配置参数，聚合在一个 interface 内便于复用
+ */
+interface TreeOptions {
+  /**
+   * @zh 当前节点关联父节点键名，默认值为 'pid'
+   */
+  parentIdKey?: string;
+  /**
+   * @zh 当前节点主键键名，默认值为 'id'
+   */
+  primaryIdKey?: string;
+  /**
+   * @zh 当前节点子树键名，默认值为 'children'
+   */
+  childrenKey?: string;
+  /**
+   * @zh 根节点关联值判断依据，默认值为 null
+   */
+  rootValue?: any;
+  /**
+   * @zh 树节点筛选函数，默认值为 null，表示不筛选
+   */
+  filter?: (node: TreeFilterParams['node'], index: TreeFilterParams['index'], level: TreeFilterParams['level']) => boolean;
+}
+//#endregion
+export { TreeFilterParams, TreeOptions };
+//# sourceMappingURL=interface.d.ts.map

package/dist/node/tree/interface.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"interface.d.ts","names":[],"sources":["../../../src/tree/interface.ts"],"sourcesContent":[],"mappings":";;AAGA;AAYA;AAoBkB,UAhCD,gBAAA,CAgCC;EAAiC;EAAkC,IAAA,EAAA,GAAA;EAAgB;;;;;;;;UApBpF,WAAA;;;;;;;;;;;;;;;;;;;;kBAoBC,iCAAiC,kCAAkC"}

package/dist/node/tree/treeFilter.cjs

@@ -0,0 +1,58 @@
+const require_isPrimitiveWithout = require('../is/isPrimitiveWithout.cjs');
+
+//#region src/tree/treeFilter.ts
+/**
+* 递归过滤节点 - 保留匹配节点及其所有父节点路径
+* @param {TreeFilterParams} params 递归过滤节点的参数
+* @param {Required<Pick<TreeOptions, 'childrenKey' | 'filter'>>} options 递归过滤节点的选项
+* @returns {[boolean, any]} [过滤结果, 过滤后的节点]
+*/
+function treeFilterNode(params, options) {
+	const { node, index, level } = params;
+	const { childrenKey, filter } = options;
+	const filteredChildren = [];
+	const children = node[childrenKey];
+	if (require_isPrimitiveWithout.isArray(children) && children.length > 0) for (let i = 0; i < children.length; i++) {
+		const [flag, filteredNode] = treeFilterNode({
+			node: children[i],
+			index: i,
+			level: level + 1
+		}, options);
+		flag && filteredChildren.push(filteredNode);
+	}
+	if (filteredChildren.length > 0) return [true, {
+		...node,
+		[childrenKey]: filteredChildren
+	}];
+	if (filter(node, index, level)) return [true, {
+		...node,
+		[childrenKey]: []
+	}];
+	return [false, null];
+}
+/**
+* 过滤树形结构 -保留匹配节点及其完整父节点路径
+* @param items 原始树形数据数组
+* @param options 配置选项
+* @returns {any[]} 过滤后的树形数据
+*/
+function treeFilter(items, options) {
+	const { childrenKey = "children", filter } = options || {};
+	if (!filter) return items;
+	const result = [];
+	for (let i = 0; i < items.length; i++) {
+		const [flag, filteredNode] = treeFilterNode({
+			node: items[i],
+			index: i,
+			level: 0
+		}, {
+			childrenKey,
+			filter
+		});
+		flag && result.push(filteredNode);
+	}
+	return result;
+}
+
+//#endregion
+exports.treeFilter = treeFilter;

package/dist/node/tree/treeFilter.d.ts

@@ -0,0 +1,14 @@
+import { TreeOptions } from "./interface.js";
+
+//#region src/tree/treeFilter.d.ts
+
+/**
+ * 过滤树形结构 -保留匹配节点及其完整父节点路径
+ * @param items 原始树形数据数组
+ * @param options 配置选项
+ * @returns {any[]} 过滤后的树形数据
+ */
+declare function treeFilter(items: any[], options?: Pick<TreeOptions, 'childrenKey' | 'filter'>): any[];
+//#endregion
+export { treeFilter };
+//# sourceMappingURL=treeFilter.d.ts.map

package/dist/node/tree/treeFilter.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"treeFilter.d.ts","names":[],"sources":["../../../src/tree/treeFilter.ts"],"sourcesContent":[],"mappings":";;;;;;AA6CA;;;;iBAAgB,UAAA,yBAAmC,KAAK"}

package/dist/node/tree/treeFilter.js

@@ -0,0 +1,59 @@
+import { isArray } from "../is/isPrimitiveWithout.js";
+
+//#region src/tree/treeFilter.ts
+/**
+* 递归过滤节点 - 保留匹配节点及其所有父节点路径
+* @param {TreeFilterParams} params 递归过滤节点的参数
+* @param {Required<Pick<TreeOptions, 'childrenKey' | 'filter'>>} options 递归过滤节点的选项
+* @returns {[boolean, any]} [过滤结果, 过滤后的节点]
+*/
+function treeFilterNode(params, options) {
+	const { node, index, level } = params;
+	const { childrenKey, filter } = options;
+	const filteredChildren = [];
+	const children = node[childrenKey];
+	if (isArray(children) && children.length > 0) for (let i = 0; i < children.length; i++) {
+		const [flag, filteredNode] = treeFilterNode({
+			node: children[i],
+			index: i,
+			level: level + 1
+		}, options);
+		flag && filteredChildren.push(filteredNode);
+	}
+	if (filteredChildren.length > 0) return [true, {
+		...node,
+		[childrenKey]: filteredChildren
+	}];
+	if (filter(node, index, level)) return [true, {
+		...node,
+		[childrenKey]: []
+	}];
+	return [false, null];
+}
+/**
+* 过滤树形结构 -保留匹配节点及其完整父节点路径
+* @param items 原始树形数据数组
+* @param options 配置选项
+* @returns {any[]} 过滤后的树形数据
+*/
+function treeFilter(items, options) {
+	const { childrenKey = "children", filter } = options || {};
+	if (!filter) return items;
+	const result = [];
+	for (let i = 0; i < items.length; i++) {
+		const [flag, filteredNode] = treeFilterNode({
+			node: items[i],
+			index: i,
+			level: 0
+		}, {
+			childrenKey,
+			filter
+		});
+		flag && result.push(filteredNode);
+	}
+	return result;
+}
+
+//#endregion
+export { treeFilter };
+//# sourceMappingURL=treeFilter.js.map

package/dist/node/tree/treeFilter.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"treeFilter.js","names":["filteredChildren: any[]","result: any[]"],"sources":["../../../src/tree/treeFilter.ts"],"sourcesContent":["import type { TreeFilterParams, TreeOptions } from './interface'\nimport { isArray } from '../is'\n\n/**\n * 递归过滤节点 - 保留匹配节点及其所有父节点路径\n * @param {TreeFilterParams} params 递归过滤节点的参数\n * @param {Required<Pick<TreeOptions, 'childrenKey' | 'filter'>>} options 递归过滤节点的选项\n * @returns {[boolean, any]} [过滤结果, 过滤后的节点]\n */\nfunction treeFilterNode(params: TreeFilterParams, options: Required<Pick<TreeOptions, 'childrenKey' | 'filter'>>): [boolean, any] {\n  const { node, index, level } = params\n  const { childrenKey, filter } = options\n\n  // 存储当前节点有匹配的子节点\n  const filteredChildren: any[] = []\n  // 得到子节点，并遍历子节点，递归处理子节点\n  const children = node[childrenKey]\n  if (isArray(children) && children.length > 0) {\n    for (let i = 0; i < children.length; i++) {\n      const [flag, filteredNode] = treeFilterNode({ node: children[i], index: i, level: level + 1 }, options)\n      // 如果子节点被保留（可能是匹配节点或包含匹配子节点的节点）\n      flag && filteredChildren.push(filteredNode)\n    }\n  }\n  // 如果有过滤后的子节点，更新子节点列表, 则直接返回\n  if (filteredChildren.length > 0) {\n    return [true, { ...node, [childrenKey]: filteredChildren }]\n  }\n\n  // 如果没有过滤后的子节点，则需检查当前节点是否匹配，则清空 children 属性并返回\n  const matched = filter(node, index, level)\n  if (matched) {\n    return [true, { ...node, [childrenKey]: [] }]\n  }\n\n  // 当前节点既不匹配也没有匹配的子节点，则不保留该节点\n  return [false, null]\n}\n\n/**\n * 过滤树形结构 -保留匹配节点及其完整父节点路径\n * @param items 原始树形数据数组\n * @param options 配置选项\n * @returns {any[]} 过滤后的树形数据\n */\nexport function treeFilter(items: any[], options?: Pick<TreeOptions, 'childrenKey' | 'filter'>): any[] {\n  const { childrenKey = 'children', filter } = options || {}\n\n  // 如果没有提供过滤函数，直接返回原始数据\n  if (!filter) return items\n\n  // 处理根节点数组\n  const result: any[] = []\n  for (let i = 0; i < items.length; i++) {\n    const [flag, filteredNode] = treeFilterNode({ node: items[i], index: i, level: 0 }, { childrenKey, filter })\n    flag && result.push(filteredNode)\n  }\n\n  return result\n}\n"],"mappings":";;;;;;;;;AASA,SAAS,eAAe,QAA0B,SAAgF;CAChI,MAAM,EAAE,MAAM,OAAO,UAAU;CAC/B,MAAM,EAAE,aAAa,WAAW;CAGhC,MAAMA,mBAA0B,EAAE;CAElC,MAAM,WAAW,KAAK;AACtB,KAAI,QAAQ,SAAS,IAAI,SAAS,SAAS,EACzC,MAAK,IAAI,IAAI,GAAG,IAAI,SAAS,QAAQ,KAAK;EACxC,MAAM,CAAC,MAAM,gBAAgB,eAAe;GAAE,MAAM,SAAS;GAAI,OAAO;GAAG,OAAO,QAAQ;GAAG,EAAE,QAAQ;AAEvG,UAAQ,iBAAiB,KAAK,aAAa;;AAI/C,KAAI,iBAAiB,SAAS,EAC5B,QAAO,CAAC,MAAM;EAAE,GAAG;GAAO,cAAc;EAAkB,CAAC;AAK7D,KADgB,OAAO,MAAM,OAAO,MAAM,CAExC,QAAO,CAAC,MAAM;EAAE,GAAG;GAAO,cAAc,EAAE;EAAE,CAAC;AAI/C,QAAO,CAAC,OAAO,KAAK;;;;;;;;AAStB,SAAgB,WAAW,OAAc,SAA8D;CACrG,MAAM,EAAE,cAAc,YAAY,WAAW,WAAW,EAAE;AAG1D,KAAI,CAAC,OAAQ,QAAO;CAGpB,MAAMC,SAAgB,EAAE;AACxB,MAAK,IAAI,IAAI,GAAG,IAAI,MAAM,QAAQ,KAAK;EACrC,MAAM,CAAC,MAAM,gBAAgB,eAAe;GAAE,MAAM,MAAM;GAAI,OAAO;GAAG,OAAO;GAAG,EAAE;GAAE;GAAa;GAAQ,CAAC;AAC5G,UAAQ,OAAO,KAAK,aAAa;;AAGnC,QAAO"}

package/dist/node/tree/treeFlatten.cjs

@@ -0,0 +1,23 @@
+const require_isPrimitiveWithout = require('../is/isPrimitiveWithout.cjs');
+
+//#region src/tree/treeFlatten.ts
+/**
+* @title 借助对象的引用将树形结构转化为平铺结构
+* @param {any[]} items 树形结构数组
+* @param {any} options 配置项
+* @param {any} options.childrenKey 配置项，默认值为 'children'
+* @returns 平铺结构数组
+*/
+function treeFlatten(items, options) {
+	const { childrenKey = "children" } = options || {};
+	const aFlatten = [];
+	for (const item of items) {
+		const { [childrenKey]: children, ...restItem } = item;
+		aFlatten.push(restItem);
+		if (require_isPrimitiveWithout.isArray(children) && children.length) aFlatten.push(...treeFlatten(children, options));
+	}
+	return aFlatten;
+}
+
+//#endregion
+exports.treeFlatten = treeFlatten;

package/dist/node/tree/treeFlatten.d.ts

@@ -0,0 +1,15 @@
+import { TreeOptions } from "./interface.js";
+
+//#region src/tree/treeFlatten.d.ts
+
+/**
+ * @title 借助对象的引用将树形结构转化为平铺结构
+ * @param {any[]} items 树形结构数组
+ * @param {any} options 配置项
+ * @param {any} options.childrenKey 配置项，默认值为 'children'
+ * @returns 平铺结构数组
+ */
+declare function treeFlatten(items: any[], options?: Pick<TreeOptions, 'childrenKey'>): any[];
+//#endregion
+export { treeFlatten };
+//# sourceMappingURL=treeFlatten.d.ts.map

package/dist/node/tree/treeFlatten.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"treeFlatten.d.ts","names":[],"sources":["../../../src/tree/treeFlatten.ts"],"sourcesContent":[],"mappings":";;;;;;AAUA;;;;;iBAAgB,WAAA,yBAAoC,KAAK"}

package/dist/node/tree/treeFlatten.js

@@ -0,0 +1,24 @@
+import { isArray } from "../is/isPrimitiveWithout.js";
+
+//#region src/tree/treeFlatten.ts
+/**
+* @title 借助对象的引用将树形结构转化为平铺结构
+* @param {any[]} items 树形结构数组
+* @param {any} options 配置项
+* @param {any} options.childrenKey 配置项，默认值为 'children'
+* @returns 平铺结构数组
+*/
+function treeFlatten(items, options) {
+	const { childrenKey = "children" } = options || {};
+	const aFlatten = [];
+	for (const item of items) {
+		const { [childrenKey]: children, ...restItem } = item;
+		aFlatten.push(restItem);
+		if (isArray(children) && children.length) aFlatten.push(...treeFlatten(children, options));
+	}
+	return aFlatten;
+}
+
+//#endregion
+export { treeFlatten };
+//# sourceMappingURL=treeFlatten.js.map

package/dist/node/tree/treeFlatten.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"treeFlatten.js","names":["aFlatten: any[]"],"sources":["../../../src/tree/treeFlatten.ts"],"sourcesContent":["import type { TreeOptions } from './interface'\nimport { isArray } from '../is'\n\n/**\n * @title 借助对象的引用将树形结构转化为平铺结构\n * @param {any[]} items 树形结构数组\n * @param {any} options 配置项\n * @param {any} options.childrenKey 配置项，默认值为 'children'\n * @returns 平铺结构数组\n */\nexport function treeFlatten(items: any[], options?: Pick<TreeOptions, 'childrenKey'>): any[] {\n  const { childrenKey = 'children' } = options || {}\n\n  // 平铺结构最终结果\n  const aFlatten: any[] = []\n\n  for (const item of items) {\n    const { [childrenKey]: children, ...restItem } = item\n    aFlatten.push(restItem)\n    // item 若包含 children 则递归调用\n    if (isArray(children) && children.length) {\n      aFlatten.push(...treeFlatten(children, options))\n    }\n  }\n\n  return aFlatten\n}\n"],"mappings":";;;;;;;;;;AAUA,SAAgB,YAAY,OAAc,SAAmD;CAC3F,MAAM,EAAE,cAAc,eAAe,WAAW,EAAE;CAGlD,MAAMA,WAAkB,EAAE;AAE1B,MAAK,MAAM,QAAQ,OAAO;EACxB,MAAM,GAAG,cAAc,UAAU,GAAG,aAAa;AACjD,WAAS,KAAK,SAAS;AAEvB,MAAI,QAAQ,SAAS,IAAI,SAAS,OAChC,UAAS,KAAK,GAAG,YAAY,UAAU,QAAQ,CAAC;;AAIpD,QAAO"}