@dune2/tools 1.0.4 → 1.0.6

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dune2/tools",
-  "version": "1.0.4",
+  "version": "1.0.6",
   "description": "",
   "keywords": [
     "i18n"
@@ -25,8 +25,6 @@
     "./shared/*": "./src/shared/*.ts",
     "./storage": "./src/storage/index.ts",
     "./storage/*": "./src/storage/*.ts",
-    "./logger": "./src/logger/index.ts",
-    "./logger/*": "./src/logger/*.ts",
     "./store": "./src/store/index.ts",
     "./package.json": "./package.json",
     ".": "./src/index.ts"
@@ -35,17 +33,16 @@
     "src"
   ],
   "dependencies": {
+    "@tanstack/react-query": "^5",
     "bignumber.js": "^9.1.2",
     "es-toolkit": "^1",
     "js-cookie": "^3.0.5",
-    "store2": "^2.14.3"
+    "store2": "^2.14.3",
+    "valtio": "^2"
   },
   "devDependencies": {
-    "@tanstack/react-query": "5.51.11",
     "@types/js-cookie": "3.0.3",
-    "axios": "^1.6.8",
-    "react": "^19",
-    "valtio": "^2"
+    "react": "^19"
   },
   "publishConfig": {
     "access": "public"

package/readme.md

@@ -1,3 +1,106 @@
-## @dune2/tools
+# @dune2/tools
 
-- [`i18n`模块](i18n/readme.md)
+React utility library with common tools and components.
+
+## Installation
+
+```bash
+npm install @dune2/tools
+```
+
+## Modules
+
+### Factory
+
+React state management utilities for creating context providers.
+
+```typescript
+import { createStateContext } from "@dune2/tools/factory/createStateContext";
+
+const { Provider, useContextValue } = createStateContext({
+  name: "Counter",
+  useValueHooks: ({ initialCount = 0 }) => {
+    const [count, setCount] = useState(initialCount);
+    return { count, setCount };
+  },
+});
+```
+
+### Storage
+
+Browser storage wrapper with React hooks integration.
+
+```typescript
+import { createStorage } from "@dune2/tools/storage";
+
+class DataMap {
+  token = "";
+  user = null;
+}
+
+const storage = createStorage({
+  DataMap,
+  namespace: "app",
+  storageType: "local", // or 'session'
+});
+
+// Use in React
+const token = storage.token.useValue();
+```
+
+### RQ (React Query)
+
+Enhanced React Query utilities with built-in request building.
+
+```typescript
+import { RequestBuilder } from "@dune2/tools/rq";
+
+const userApi = new RequestBuilder({
+  url: "/api/users/{id}",
+  method: "get",
+  urlPathParams: ["id"],
+});
+
+// Use in components
+const { data, isLoading } = userApi.useQuery({ id: "123" });
+```
+
+### Store
+
+Valtio-based state management with TypeScript support.
+
+```typescript
+import { createStore } from "@dune2/tools/store";
+
+const counterStore = createStore({
+  name: "counter",
+  state: { count: 0 },
+  actionsCreator: (state) => ({
+    increment: () => state.count++,
+    decrement: () => state.count--,
+  }),
+});
+
+// Use in components
+const { count } = counterStore.useSnapshot();
+```
+
+### Numbro
+
+BigNumber.js wrapper for precise number formatting and calculations.
+
+```typescript
+import { numbro } from "@dune2/tools/numbro";
+
+const price = numbro(123.456);
+price.format({ mantissa: 2 }); // "123.46"
+price.formatCurrency({ symbol: "$" }); // "$123.46"
+```
+
+### Shared
+
+TypeScript utility types for better type safety.
+
+```typescript
+import type { OptionalKeys, Overwrite, Print } from "@dune2/tools/shared";
+```

package/src/numbro/index.ts

@@ -1,7 +1,5 @@
 import BigNumber from "bignumber.js";
-import { LocalesEnum } from "../i18n/enums";
-import { defaultCurrencies } from "./currencies";
-import type { CurrencyFormat, Format } from "./shared";
+import type { Format } from "./shared";
 import { RoundingMode } from "./shared";
 
 export * from "./shared";
@@ -161,68 +159,6 @@ export class Numbro {
   }
   //#endregion
 
-  //#region  currency format
-  /**
-   * currency format default
-   */
-  static locale: string = LocalesEnum.id;
-  static setLocale(locale: string) {
-    // check locale is valid
-    if (!(locale in Numbro.defaultCurrencies)) {
-      throw new Error(`在 defaultCurrencies 中，找不到 ${locale}，请先检查`);
-    }
-    Numbro.locale = locale;
-  }
-
-  /**
-   * 默认的货币格式化配置
-   * key: locale
-   * value: currency format
-   */
-  static defaultCurrencies = defaultCurrencies;
-  static setDefaultCurrencies(currencies: typeof defaultCurrencies) {
-    Numbro.defaultCurrencies = currencies;
-  }
-  formatCurrency(format: CurrencyFormat = {}) {
-    // 根据语言解析出来的默认格式
-    const defaultCurrencyFormat =
-      Numbro.defaultCurrencies[format.locale ?? Numbro.locale];
-
-    format = {
-      ...defaultCurrencyFormat,
-      ...format,
-    };
-    let {
-      position = "prefix",
-      symbol,
-      spaceSeparated,
-
-      ...rest
-    } = format;
-    // 是否强制显示正负号
-    const sign = this.getPrefixSign(rest.forceSign);
-
-    let space = spaceSeparated ? " " : "";
-    // 在 currency format 中，需要使用绝对值来格式化
-    // 方便后续添加 正负号
-    rest.absoluteValue = true;
-    rest.forceSign = false;
-    let formattedString = this.format(rest);
-
-    //#region NaN 的 fallback
-    const { NaNFormat } = this.combineFormatOptions(rest);
-    if (formattedString === NaNFormat) {
-      return formattedString;
-    }
-    //#endregion
-
-    if (position === "prefix") {
-      return `${sign}${symbol}${space}${formattedString}`;
-    }
-    return `${sign}${formattedString}${space}${symbol}`;
-  }
-  //#endregion
-
   private computeAverage(num: BigNumber) {
     const powers = {
       // 1t

package/src/numbro/shared.ts

@@ -1,5 +1,4 @@
 import BigNumber from "bignumber.js";
-import { LocalesEnum } from "../i18n/enums";
 
 export interface Format extends BigNumber.Format {
   output?: "percent";
@@ -73,30 +72,6 @@ export interface Format extends BigNumber.Format {
   absoluteValue?: boolean;
 }
 
-export interface CurrencyFormat extends Format {
-  /**
-   * 货币符号
-   */
-  symbol?: string;
-
-  /**
-   * 货币符号位置
-   */
-  position?: "prefix" | "postfix";
-
-  /**
-   * 按哪种语言格式化，会根据传入的语言去 currencies 里获取对应的配置项
-   * 一般用在以下情况：
-   * - 当前设置的语言是 en，但是需要格式化成 id 的货币
-   */
-  locale?: LocalesEnum | (string & {});
-
-  /**
-   * symbol 和 数字 之间是否需要空格
-   */
-  spaceSeparated?: boolean;
-}
-
 /**
  * 重新导出 BigNumber.RoundingMode
  * 由于项目不会使用太多的四舍五入模式，所以只导出常用的几个

package/src/rq/RequestBuilder.react-server.ts

@@ -46,7 +46,7 @@ export class RequestBuilder<Req = any, Res = any> {
    * useQuery、useMutation 内部会调用这个
    * 另外也可以直接调用这个函数来发送请求
    * @param params 请求参数 默认会根据请求方法来放到 url 上或者 body 里
-   * @param config axios 的配置，一般不需要传，内部用
+   * @param config 请求的配置，一般不需要传，内部用
    */
   request<P extends Req, T = Res>(params?: P, config?: RequestConfig) {
     const method = this.options.method!;

package/src/rq/RequestBuilder.ts

@@ -77,7 +77,7 @@ export class RequestBuilder<Req = any, Res = any> {
    * useQuery、useMutation 内部会调用这个
    * 另外也可以直接调用这个函数来发送请求
    * @param params 请求参数 默认会根据请求方法来放到 url 上或者 body 里
-   * @param config axios 的配置，一般不需要传，内部用
+   * @param config 请求的配置，一般不需要传，内部用
    */
   request<P extends Req, T = Res>(params?: P, config?: RequestConfig) {
     const method = this.options.method!;

package/src/rq/createApi.ts

@@ -29,7 +29,7 @@ export function createApi<Req, Res>(opts: Options<Req, Res>) {
   const { requestFn, ...rest } = opts;
   const api = new RequestBuilder<Req, Res>({
     url: opts.queryKey,
-    // 给定 get 则 在 requestFn 中可以通过 params 获取到参数，否则是 data 字段。这是为了对齐 axios 的规则
+    // 给定 get 则 在 requestFn 中可以通过 params 获取到参数，否则是 data 字段
     method: "get",
     requestFn: (config) => {
       return requestFn(config.params) as never;

package/src/rq/options.ts

@@ -5,10 +5,34 @@ import type {
   useQuery,
 } from "@tanstack/react-query";
 
-import type { AxiosRequestConfig, Method } from "axios";
+// 定义 HTTP 方法类型
+export type HttpMethod =
+  | "get"
+  | "post"
+  | "put"
+  | "delete"
+  | "patch"
+  | "head"
+  | "options";
 // 外部可以重写这个类型
 export interface RequestBuilderMeta {}
 
+// 通用的请求配置接口，不依赖于具体的 HTTP 库
+export interface RequestFnParams {
+  /** 请求URL */
+  url?: string;
+  /** HTTP 请求方法 */
+  method?: string;
+  /** URL 查询参数 */
+  params?: any;
+  /** 请求体数据 */
+  data?: any;
+  /** 请求头 */
+  headers?: Record<string, string>;
+  /** 请求取消 */
+  signal?: AbortSignal;
+}
+
 export interface Basic {
   /**
    * 请求方法
@@ -16,7 +40,7 @@ export interface Basic {
    * 2. 如果在调用`request/useQuery`之类的不想用实例化是传入的`requestFn`，可以在`request/useQuery`的第二个参数传入`requestFn`
    * 一般场景是有些情况需要全局`toast`，有些场景不需要，所以在不同的场景下传入不同实现的`requestFn`
    */
-  requestFn?: <T = unknown>(config: AxiosRequestConfig) => Promise<T>;
+  requestFn?: <T = unknown>(params: RequestFnParams) => Promise<T>;
 
   meta?: RequestBuilderMeta;
 }
@@ -45,7 +69,7 @@ export interface RequestBuilderOptions<Req, Res>
    * 请求方法
    * @default "get"
    */
-  method?: Lowercase<Method>;
+  method?: HttpMethod;
   // 请求路径
   url: string;
   // url path 上的参数 , /prefunding-order/{id} 中的 id
@@ -58,7 +82,7 @@ export interface RequestBuilderOptions<Req, Res>
   useMutationOptions?: UseMutationOptions<Res, unknown, Req>;
 }
 
-export type RequestConfig = Basic & AxiosRequestConfig;
+export type RequestConfig = Basic & RequestFnParams;
 
 export type PageData<T = any> = {
   total?: number;

package/src/logger/Logger.ts

@@ -1,104 +0,0 @@
-import { noop } from "es-toolkit";
-import store2 from "store2";
-import { Level, type OnLogParams } from "./shared";
-
-type StorageState = Record<string, Level>;
-
-export type OnLog = (data: OnLogParams) => void;
-
-export class Logger {
-  constructor(
-    public name: string,
-    public storageKey?: string,
-    /**
-     * 当前启用的等级
-     * 如果设置为 Silent 则不输出任何日志
-     * 只有大于等于当前等级的日志才会输出
-     */
-    public level = Level.Debug,
-    public onLog: OnLog = noop,
-  ) {
-    this.level = this.getStorageLevel() ?? level;
-  }
-
-  private getStorageLevel() {
-    if (this.storageKey) {
-      const state = store2.get(this.storageKey) as StorageState;
-      return state?.[this.name];
-    }
-  }
-  private setStorageLevel(level: Level) {
-    if (this.storageKey) {
-      const state = store2.get(this.storageKey) as StorageState;
-      store2.set(this.storageKey, { ...state, [this.name]: level });
-    }
-  }
-  setLevel(level: Level) {
-    this.level = level;
-    this.setStorageLevel(level);
-  }
-  enable() {
-    this.setLevel(Level.Debug);
-  }
-  disable() {
-    this.setLevel(Level.Error);
-  }
-
-  // 是否应该输出日志
-  private shouldLog(level: Level) {
-    return level >= this.level;
-  }
-
-  private combineArgs(level: Level, tag: string, args: any[]): OnLogParams {
-    const data = {
-      name: this.name,
-      level,
-      msg: args,
-      tag,
-      time: Date.now(),
-      shouldLog: this.shouldLog(level),
-    };
-    return data;
-  }
-  private formatArgs(data: OnLogParams) {
-    const time = new Date(data.time).toLocaleTimeString("zh-CN");
-    const prefix = `[${time}] ${data.tag} ${data.name}: `;
-
-    const first = data.msg[0];
-
-    if (typeof first === "string") {
-      // 确保 %o %O 等占位符正常工作
-      return [`${prefix}${first}`, ...data.msg.slice(1)];
-    }
-    return [`${prefix}`, ...data.msg];
-  }
-
-  debug(...args: any[]) {
-    const data = this.combineArgs(Level.Debug, "DEBUG", args);
-    this.onLog(data);
-    if (data.shouldLog) {
-      console.debug(...this.formatArgs(data));
-    }
-  }
-  info(...args: any[]) {
-    const data = this.combineArgs(Level.Info, "INFO", args);
-    this.onLog(data);
-    if (data.shouldLog) {
-      console.log(...this.formatArgs(data));
-    }
-  }
-  warn(...args: any[]) {
-    const data = this.combineArgs(Level.Warn, "WARN", args);
-    this.onLog(data);
-    if (data.shouldLog) {
-      console.warn(...this.formatArgs(data));
-    }
-  }
-  error(...args: any[]) {
-    const data = this.combineArgs(Level.Error, "ERROR", args);
-    this.onLog(data);
-    if (data.shouldLog) {
-      console.error(...this.formatArgs(data));
-    }
-  }
-}

package/src/logger/index.ts

@@ -1,71 +0,0 @@
-import { camelCase } from "es-toolkit";
-import { forEach } from "es-toolkit/compat";
-import { Logger, type OnLog } from "./Logger";
-import { Level } from "./shared";
-
-interface Config<Name extends string = string> {
-  // 创建的 logger 名称
-  loggers: Name[];
-  // 默认日志级别
-  level?: Level;
-  // 日志回调，用于上报日志
-  onLog?: OnLog;
-  // 存储到本地的 key，用于存储日志级别
-  storageKey?: string;
-}
-
-type NormalizeName<T extends string> = T extends `${infer A}.${infer B}`
-  ? `${A}${Capitalize<NormalizeName<B>>}`
-  : T;
-
-export function createLogger<Name extends string>(config: Config<Name>) {
-  type Key = NormalizeName<Name>;
-
-  // 内置关键字
-  const keywords = ["debug", "info", "warn", "error", "enable", "disable"];
-
-  const loggerMap = {} as Record<Key, Logger>;
-  config.loggers.forEach((name) => {
-    if (keywords.includes(name)) {
-      throw new Error(`logger name can't be ${name}`);
-    }
-    // 输入：foo.login
-    // 输出：fooLogin
-    const key = (name.includes(".") ? camelCase(name) : name) as Key;
-
-    if (loggerMap[key]) {
-      throw new Error(`logger name "${name}" is duplicated`);
-    }
-
-    const logger = new Logger(
-      name,
-      config.storageKey,
-      config.level ?? Level.Debug,
-      config.onLog,
-    );
-    loggerMap[key] = logger;
-  });
-
-  const method = {
-    enable() {
-      forEach(loggerMap, (v) => {
-        v.enable();
-      });
-    },
-    disable() {
-      forEach(loggerMap, (v) => {
-        v.disable();
-      });
-    },
-    setLevel(level: Level) {
-      forEach(loggerMap, (v) => {
-        v.setLevel(level);
-      });
-    },
-  };
-
-  return {
-    ...method,
-    ...loggerMap,
-  };
-}

package/src/logger/shared.ts

@@ -1,25 +0,0 @@
-export enum Level {
-  Debug,
-  Info,
-  Warn,
-  Error,
-  Silent,
-}
-
-export type OnLogParams = {
-  // 日志等级
-  level: Level;
-  // 可读的日志等级
-  tag: string;
-  // 用于标识日志的名称
-  name: string;
-  // 日志输出时间
-  time: number;
-  // 是否应该输出日志
-  shouldLog: boolean;
-  // 日志内容
-  msg: any[];
-};
-
-// 让 vite 能识别成 es-module
-export default {};

package/src/numbro/currencies.ts

@@ -1,23 +0,0 @@
-import { LocalesEnum } from "../i18n/enums";
-import type { CurrencyFormat } from "./shared";
-
-export const defaultCurrencies: Record<
-  string,
-  Omit<CurrencyFormat, "locale">
-> = {
-  [LocalesEnum.en]: {
-    symbol: "$",
-    position: "prefix",
-    mantissa: 2,
-  },
-  [LocalesEnum.id]: {
-    symbol: "Rp",
-    position: "prefix",
-    mantissa: 2,
-  },
-  [LocalesEnum.zh]: {
-    symbol: "¥",
-    position: "prefix",
-    mantissa: 2,
-  },
-};