@ruan-cat/utils 1.7.0 → 3.0.0

package/{readme.md → README.md}

@@ -1,3 +1,9 @@
+---
+order: 10
+dir:
+  order: 10
+---
+
 # 工具包
 
 这是阮喵喵开发的工具包，提供了一些工具函数。

package/dist/index.d.ts

@@ -1,9 +1,4 @@
 import { OptionalKeysOf } from 'type-fest';
-import { Options } from 'unplugin-vue-router';
-import { RequiredPick } from 'type-plus';
-import { AxiosRequestConfig, AxiosResponse, AxiosInstance } from 'axios';
-import { UseAxiosOptions, UseAxiosReturn } from '@vueuse/integrations/useAxios';
-export { UseAxiosOptions } from '@vueuse/integrations/useAxios';
 
 /**
  * rmmv特征基类
@@ -116,18 +111,6 @@ type Conditions = Condition[];
 declare function isConditionsEvery(conditions: Condition[]): boolean;
 declare function isConditionsSome(conditions: Condition[]): boolean;
 
-type GetRouteName = NonNullable<Options["getRouteName"]>;
-/**
- * 自主生成路由名称
- * @description
- * 对插件自动生成的路由名称，很不满意，不好看，容易引起阅读歧义。
- *
- * 故自定义。
- *
- * unplugin-vue-router 插件的 getRouteName 配置项
- */
-declare const getRouteName: GetRouteName;
-
 /** 创建简单的异步任务 */
 declare function generateSimpleAsyncTask<T extends (...args: any) => any>(func: T): (...args: any) => Promise<ReturnType<T>>;
 type SimpleAsyncTask = ReturnType<typeof generateSimpleAsyncTask>;
@@ -180,117 +163,6 @@ declare function executePromiseTasks(config: TasksConfig,
  */
 lastParams?: any): Promise<any>;
 
-/** 拓展的类型参数 用于约束必填的字段 */
-type KeyAxiosRequestConfig<D = any> = keyof AxiosRequestConfig<D>;
-/** 填写key值的帮助类型 */
-type KeyHelper<K extends KeyAxiosRequestConfig> = K;
-type RemoveUrl<T extends KeyAxiosRequestConfig> = Exclude<T, "url">;
-/**
- * 创建 AxiosRequestConfig 的各种变种类型
- * @description
- * 目前需要给 AxiosRequestConfig 添加必填属性
- *
- * 故需要本工具创建各种变种类型
- *
- * @example CreateAxiosRequestConfig<"url", D>
- */
-type CreateAxiosRequestConfig<K extends keyof Target, D = any, Target = AxiosRequestConfig<D>> = RequiredPick<Target, K>;
-/** 拓展K泛型后的类型 */
-interface StrictUseAxiosReturn<T, 
-/**
- * 拓展的类型参数 用于约束必填的字段
- * @description
- * 这里不需要提供默认的取值
- */
-K extends KeyAxiosRequestConfig<D>, R, D> extends UseAxiosReturn<T, R, D> {
-    /**
-     * Manually call the axios request
-     */
-    execute: (url?: string | CreateAxiosRequestConfig<K, D>, config?: CreateAxiosRequestConfig<K, D>) => Promise<StrictUseAxiosReturn<T, K, R, D>>;
-}
-declare module "@vueuse/integrations/useAxios" {
-    /**
-     * 拓展类型参数后的 useAxios 函数
-     * @description
-     * 在我们的封装中 使用本类型
-     */
-    function useAxios<T = any, 
-    /** 拓展的类型参数 用于约束必填的字段 */
-    K extends KeyAxiosRequestConfig<D> = "url", R = AxiosResponse<T>, D = any>(url: string, config: AxiosRequestConfig<D>, instance: AxiosInstance, options?: UseAxiosOptions): StrictUseAxiosReturn<T, K, R, D> & Promise<StrictUseAxiosReturn<T, K, R, D>>;
-}
-/** 包装器的参数 */
-interface UseAxiosWrapperParams<
-/**
- * 业务数据类型
- * @description
- * 必须先填写业务类型
- */
-T = any, 
-/**
- * AxiosRequestConfig 默认必填的字段
- * @description
- * 用于约束其他类型的字段
- *
- * 然后才能填写必传的参数类型
- *
- * 默认为 必填url请求地址的 config 请求配置
- */
-K extends KeyAxiosRequestConfig<D> = "url", 
-/**
- * UseAxiosOptions 的派生类型
- */
-UseAxiosOptionsLike extends UseAxiosOptions = UseAxiosOptions, 
-/**
- * AxiosRequestConfig 用的类型
- * @description
- * 最后才可以传递此类型
- */
-D = any> {
-    /**
-     * axios的配置类型
-     * @description
-     * 默认为 必填url请求地址的 config 请求配置
-     */
-    config: CreateAxiosRequestConfig<K, D>;
-    /**
-     * axios实例
-     * @description
-     * 对于包装器函数而言 必须传递有意义的请求实例
-     */
-    instance: AxiosInstance;
-    /** useAxios 的选项配置 */
-    options: UseAxiosOptionsLike;
-}
-/**
- * useAxios 的包装函数
- * @description
- * 其本质是对 useAxios 函数的封装，仅仅是包装了参数层
- *
- * 预期设计成一个万能的 通用的请求函数
- */
-declare function useAxiosWrapper<T, K extends KeyAxiosRequestConfig, D = any>(params: UseAxiosWrapperParams): StrictUseAxiosReturn<T, K, AxiosResponse<T, any>, D> & Promise<StrictUseAxiosReturn<T, K, AxiosResponse<T, any>, D>>;
-
-/** 包的信息 */
-interface PackageInfo {
-    /** 包名 */
-    name: string;
-    /** 包的描述 */
-    description: string;
-    /** 带有包名的官方镜像源地址 */
-    url: `https://npm.im/${string}`;
-}
-/**
- * 获得阮喵喵全部的包信息
- * @description
- * 这是一个node环境下的函数，用于获取阮喵喵的所有包的信息。
- *
- * 使用的是node的child_process模块，调用pnpm命令获取包信息。
- *
- * - 默认仅考虑pnpm包
- * - 在node环境下运行
- */
-declare function getRuanCatPkgInfo(): Promise<PackageInfo[]>;
-
 /**
  * pnpm-workspace.yaml 文件的类型声明
  * @description
@@ -328,4 +200,4 @@ type Prettify<T> = {
  */
 type ToNumberLike<T extends number> = T | `${T}`;
 
-export { type AttributePromptTool, type BaseTask, type Condition, type Conditions, type CreateAxiosRequestConfig, type FunctionKeys, type HandleStrategy, type KeyAxiosRequestConfig, type KeyHelper, type PackageInfo, type ParallelTasks, type PnpmWorkspace, type Prettify, type PromiseTasksConfig, type QueueTasks, type RemoveUrl, RmmvClass, type SimpleAsyncTask, type SingleTasks, type StrictUseAxiosReturn, type Task, type TaskType, type TasksConfig, type ToNumberLike, type UseAxiosWrapperParams, defaultHandleStrategy, type defaultHandleStrategy_FuncationName, definePromiseTasks, executePromiseTasks, generateSimpleAsyncTask, getRouteName, getRuanCatPkgInfo, initFlag, isConditionsEvery, isConditionsSome, rmmvClassExpandTools, runPromiseByConcurrency, runPromiseByQueue, taskTypes, useAxiosWrapper };
+export { type AttributePromptTool, type BaseTask, type Condition, type Conditions, type FunctionKeys, type HandleStrategy, type ParallelTasks, type PnpmWorkspace, type Prettify, type PromiseTasksConfig, type QueueTasks, RmmvClass, type SimpleAsyncTask, type SingleTasks, type Task, type TaskType, type TasksConfig, type ToNumberLike, defaultHandleStrategy, type defaultHandleStrategy_FuncationName, definePromiseTasks, executePromiseTasks, generateSimpleAsyncTask, initFlag, isConditionsEvery, isConditionsSome, rmmvClassExpandTools, runPromiseByConcurrency, runPromiseByQueue, taskTypes };

package/dist/index.js

@@ -842,17 +842,6 @@ function isConditionsSome(conditions) {
   return conditions.some((condition) => condition());
 }
 
-// src/unplugin-vue-router/index.ts
-var getRouteName = function _getRouteName(node) {
-  if (!node.parent) {
-    return "";
-  }
-  const last = _getRouteName(node.parent);
-  const connector = last === "" ? "" : "-";
-  const current = node.value.rawSegment === "index" ? "" : `${connector}${node.value.rawSegment}`;
-  return last + current;
-};
-
 // src/define-promise-tasks.ts
 var taskTypes = ["single", "parallel", "queue"];
 function isSingleTasks(config) {
@@ -920,62 +909,18 @@ async function runPromiseByQueue(promises) {
 async function runPromiseByConcurrency(promises) {
   await Promise.all(promises.map((promise) => promise()));
 }
-
-// src/vueuse/useAxios.ts
-import { useAxios } from "@vueuse/integrations/useAxios";
-function useAxiosWrapper(params) {
-  const {
-    config: { url },
-    config,
-    instance,
-    options
-  } = params;
-  return useAxios(url, config, instance, options);
-}
-
-// src/ruan-cat-pkg-info.ts
-import { spawnSync } from "node:child_process";
-async function getRuanCatPkgInfo() {
-  return new Promise((resolve, reject) => {
-    const result = spawnSync("pnpm", ["s", "@ruan-cat/*", "--registry", "https://registry.npmmirror.com/", "--json"], {
-      encoding: "utf-8"
-    });
-    if (result.error) {
-      console.error(`Error executing command: ${result.error.message}`);
-      reject(result.error);
-      return;
-    }
-    if (result.stderr) {
-      console.error(`Error in output: ${result.stderr}`);
-      reject(new Error(result.stderr));
-      return;
-    }
-    const packages = JSON.parse(result.stdout);
-    const res = packages.map(
-      (pkg) => ({
-        name: pkg.name,
-        description: pkg.description,
-        url: `https://npm.im/${pkg.name}`
-      })
-    );
-    resolve(res);
-  });
-}
 export {
   defaultHandleStrategy,
   definePromiseTasks,
   executePromiseTasks,
   generateSimpleAsyncTask,
-  getRouteName,
-  getRuanCatPkgInfo,
   initFlag,
   isConditionsEvery,
   isConditionsSome,
   rmmvClassExpandTools,
   runPromiseByConcurrency,
   runPromiseByQueue,
-  taskTypes,
-  useAxiosWrapper
+  taskTypes
 };
 /*! Bundled license information: