@ruan-cat/utils 4.3.2 → 4.5.0

package/dist/index.d.ts

@@ -18,6 +18,15 @@ type Conditions = Condition[];
 declare function isConditionsEvery(conditions: Condition[]): boolean;
 declare function isConditionsSome(conditions: Condition[]): boolean;
 
+/**
+ * 一个简单的格式化函数
+ * @description
+ * 用于将复杂对象变成纯文本 打印出来
+ *
+ * 主要用于测试框架打印完整的内容
+ */
+declare function printFormat(params: any): any;
+
 /** 创建简单的异步任务 */
 declare function generateSimpleAsyncTask<T extends (...args: any) => any>(func: T): (...args: any) => Promise<ReturnType<T>>;
 type SimpleAsyncTask = ReturnType<typeof generateSimpleAsyncTask>;
@@ -107,4 +116,4 @@ type Prettify<T> = {
  */
 type ToNumberLike<T extends number> = T | `${T}`;
 
-export { type BaseTask, type Condition, type Conditions, type ParallelTasks, type PnpmWorkspace, type Prettify, type PromiseTasksConfig, type QueueTasks, type SimpleAsyncTask, type SingleTasks, type Task, type TaskType, type TasksConfig, type ToNumberLike, definePromiseTasks, executePromiseTasks, generateSimpleAsyncTask, initFlag, isConditionsEvery, isConditionsSome, runPromiseByConcurrency, runPromiseByQueue, taskTypes };
+export { type BaseTask, type Condition, type Conditions, type ParallelTasks, type PnpmWorkspace, type Prettify, type PromiseTasksConfig, type QueueTasks, type SimpleAsyncTask, type SingleTasks, type Task, type TaskType, type TasksConfig, type ToNumberLike, definePromiseTasks, executePromiseTasks, generateSimpleAsyncTask, initFlag, isConditionsEvery, isConditionsSome, printFormat, runPromiseByConcurrency, runPromiseByQueue, taskTypes };

package/dist/index.js

@@ -6,6 +6,19 @@ function isConditionsSome(conditions) {
   return conditions.some((condition) => condition());
 }
 
+// src/print.ts
+import { isPlainObject, isArray } from "lodash-es";
+function printFormat(params) {
+  const boolRes = isConditionsSome([
+    // 是不是纯对象？
+    () => isPlainObject(params),
+    // 或者是不是单纯的数组？
+    () => isArray(params)
+  ]);
+  const res = boolRes ? JSON.stringify(params, null, 2) : params;
+  return res;
+}
+
 // src/define-promise-tasks.ts
 var taskTypes = ["single", "parallel", "queue"];
 function isSingleTasks(config) {
@@ -80,6 +93,7 @@ export {
   initFlag,
   isConditionsEvery,
   isConditionsSome,
+  printFormat,
   runPromiseByConcurrency,
   runPromiseByQueue,
   taskTypes

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../src/conditions.ts","../src/define-promise-tasks.ts","../src/simple-promise-tools.ts"],"sourcesContent":["export type Condition = (...args: unknown[]) => boolean;\n\n/** @deprecated 没必要 */\nexport type Conditions = Condition[];\n\n/**\n * 是否每一个条件函数都满足？\n * @description\n * ### 设计理由\n * 旨在于封装这样的代码段\n * ```js\n * const conditions = [\n * \t() => !isEqual(nAssetRecord, oAssetRecord),\n * \t() => !isEqual(nAssetRecord, defPropsAssets),\n * \t() => isEdit.value || isInfo.value,\n * ];\n * conditions.every((condition) => condition())\n * ```\n */\nexport function isConditionsEvery(conditions: Condition[]) {\n\treturn conditions.every((condition) => condition());\n}\n\nexport function isConditionsSome(conditions: Condition[]) {\n\treturn conditions.some((condition) => condition());\n}\n","import { type SimpleAsyncTask } from \"./simple-promise-tools\";\n\nexport const taskTypes = <const>[\"single\", \"parallel\", \"queue\"];\n\nexport type TaskType = (typeof taskTypes)[number];\n\nexport interface BaseTask {\n\t/** 任务类型 */\n\ttype: TaskType;\n}\n\nexport type Task = SimpleAsyncTask | TasksConfig;\n\nexport interface SingleTasks extends BaseTask {\n\ttype: \"single\";\n\ttasks: Task;\n}\n\nexport interface ParallelTasks extends BaseTask {\n\ttype: \"parallel\";\n\ttasks: Task[];\n}\n\nexport interface QueueTasks extends BaseTask {\n\ttype: \"queue\";\n\ttasks: Task[];\n}\n\nexport type TasksConfig = SingleTasks | ParallelTasks | QueueTasks;\n\nexport type PromiseTasksConfig = TasksConfig;\n\nfunction isSingleTasks(config: TasksConfig): config is SingleTasks {\n\treturn config.type === \"single\";\n}\n\nfunction isParallelTasks(config: TasksConfig): config is ParallelTasks {\n\treturn config.type === \"parallel\";\n}\n\nfunction isQueueTasks(config: TasksConfig): config is QueueTasks {\n\treturn config.type === \"queue\";\n}\n\nfunction isSimpleAsyncTask(config: Task): config is SimpleAsyncTask {\n\treturn typeof config === \"function\";\n}\n\nfunction isTasksConfig(config: Task): config is TasksConfig {\n\treturn typeof config === \"object\";\n}\n\n/**\n * 定义异步任务对象\n * @description\n * 这个对象是一揽子异步任务的配置\n */\nexport function definePromiseTasks(config: TasksConfig) {\n\treturn config;\n}\n\n/**\n * @private 一个工具函数 用于生成异步函数数组\n * @deprecated 在处理串行任务时 疑似有故障\n */\nfunction getPromises(tasks: Task[]): ((...args: any) => Promise<any>)[] {\n\treturn tasks.map((task) => {\n\t\treturn async function (...args: any) {\n\t\t\tif (isSimpleAsyncTask(task)) {\n\t\t\t\treturn await task(...args);\n\t\t\t} else {\n\t\t\t\treturn await executePromiseTasks(task);\n\t\t\t}\n\t\t};\n\t});\n}\n\n/**\n * 执行异步函数对象\n */\nexport async function executePromiseTasks(\n\tconfig: TasksConfig,\n\t/**\n\t * 上一次递归执行时提供的参数\n\t * @description\n\t * 考虑到递归函数 这里提供了一个参数 用于传递上一次递归执行的结果\n\t */\n\tlastParams: any = null,\n): Promise<any> {\n\tif (isSingleTasks(config)) {\n\t\tif (isSimpleAsyncTask(config.tasks)) {\n\t\t\t// 实际执行的 tasks 往往是无参函数 这里为了保险，故主动传递参数\n\t\t\treturn await config.tasks(lastParams);\n\t\t}\n\n\t\treturn await executePromiseTasks(config.tasks, lastParams);\n\t}\n\n\tif (isParallelTasks(config)) {\n\t\treturn await Promise.all(\n\t\t\tconfig.tasks.map((task) => {\n\t\t\t\tif (isSimpleAsyncTask(task)) {\n\t\t\t\t\t// console.log(` 并行任务遇到单独的异步函数 `);\n\t\t\t\t\treturn task(lastParams);\n\t\t\t\t}\n\n\t\t\t\t// console.log(` 并行任务遇到嵌套结构 `);\n\t\t\t\treturn executePromiseTasks(task, lastParams);\n\t\t\t}),\n\t\t);\n\t}\n\n\tif (isQueueTasks(config)) {\n\t\tlet res: Awaited<any>;\n\t\tfor await (const task of config.tasks) {\n\t\t\tif (isSimpleAsyncTask(task)) {\n\t\t\t\t// console.log(` 串行任务遇到单独的异步函数 `);\n\n\t\t\t\tres = await task(lastParams);\n\t\t\t\tlastParams = res;\n\t\t\t\t// console.log(` 串行任务 单独 res `, res);\n\t\t\t} else {\n\t\t\t\tres = await executePromiseTasks(task, lastParams);\n\t\t\t\tlastParams = res;\n\t\t\t\t// console.log(` 串行任务 配置 res `, res);\n\t\t\t}\n\t\t}\n\n\t\treturn res;\n\t}\n}\n","// import { uniqueId } from \"lodash-es\";\n// const getCounter = () => uniqueId();\n\n/** 创建简单的异步任务 */\nexport function generateSimpleAsyncTask<T extends (...args: any) => any>(func: T) {\n\t// const taskId = getCounter();\n\n\treturn function (...args: any) {\n\t\t// consola.info(` 这是第 ${taskId} 个异步任务 `);\n\t\t// consola.start(\" 这里是新创建的异步函数 检查参数： \", ...args);\n\n\t\treturn new Promise<ReturnType<T>>((resolve, reject) => {\n\t\t\t// consola.start(\" 内部promise 检查参数： \", ...args);\n\t\t\tresolve(func(...args));\n\t\t});\n\t};\n}\n\nexport type SimpleAsyncTask = ReturnType<typeof generateSimpleAsyncTask>;\n\nexport const initFlag = <const>\"initFlag\";\n\n/**\n * 以队列串行的形式 串行运行异步函数\n * @see https://github.com/ascoders/weekly/blob/master/前沿技术/77.精读《用%20Reduce%20实现%20Promise%20串行执行》.md\n * @version 1\n */\nasync function runPromiseByQueueV1<T>(promises: ((...args: any) => Promise<T>)[]) {\n\tpromises.reduce(\n\t\tasync function (previousPromise, nextPromise, currentIndex) {\n\t\t\tconst response = await previousPromise;\n\t\t\t// consola.log(` reduce串行函数 currentIndex= ${currentIndex} res =`, response);\n\t\t\treturn await nextPromise(response);\n\t\t},\n\t\tPromise.resolve(initFlag) as Promise<any>,\n\t);\n}\n\n/**\n * 以队列串行的形式 串行运行异步函数\n * @version 2\n */\nexport async function runPromiseByQueue<T>(promises: ((...args: any) => Promise<T>)[]) {\n\tlet response: typeof initFlag | Awaited<T> = initFlag;\n\tfor await (const promise of promises) {\n\t\tresponse = await promise(response);\n\t}\n}\n\n/**\n * 以并行的形式 并发运行异步函数\n */\nexport async function runPromiseByConcurrency<T>(promises: ((...args: any) => Promise<T>)[]) {\n\tawait Promise.all(promises.map((promise) => promise()));\n}\n"],"mappings":";AAmBO,SAAS,kBAAkB,YAAyB;AAC1D,SAAO,WAAW,MAAM,CAAC,cAAc,UAAU,CAAC;AACnD;AAEO,SAAS,iBAAiB,YAAyB;AACzD,SAAO,WAAW,KAAK,CAAC,cAAc,UAAU,CAAC;AAClD;;;ACvBO,IAAM,YAAmB,CAAC,UAAU,YAAY,OAAO;AA8B9D,SAAS,cAAc,QAA4C;AAClE,SAAO,OAAO,SAAS;AACxB;AAEA,SAAS,gBAAgB,QAA8C;AACtE,SAAO,OAAO,SAAS;AACxB;AAEA,SAAS,aAAa,QAA2C;AAChE,SAAO,OAAO,SAAS;AACxB;AAEA,SAAS,kBAAkB,QAAyC;AACnE,SAAO,OAAO,WAAW;AAC1B;AAWO,SAAS,mBAAmB,QAAqB;AACvD,SAAO;AACR;AAqBA,eAAsB,oBACrB,QAMA,aAAkB,MACH;AACf,MAAI,cAAc,MAAM,GAAG;AAC1B,QAAI,kBAAkB,OAAO,KAAK,GAAG;AAEpC,aAAO,MAAM,OAAO,MAAM,UAAU;AAAA,IACrC;AAEA,WAAO,MAAM,oBAAoB,OAAO,OAAO,UAAU;AAAA,EAC1D;AAEA,MAAI,gBAAgB,MAAM,GAAG;AAC5B,WAAO,MAAM,QAAQ;AAAA,MACpB,OAAO,MAAM,IAAI,CAAC,SAAS;AAC1B,YAAI,kBAAkB,IAAI,GAAG;AAE5B,iBAAO,KAAK,UAAU;AAAA,QACvB;AAGA,eAAO,oBAAoB,MAAM,UAAU;AAAA,MAC5C,CAAC;AAAA,IACF;AAAA,EACD;AAEA,MAAI,aAAa,MAAM,GAAG;AACzB,QAAI;AACJ,qBAAiB,QAAQ,OAAO,OAAO;AACtC,UAAI,kBAAkB,IAAI,GAAG;AAG5B,cAAM,MAAM,KAAK,UAAU;AAC3B,qBAAa;AAAA,MAEd,OAAO;AACN,cAAM,MAAM,oBAAoB,MAAM,UAAU;AAChD,qBAAa;AAAA,MAEd;AAAA,IACD;AAEA,WAAO;AAAA,EACR;AACD;;;AC9HO,SAAS,wBAAyD,MAAS;AAGjF,SAAO,YAAa,MAAW;AAI9B,WAAO,IAAI,QAAuB,CAAC,SAAS,WAAW;AAEtD,cAAQ,KAAK,GAAG,IAAI,CAAC;AAAA,IACtB,CAAC;AAAA,EACF;AACD;AAIO,IAAM,WAAkB;AAsB/B,eAAsB,kBAAqB,UAA4C;AACtF,MAAI,WAAyC;AAC7C,mBAAiB,WAAW,UAAU;AACrC,eAAW,MAAM,QAAQ,QAAQ;AAAA,EAClC;AACD;AAKA,eAAsB,wBAA2B,UAA4C;AAC5F,QAAM,QAAQ,IAAI,SAAS,IAAI,CAAC,YAAY,QAAQ,CAAC,CAAC;AACvD;","names":[]}
+{"version":3,"sources":["../src/conditions.ts","../src/print.ts","../src/define-promise-tasks.ts","../src/simple-promise-tools.ts"],"sourcesContent":["export type Condition = (...args: unknown[]) => boolean;\n\n/** @deprecated 没必要 */\nexport type Conditions = Condition[];\n\n/**\n * 是否每一个条件函数都满足？\n * @description\n * ### 设计理由\n * 旨在于封装这样的代码段\n * ```js\n * const conditions = [\n * \t() => !isEqual(nAssetRecord, oAssetRecord),\n * \t() => !isEqual(nAssetRecord, defPropsAssets),\n * \t() => isEdit.value || isInfo.value,\n * ];\n * conditions.every((condition) => condition())\n * ```\n */\nexport function isConditionsEvery(conditions: Condition[]) {\n\treturn conditions.every((condition) => condition());\n}\n\nexport function isConditionsSome(conditions: Condition[]) {\n\treturn conditions.some((condition) => condition());\n}\n","import { isPlainObject, isArray } from \"lodash-es\";\nimport { isConditionsSome } from \"./conditions\";\n\n/**\n * 一个简单的格式化函数\n * @description\n * 用于将复杂对象变成纯文本 打印出来\n *\n * 主要用于测试框架打印完整的内容\n */\nexport function printFormat(params: any) {\n\tconst boolRes = isConditionsSome([\n\t\t// 是不是纯对象？\n\t\t() => isPlainObject(params),\n\t\t// 或者是不是单纯的数组？\n\t\t() => isArray(params),\n\t]);\n\n\t// 如果是纯对象或者数组，则使用 JSON.stringify 格式化输出 否则原样返回\n\tconst res = boolRes ? JSON.stringify(params, null, 2) : params;\n\n\treturn res;\n}\n","import { type SimpleAsyncTask } from \"./simple-promise-tools\";\n\nexport const taskTypes = <const>[\"single\", \"parallel\", \"queue\"];\n\nexport type TaskType = (typeof taskTypes)[number];\n\nexport interface BaseTask {\n\t/** 任务类型 */\n\ttype: TaskType;\n}\n\nexport type Task = SimpleAsyncTask | TasksConfig;\n\nexport interface SingleTasks extends BaseTask {\n\ttype: \"single\";\n\ttasks: Task;\n}\n\nexport interface ParallelTasks extends BaseTask {\n\ttype: \"parallel\";\n\ttasks: Task[];\n}\n\nexport interface QueueTasks extends BaseTask {\n\ttype: \"queue\";\n\ttasks: Task[];\n}\n\nexport type TasksConfig = SingleTasks | ParallelTasks | QueueTasks;\n\nexport type PromiseTasksConfig = TasksConfig;\n\nfunction isSingleTasks(config: TasksConfig): config is SingleTasks {\n\treturn config.type === \"single\";\n}\n\nfunction isParallelTasks(config: TasksConfig): config is ParallelTasks {\n\treturn config.type === \"parallel\";\n}\n\nfunction isQueueTasks(config: TasksConfig): config is QueueTasks {\n\treturn config.type === \"queue\";\n}\n\nfunction isSimpleAsyncTask(config: Task): config is SimpleAsyncTask {\n\treturn typeof config === \"function\";\n}\n\nfunction isTasksConfig(config: Task): config is TasksConfig {\n\treturn typeof config === \"object\";\n}\n\n/**\n * 定义异步任务对象\n * @description\n * 这个对象是一揽子异步任务的配置\n */\nexport function definePromiseTasks(config: TasksConfig) {\n\treturn config;\n}\n\n/**\n * @private 一个工具函数 用于生成异步函数数组\n * @deprecated 在处理串行任务时 疑似有故障\n */\nfunction getPromises(tasks: Task[]): ((...args: any) => Promise<any>)[] {\n\treturn tasks.map((task) => {\n\t\treturn async function (...args: any) {\n\t\t\tif (isSimpleAsyncTask(task)) {\n\t\t\t\treturn await task(...args);\n\t\t\t} else {\n\t\t\t\treturn await executePromiseTasks(task);\n\t\t\t}\n\t\t};\n\t});\n}\n\n/**\n * 执行异步函数对象\n */\nexport async function executePromiseTasks(\n\tconfig: TasksConfig,\n\t/**\n\t * 上一次递归执行时提供的参数\n\t * @description\n\t * 考虑到递归函数 这里提供了一个参数 用于传递上一次递归执行的结果\n\t */\n\tlastParams: any = null,\n): Promise<any> {\n\tif (isSingleTasks(config)) {\n\t\tif (isSimpleAsyncTask(config.tasks)) {\n\t\t\t// 实际执行的 tasks 往往是无参函数 这里为了保险，故主动传递参数\n\t\t\treturn await config.tasks(lastParams);\n\t\t}\n\n\t\treturn await executePromiseTasks(config.tasks, lastParams);\n\t}\n\n\tif (isParallelTasks(config)) {\n\t\treturn await Promise.all(\n\t\t\tconfig.tasks.map((task) => {\n\t\t\t\tif (isSimpleAsyncTask(task)) {\n\t\t\t\t\t// console.log(` 并行任务遇到单独的异步函数 `);\n\t\t\t\t\treturn task(lastParams);\n\t\t\t\t}\n\n\t\t\t\t// console.log(` 并行任务遇到嵌套结构 `);\n\t\t\t\treturn executePromiseTasks(task, lastParams);\n\t\t\t}),\n\t\t);\n\t}\n\n\tif (isQueueTasks(config)) {\n\t\tlet res: Awaited<any>;\n\t\tfor await (const task of config.tasks) {\n\t\t\tif (isSimpleAsyncTask(task)) {\n\t\t\t\t// console.log(` 串行任务遇到单独的异步函数 `);\n\n\t\t\t\tres = await task(lastParams);\n\t\t\t\tlastParams = res;\n\t\t\t\t// console.log(` 串行任务 单独 res `, res);\n\t\t\t} else {\n\t\t\t\tres = await executePromiseTasks(task, lastParams);\n\t\t\t\tlastParams = res;\n\t\t\t\t// console.log(` 串行任务 配置 res `, res);\n\t\t\t}\n\t\t}\n\n\t\treturn res;\n\t}\n}\n","// import { uniqueId } from \"lodash-es\";\n// const getCounter = () => uniqueId();\n\n/** 创建简单的异步任务 */\nexport function generateSimpleAsyncTask<T extends (...args: any) => any>(func: T) {\n\t// const taskId = getCounter();\n\n\treturn function (...args: any) {\n\t\t// consola.info(` 这是第 ${taskId} 个异步任务 `);\n\t\t// consola.start(\" 这里是新创建的异步函数 检查参数： \", ...args);\n\n\t\treturn new Promise<ReturnType<T>>((resolve, reject) => {\n\t\t\t// consola.start(\" 内部promise 检查参数： \", ...args);\n\t\t\tresolve(func(...args));\n\t\t});\n\t};\n}\n\nexport type SimpleAsyncTask = ReturnType<typeof generateSimpleAsyncTask>;\n\nexport const initFlag = <const>\"initFlag\";\n\n/**\n * 以队列串行的形式 串行运行异步函数\n * @see https://github.com/ascoders/weekly/blob/master/前沿技术/77.精读《用%20Reduce%20实现%20Promise%20串行执行》.md\n * @version 1\n */\nasync function runPromiseByQueueV1<T>(promises: ((...args: any) => Promise<T>)[]) {\n\tpromises.reduce(\n\t\tasync function (previousPromise, nextPromise, currentIndex) {\n\t\t\tconst response = await previousPromise;\n\t\t\t// consola.log(` reduce串行函数 currentIndex= ${currentIndex} res =`, response);\n\t\t\treturn await nextPromise(response);\n\t\t},\n\t\tPromise.resolve(initFlag) as Promise<any>,\n\t);\n}\n\n/**\n * 以队列串行的形式 串行运行异步函数\n * @version 2\n */\nexport async function runPromiseByQueue<T>(promises: ((...args: any) => Promise<T>)[]) {\n\tlet response: typeof initFlag | Awaited<T> = initFlag;\n\tfor await (const promise of promises) {\n\t\tresponse = await promise(response);\n\t}\n}\n\n/**\n * 以并行的形式 并发运行异步函数\n */\nexport async function runPromiseByConcurrency<T>(promises: ((...args: any) => Promise<T>)[]) {\n\tawait Promise.all(promises.map((promise) => promise()));\n}\n"],"mappings":";AAmBO,SAAS,kBAAkB,YAAyB;AAC1D,SAAO,WAAW,MAAM,CAAC,cAAc,UAAU,CAAC;AACnD;AAEO,SAAS,iBAAiB,YAAyB;AACzD,SAAO,WAAW,KAAK,CAAC,cAAc,UAAU,CAAC;AAClD;;;ACzBA,SAAS,eAAe,eAAe;AAUhC,SAAS,YAAY,QAAa;AACxC,QAAM,UAAU,iBAAiB;AAAA;AAAA,IAEhC,MAAM,cAAc,MAAM;AAAA;AAAA,IAE1B,MAAM,QAAQ,MAAM;AAAA,EACrB,CAAC;AAGD,QAAM,MAAM,UAAU,KAAK,UAAU,QAAQ,MAAM,CAAC,IAAI;AAExD,SAAO;AACR;;;ACpBO,IAAM,YAAmB,CAAC,UAAU,YAAY,OAAO;AA8B9D,SAAS,cAAc,QAA4C;AAClE,SAAO,OAAO,SAAS;AACxB;AAEA,SAAS,gBAAgB,QAA8C;AACtE,SAAO,OAAO,SAAS;AACxB;AAEA,SAAS,aAAa,QAA2C;AAChE,SAAO,OAAO,SAAS;AACxB;AAEA,SAAS,kBAAkB,QAAyC;AACnE,SAAO,OAAO,WAAW;AAC1B;AAWO,SAAS,mBAAmB,QAAqB;AACvD,SAAO;AACR;AAqBA,eAAsB,oBACrB,QAMA,aAAkB,MACH;AACf,MAAI,cAAc,MAAM,GAAG;AAC1B,QAAI,kBAAkB,OAAO,KAAK,GAAG;AAEpC,aAAO,MAAM,OAAO,MAAM,UAAU;AAAA,IACrC;AAEA,WAAO,MAAM,oBAAoB,OAAO,OAAO,UAAU;AAAA,EAC1D;AAEA,MAAI,gBAAgB,MAAM,GAAG;AAC5B,WAAO,MAAM,QAAQ;AAAA,MACpB,OAAO,MAAM,IAAI,CAAC,SAAS;AAC1B,YAAI,kBAAkB,IAAI,GAAG;AAE5B,iBAAO,KAAK,UAAU;AAAA,QACvB;AAGA,eAAO,oBAAoB,MAAM,UAAU;AAAA,MAC5C,CAAC;AAAA,IACF;AAAA,EACD;AAEA,MAAI,aAAa,MAAM,GAAG;AACzB,QAAI;AACJ,qBAAiB,QAAQ,OAAO,OAAO;AACtC,UAAI,kBAAkB,IAAI,GAAG;AAG5B,cAAM,MAAM,KAAK,UAAU;AAC3B,qBAAa;AAAA,MAEd,OAAO;AACN,cAAM,MAAM,oBAAoB,MAAM,UAAU;AAChD,qBAAa;AAAA,MAEd;AAAA,IACD;AAEA,WAAO;AAAA,EACR;AACD;;;AC9HO,SAAS,wBAAyD,MAAS;AAGjF,SAAO,YAAa,MAAW;AAI9B,WAAO,IAAI,QAAuB,CAAC,SAAS,WAAW;AAEtD,cAAQ,KAAK,GAAG,IAAI,CAAC;AAAA,IACtB,CAAC;AAAA,EACF;AACD;AAIO,IAAM,WAAkB;AAsB/B,eAAsB,kBAAqB,UAA4C;AACtF,MAAI,WAAyC;AAC7C,mBAAiB,WAAW,UAAU;AACrC,eAAW,MAAM,QAAQ,QAAQ;AAAA,EAClC;AACD;AAKA,eAAsB,wBAA2B,UAA4C;AAC5F,QAAM,QAAQ,IAAI,SAAS,IAAI,CAAC,YAAY,QAAQ,CAAC,CAAC;AACvD;","names":[]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ruan-cat/utils",
-  "version": "4.3.2",
+  "version": "4.5.0",
   "description": "阮喵喵工具集合。默认提供js文件，也直接提供ts文件。",
   "type": "module",
   "main": "./src/index.ts",
@@ -32,6 +32,7 @@
     "./unplugin-vue-router": "./src/unplugin-vue-router/index.ts",
     "./vite-plugin-autogeneration-import-file": "./src/vite-plugin-autogeneration-import-file/index.ts",
     "./vueuse": "./src/vueuse/index.ts",
+    "./vueuse/*": "./src/vueuse/*",
     "./src/*": "./src/*",
     "./dist/*": "./dist/*"
   },
@@ -78,6 +79,7 @@
     "typedoc-plugin-frontmatter": "^1.3.0",
     "typedoc-plugin-markdown": "^4.5.0",
     "typescript": "^5.8.2",
+    "unplugin-auto-import": "^19.1.1",
     "unplugin-vue-router": "^0.12.0",
     "vite-plugin-autogeneration-import-file": "^3.0.0",
     "vitepress": "^1.6.3"

package/src/index.ts

@@ -1,4 +1,5 @@
 export * from "./conditions";
+export * from "./print";
 export * from "./define-promise-tasks";
 export * from "./simple-promise-tools";
 

package/src/print.ts

@@ -0,0 +1,23 @@
+import { isPlainObject, isArray } from "lodash-es";
+import { isConditionsSome } from "./conditions";
+
+/**
+ * 一个简单的格式化函数
+ * @description
+ * 用于将复杂对象变成纯文本 打印出来
+ *
+ * 主要用于测试框架打印完整的内容
+ */
+export function printFormat(params: any) {
+	const boolRes = isConditionsSome([
+		// 是不是纯对象？
+		() => isPlainObject(params),
+		// 或者是不是单纯的数组？
+		() => isArray(params),
+	]);
+
+	// 如果是纯对象或者数组，则使用 JSON.stringify 格式化输出 否则原样返回
+	const res = boolRes ? JSON.stringify(params, null, 2) : params;
+
+	return res;
+}

package/src/vueuse/index.ts

@@ -1 +1,2 @@
 export * from "./useAxios/index";
+export * from "./useAxios-for-01s/index";

package/src/vueuse/useAxios-for-01s/index.ts

@@ -0,0 +1,4 @@
+export * from "./types/JsonVO";
+export * from "./types/PageDTO";
+export * from "./tools";
+export * from "./main";

package/src/vueuse/useAxios-for-01s/main.ts

@@ -0,0 +1,94 @@
+import type { KeyAxiosRequestConfig, UseAxiosWrapperParams } from "../useAxios/index";
+import { useAxiosWrapper } from "../useAxios/index";
+
+import type { UseAxiosOptionsBase } from "@vueuse/integrations/useAxios";
+import type { PartialPick } from "type-plus";
+import type { AxiosInstance } from "axios";
+import axios from "axios";
+import type { JsonVO } from "./types/JsonVO";
+
+import type { AxiosRequestConfigBaseKey, HttpParamWay } from "./tools.ts";
+import {
+	createDefaultUseAxiosOptions,
+	setHeaders,
+	UpType,
+	setDefaultUseAxiosOptions,
+	setDataByHttpParamWay,
+} from "./tools";
+
+/**
+ * 内部用的 axios 实例
+ * @description
+ * 主动声明类型 用于约束
+ * @private
+ */
+let innerAxiosInstance: AxiosInstance = axios;
+
+/**
+ * 定义具体的 AxiosInstance 实例
+ * @description
+ * 让外部设置一次内部的默认请求实例
+ */
+export function defineAxiosInstance(axiosInstance: AxiosInstance) {
+	innerAxiosInstance = axiosInstance;
+}
+
+export type ParamsPathKey = AxiosRequestConfigBaseKey | "url";
+export type ParamsQueryKey = AxiosRequestConfigBaseKey | "data";
+export type ParamsBodyKey = AxiosRequestConfigBaseKey | "data";
+
+type UseAxiosWrapperUseKey<T extends HttpParamWay, K extends KeyAxiosRequestConfig> =
+	//
+	T extends HttpParamWay ? Exclude<K, AxiosRequestConfigBaseKey> : never;
+
+interface _Params<K extends KeyAxiosRequestConfig, T = any, D = any>
+	extends UseAxiosWrapperParams<K, T, UseAxiosOptionsBase<JsonVO<T>>, D> {
+	httpParamWay: HttpParamWay;
+	upType?: UpType;
+}
+
+/** 建议封装接口请求函数不传递 useAxios 的 instance 和 options 参数 */
+type Params<K extends KeyAxiosRequestConfig, T = any, D = any> = PartialPick<_Params<K, T, D>, "instance" | "options">;
+
+/**
+ * 项目内用的接口请求
+ * @description
+ * 01s项目内常用的接口请求
+ * @version 2
+ */
+export function useRequestIn01s<
+	K extends KeyAxiosRequestConfig,
+	T = any,
+	D = any,
+	HttpParamWayTemp extends HttpParamWay = Params<K>["httpParamWay"],
+>(
+	params: Params<
+		//
+		UseAxiosWrapperUseKey<HttpParamWayTemp, K>,
+		T,
+		D
+	>,
+) {
+	const {
+		config,
+		options = createDefaultUseAxiosOptions(),
+		instance = innerAxiosInstance,
+		httpParamWay,
+		upType,
+		url,
+	} = params;
+	setHeaders(config, upType);
+	setDefaultUseAxiosOptions(options);
+	setDataByHttpParamWay({
+		httpParamWay,
+		config,
+	});
+	// console.log(" instance  ?", instance.defaults.baseURL);
+	return useAxiosWrapper<
+		//
+		UseAxiosWrapperUseKey<HttpParamWayTemp, K>,
+		JsonVO<T>,
+		UseAxiosOptionsBase<JsonVO<T>>,
+		D
+	>({ config, instance, options, url });
+}

package/src/vueuse/useAxios-for-01s/tools.ts

@@ -0,0 +1,185 @@
+import type { UseAxiosOptionsBase } from "@vueuse/integrations/useAxios";
+import type { AxiosRequestConfig } from "axios";
+
+import { isNil, merge } from "lodash-es";
+import qs from "qs";
+
+import type { JsonVO } from "./types/JsonVO";
+import { isConditionsSome } from "../../index";
+
+/**
+ * http的接口传参方式
+ * @description
+ * 用于控制接口请求时的参数传递方式
+ * @see https://www.cnblogs.com/jinyuanya/p/13934722.html
+ */
+export type HttpParamWay =
+	// 路径传参
+	| "path"
+	// query传参
+	| "query"
+	// body传参
+	| "body";
+
+/**
+ * 基础的 axios.config 必填项字段
+ * @description
+ * 用于说明axios配置必须传递method字段
+ * @version 2
+ */
+export type AxiosRequestConfigBaseKey = "method";
+
+/**
+ * 数据上传数据类型
+ * @description
+ * 一个标记工具，用来控制上传数据的格式
+ *
+ * 目前没有发现axios有类似的上传类型声明
+ */
+export enum UpType {
+	/** 表单类型 */
+	form = 0,
+
+	/** json类型 */
+	json = 1,
+
+	/** 文件类型 */
+	file = 3,
+
+	/** 文件流类型 */
+	stream = 4,
+}
+
+/**
+ * HTTP状态码
+ * @description
+ * 待优化 未来可以直接复用axios内提供的值 不需要额外地封装工具
+ */
+export enum HttpCode {
+	/** 暂未登录或TOKEN已经过期 */
+	UNAUTHORIZED = 401,
+	/** 没有相关权限 */
+	FORBIDDEN = 403,
+	/** 访问页面未找到 */
+	NOT_FOUND = 404,
+	/** 服务器错误 */
+	SERVER_ERROR = 9994,
+	/** 上传参数异常 */
+	PARAMS_INVALID = 9995,
+	/** ContentType错误 */
+	CONTENT_TYPE_ERR = 9996,
+	/** 功能尚未实现 */
+	API_UN_IMPL = 9997,
+	/** 服务器繁忙 */
+	SERVER_BUSY = 9998,
+	/** 操作失败 */
+	FAIL = 9999,
+	/** 操作成功 */
+	SUCCESS = 10000,
+}
+
+/**
+ * 上传类型-请求体类型 枚举
+ * @description
+ * 待优化 未来可以直接复用axios内提供的值 不需要额外地封装工具
+ */
+export enum MapContentTypeUpType {
+	"application/json;charset=UTF-8" = UpType.json,
+	"multipart/form-data" = UpType.file,
+	"application/octet-stream" = UpType.stream,
+	"application/x-www-form-urlencoded;charset=UTF-8" = UpType.form,
+}
+
+/** @private */
+type ContentType = keyof typeof MapContentTypeUpType;
+
+/**
+ * 根据数据上传类型 重设请求头类型
+ * @description
+ * 不同的数据上传数据类型 要使用不同的接口请求方式
+ *
+ * 不再有返回值
+ * @version 2
+ */
+export function setHeaders(config: AxiosRequestConfig, upType: UpType = UpType.json) {
+	const contentType = MapContentTypeUpType[upType] as ContentType;
+	if (contentType) {
+		config = merge<AxiosRequestConfig, AxiosRequestConfig>(config, {
+			headers: {
+				"Content-Type": contentType,
+			},
+		});
+	}
+	if (!isNil(config.data) && upType === UpType.form) {
+		config.data = qs.stringify(config.data, { arrayFormat: "repeat" });
+	}
+	if (!isNil(config.data) && upType === UpType.file) {
+		const formData = new FormData();
+		for (const key in config.data) {
+			formData.append(key, config.data[key]);
+		}
+		config.data = formData;
+	}
+}
+
+/**
+ * 提供默认返回值的包装类型
+ * @description
+ * 预期会在每一个接口的包装函数内使用 用来定义 useAxios 的options参数
+ *
+ * 该类型应该成为高频使用的工具类型
+ *
+ * 被设计成一个简单的类型 而不是interface接口
+ * @version 2
+ */
+export type UseAxiosOptionsJsonVO<T = any> = UseAxiosOptionsBase<JsonVO<T>>;
+
+/** useAxios的选项配置 且默认带有immediate属性 不立刻执行 */
+export interface UseAxiosOptionsImmediate<T = any> extends UseAxiosOptionsJsonVO<T> {
+	/**
+	 * @default false
+	 * @description
+	 * 默认为 false 不立刻执行
+	 */
+	immediate: boolean;
+}
+
+/** 生成默认的选项配置 */
+export function createDefaultUseAxiosOptions<T = any>(): UseAxiosOptionsImmediate<T> {
+	return {
+		immediate: false,
+	};
+}
+
+/**
+ * 设置默认的 useAxiosOptions 参数值
+ * @description
+ * 设置 immediate 的值
+ *
+ * 如果外部没有传递 immediate 属性，那么就使用默认的值
+ *
+ * 每个业务接口都会传递 options 值，本函数用来完成默认的参数补全。
+ */
+export function setDefaultUseAxiosOptions<T>(options: UseAxiosOptionsBase<T>) {
+	const _options = createDefaultUseAxiosOptions();
+	options.immediate = options?.immediate ?? _options.immediate;
+}
+
+/** @private */
+interface SetDataByHttpParamWayParams {
+	httpParamWay: HttpParamWay;
+	config: AxiosRequestConfig;
+}
+export function setDataByHttpParamWay(params: SetDataByHttpParamWayParams) {
+	const { httpParamWay, config } = params;
+	if (
+		isConditionsSome([
+			//
+			() => config.method === "GET",
+			() => config.method === "get",
+			() => httpParamWay === "query",
+		])
+	) {
+		config.params = config.data;
+	}
+}

package/src/vueuse/useAxios-for-01s/types/JsonVO.ts

@@ -0,0 +1,18 @@
+/**
+ * 前后端数据对接数据对象
+ * @description
+ * 后端 JsonVO 泛型类的前端翻译
+ *
+ * `01s` 项目统一的数据返回格式
+ */
+export interface JsonVO<T> {
+	/** 状态码 */
+	code: number;
+
+	/** 提示消息 */
+
+	message: string;
+
+	/** 数据对象 */
+	data: T;
+}

package/src/vueuse/useAxios-for-01s/types/PageDTO.ts

@@ -0,0 +1,33 @@
+/**
+ * 数据分页的返回对象
+ * @description
+ *
+ * `01s` 项目统一的数据返回格式
+ */
+export interface PageDTO<T> {
+	/**
+	 * 当前页码
+	 */
+	pageIndex: number;
+
+	/**
+	 * 每页显示最大数据条数
+	 */
+
+	pageSize: number;
+
+	/**
+	 * 总条数
+	 */
+	total: number;
+
+	/**
+	 * 总页数
+	 */
+	pages: number;
+
+	/**
+	 * 当前页数据列表
+	 */
+	rows: T[];
+}