@ercao/ts-utils 0.0.1

package/.github/workflows/npm-publish.yml

@@ -0,0 +1,39 @@
+# This workflow will run tests using node and then publish a package to GitHub Packages when a release is created
+# For more information see: https://docs.github.com/en/actions/publishing-packages/publishing-nodejs-packages
+
+name: Node.js Package
+
+on:
+  workflow_dispatch:
+  release:
+    types: [created]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v6
+        with:
+          node-version: 20
+
+  publish-npm:
+    needs: build
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v6
+        with:
+          node-version: 20
+          registry-url: https://registry.npmjs.org/
+      - uses: pnpm/action-setup@v4
+        name: Install pnpm
+        with:
+          version: 10
+          cache: true
+      - name: Install dependencies
+        run: pnpm install
+      #
+      - run: pnpm publish --access public
+        env:
+          NODE_AUTH_TOKEN: ${{secrets.npm_token}}

package/.oxfmtrc.json

@@ -0,0 +1,6 @@
+{
+  "$schema": "./node_modules/oxfmt/configuration_schema.json",
+  "ignorePatterns": [],
+  "printWidth": 120,
+  "singleQuote": true
+}

package/.oxlintrc.json

@@ -0,0 +1,144 @@
+{
+  "$schema": "./node_modules/oxlint/configuration_schema.json",
+  "plugins": ["unicorn", "typescript", "oxc"],
+  "categories": {},
+  "rules": {
+    "constructor-super": "warn",
+    "for-direction": "warn",
+    "no-async-promise-executor": "warn",
+    "no-caller": "warn",
+    "no-class-assign": "warn",
+    "no-compare-neg-zero": "warn",
+    "no-cond-assign": "warn",
+    "no-const-assign": "warn",
+    "no-constant-binary-expression": "warn",
+    "no-constant-condition": "warn",
+    "no-control-regex": "warn",
+    "no-debugger": "warn",
+    "no-delete-var": "warn",
+    "no-dupe-class-members": "warn",
+    "no-dupe-else-if": "warn",
+    "no-dupe-keys": "warn",
+    "no-duplicate-case": "warn",
+    "no-empty-character-class": "warn",
+    "no-empty-pattern": "warn",
+    "no-empty-static-block": "warn",
+    "no-eval": "warn",
+    "no-ex-assign": "warn",
+    "no-extra-boolean-cast": "warn",
+    "no-func-assign": "warn",
+    "no-global-assign": "warn",
+    "no-import-assign": "warn",
+    "no-invalid-regexp": "warn",
+    "no-irregular-whitespace": "warn",
+    "no-loss-of-precision": "warn",
+    "no-new-native-nonconstructor": "warn",
+    "no-nonoctal-decimal-escape": "warn",
+    "no-obj-calls": "warn",
+    "no-self-assign": "warn",
+    "no-setter-return": "warn",
+    "no-shadow-restricted-names": "warn",
+    "no-sparse-arrays": "warn",
+    "no-this-before-super": "warn",
+    "no-unassigned-vars": "warn",
+    "no-unsafe-finally": "warn",
+    "no-unsafe-negation": "warn",
+    "no-unsafe-optional-chaining": "warn",
+    "no-unused-expressions": "warn",
+    "no-unused-labels": "warn",
+    "no-unused-private-class-members": "warn",
+    "no-unused-vars": "warn",
+    "no-useless-backreference": "warn",
+    "no-useless-catch": "warn",
+    "no-useless-escape": "warn",
+    "no-useless-rename": "warn",
+    "no-with": "warn",
+    "require-yield": "warn",
+    "use-isnan": "warn",
+    "valid-typeof": "warn",
+    "oxc/bad-array-method-on-arguments": "warn",
+    "oxc/bad-char-at-comparison": "warn",
+    "oxc/bad-comparison-sequence": "warn",
+    "oxc/bad-min-max-func": "warn",
+    "oxc/bad-object-literal-comparison": "warn",
+    "oxc/bad-replace-all-arg": "warn",
+    "oxc/const-comparisons": "warn",
+    "oxc/double-comparisons": "warn",
+    "oxc/erasing-op": "warn",
+    "oxc/missing-throw": "warn",
+    "oxc/number-arg-out-of-range": "warn",
+    "oxc/only-used-in-recursion": "warn",
+    "oxc/uninvoked-array-callback": "warn",
+    "typescript/await-thenable": "warn",
+    "typescript/no-array-delete": "warn",
+    "typescript/no-base-to-string": "warn",
+    "typescript/no-duplicate-enum-values": "warn",
+    "typescript/no-duplicate-type-constituents": "warn",
+    "typescript/no-extra-non-null-assertion": "warn",
+    "typescript/no-floating-promises": "warn",
+    "typescript/no-for-in-array": "warn",
+    "typescript/no-implied-eval": "warn",
+    "typescript/no-meaningless-void-operator": "warn",
+    "typescript/no-misused-new": "warn",
+    "typescript/no-misused-spread": "warn",
+    "typescript/no-non-null-asserted-optional-chain": "warn",
+    "typescript/no-redundant-type-constituents": "warn",
+    "typescript/no-this-alias": "warn",
+    "typescript/no-unnecessary-parameter-property-assignment": "warn",
+    "typescript/no-unsafe-declaration-merging": "warn",
+    "typescript/no-unsafe-unary-minus": "warn",
+    "typescript/no-useless-empty-export": "warn",
+    "typescript/no-wrapper-object-types": "warn",
+    "typescript/prefer-as-const": "warn",
+    "typescript/require-array-sort-compare": "warn",
+    "typescript/restrict-template-expressions": "warn",
+    "typescript/triple-slash-reference": "warn",
+    "typescript/unbound-method": "warn",
+    "unicorn/no-await-in-promise-methods": "warn",
+    "unicorn/no-empty-file": "warn",
+    "unicorn/no-invalid-fetch-options": "warn",
+    "unicorn/no-invalid-remove-event-listener": "warn",
+    "unicorn/no-new-array": "warn",
+    "unicorn/no-single-promise-in-promise-methods": "warn",
+    "unicorn/no-thenable": "warn",
+    "unicorn/no-unnecessary-await": "warn",
+    "unicorn/no-useless-fallback-in-spread": "warn",
+    "unicorn/no-useless-length-check": "warn",
+    "unicorn/no-useless-spread": "warn",
+    "unicorn/prefer-set-size": "warn",
+    "unicorn/prefer-string-starts-ends-with": "warn"
+  },
+  "settings": {
+    "jsx-a11y": {
+      "polymorphicPropName": null,
+      "components": {},
+      "attributes": {}
+    },
+    "next": {
+      "rootDir": []
+    },
+    "react": {
+      "formComponents": [],
+      "linkComponents": [],
+      "version": null
+    },
+    "jsdoc": {
+      "ignorePrivate": false,
+      "ignoreInternal": false,
+      "ignoreReplacesDocs": true,
+      "overrideReplacesDocs": true,
+      "augmentsExtendsReplacesDocs": false,
+      "implementsReplacesDocs": false,
+      "exemptDestructuredRootsFromChecks": false,
+      "tagNamePreference": {}
+    },
+    "vitest": {
+      "typecheck": false
+    }
+  },
+  "env": {
+    "builtin": true
+  },
+  "globals": {},
+  "ignorePatterns": []
+}

package/.vscode/settings.json

@@ -0,0 +1,5 @@
+{
+  "[typescript]": {
+    "editor.defaultFormatter": "oxc.oxc-vscode"
+  }
+}

package/package.json

@@ -0,0 +1,61 @@
+{
+  "name": "@ercao/ts-utils",
+  "version": "0.0.1",
+  "type": "module",
+  "author": "ercao",
+  "publishConfig": {
+    "registry": "https://registry.npmjs.org/"
+  },
+  "exports": {
+    ".": {
+      "import": "./dist/index.js",
+      "types": "./dist/index.d.ts"
+    },
+    "./tw": {
+      "import": "./dist/tw.js",
+      "types": "./dist/tw.d.ts"
+    },
+    "./defu": {
+      "import": "./dist/defu.js",
+      "types": "./dist/defu.d.ts"
+    },
+    "./remeda": {
+      "import": "./dist/time.js",
+      "types": "./dist/time.d.ts"
+    },
+    "./ts-pattern": {
+      "import": "./dist/ts-pattern.js",
+      "types": "./dist/ts-pattern.d.ts"
+    },
+    "./type-fest": {
+      "import": "./dist/type-fest.js",
+      "types": "./dist/type-fest.d.ts"
+    }
+  },
+  "dependencies": {
+    "date-fns": "4.1.0",
+    "defu": "6.1.4",
+    "file64": "~1.0.5",
+    "filesize": "~11.0.13",
+    "js-file-download": "0.4.12",
+    "normalize-url": "8.1.0",
+    "query-string": "9.3.1",
+    "remeda": "~2.32.0",
+    "tailwind-variants": "~3.2.2",
+    "ts-pattern": "5.9.0"
+  },
+  "devDependencies": {
+    "oxfmt": "^0.23.0",
+    "oxlint": "^1.38.0",
+    "tsdown": "^0.18.1",
+    "type-fest": "5.2.0",
+    "typescript": "^5.9.3",
+    "vue-component-type-helpers": "~3.1.8"
+  },
+  "scripts": {
+    "dev": "tsdown --watch",
+    "build": " tsdown",
+    "lint": "oxlint",
+    "lint:fix": "oxlint"
+  }
+}

package/renovate.json

@@ -0,0 +1,6 @@
+{
+  "$schema": "https://docs.renovatebot.com/renovate-schema.json",
+  "extends": [
+    "config:recommended"
+  ]
+}

package/src/array.ts

@@ -0,0 +1,51 @@
+/**
+ * 为 true 时返回数组，否则返回空数组
+ */
+export const optional = <T>(arr: T[], flag: boolean) => (flag ? arr : []);
+
+// 定义树形数据的返回类型，包含原始数据和 children 属性
+type TreeDataEntity<T> = T & { children: TreeDataEntity<T>[] };
+
+/**
+ * 将一个带有fatherId的列表转换成由children属性主导的树形结构
+ *
+ * @param list 数据列表
+ * @param fatherId 父级id的字段名，默认fatherId
+ *
+ * @returns 将原数据类型加上children属性，并制作成属性列表返回
+ *
+ * @author 作者 - Mikaisa
+ */
+export const buildTreeDataListByFatherId = <T>(list: T[], fatherId: string = 'fatherId'): TreeDataEntity<T>[] => {
+  const map = new Map();
+
+  const rootNodes: TreeDataEntity<T>[] = [];
+
+  // 初始化Map
+  list.forEach((item: any) => {
+    if (!map.has(item.id)) {
+      map.set(item.id, { ...item, children: [] });
+    }
+    map.set(item.id, { ...map.get(item.id), ...item, children: map.get(item.id).children || [] });
+  });
+
+  // 构建层次结构
+  list.forEach((item: any) => {
+    const parent = item[fatherId] && map.get(item[fatherId]);
+    if (parent) {
+      parent.children.push(map.get(item.id));
+      // parent.hasChildren = true;
+    } else {
+      rootNodes.push(map.get(item.id));
+    }
+  });
+
+  return rootNodes;
+};
+
+/// 确保 obj[prop] 是数组
+export const arrayGuard = (obj: any, prop: string | number | symbol) => {
+  if (!Array.isArray(obj?.[prop])) {
+    obj[prop] = [];
+  }
+};

package/src/defu.ts

@@ -0,0 +1 @@
+export { defu, defuArrayFn, defuFn, type Defu, createDefu } from 'defu';

package/src/file.ts

@@ -0,0 +1,33 @@
+import downloadFile from 'js-file-download';
+import { base64ToBlob } from 'file64';
+import defu from 'defu';
+
+export * from 'file64';
+
+export { filesize } from 'filesize';
+
+export const DEFAULT_CONTENT_TYPE = 'application/octet-stream';
+
+/**
+ * 下载 base64 文件
+ */
+export const downloadFileFromBase64 = async (base64: string, fileName: string, _options?: { contentType?: string }) => {
+  const options = defu(_options, {
+    contentType: DEFAULT_CONTENT_TYPE,
+  });
+
+  const blobData = await base64ToBlob(`data:${options.contentType};base64,${base64}`);
+  downloadFile(blobData, fileName);
+};
+
+/**
+ * 下载 blob 文件
+ */
+export const downloadFileFromBlob = async (_blob, fileName: string, _options?: { contentType?: string }) => {
+  const options = defu(_options, {
+    contentType: DEFAULT_CONTENT_TYPE,
+  });
+
+  const blob = new Blob([_blob], { type: options.contentType });
+  downloadFile(blob, fileName);
+};

package/src/index.ts

@@ -0,0 +1,27 @@
+export * from './array';
+export * from './tw';
+export * from './file';
+export * from './number';
+export * from './object';
+export * from './string';
+// export * from './time';
+export * from './remeda';
+export * from './defu';
+
+/**
+ * 依照枚举类型出现的键值对生成选项数组供组件使用
+ *  @param map 键值对对象，例如: { 0:"Male",1:"Female" }
+ *  @param keyIsNumber 返回的选项value是否为数字，默认为false
+ *
+ *  @return array 生成的选项数组，例如 [ { intValue: 0,label:"Male", value:"0" }...]
+ *
+ *  @author 作者 - Mikaisa
+ * */
+export const optionsMaker = (map: Record<number | string, string>, keyIsNumber?: boolean): any[] => {
+  return Object.keys(map).map((key: string) => ({
+    intValue: Number.parseInt(key),
+    label: map[key],
+    value: keyIsNumber ? Number(key) : key,
+    text: map[key],
+  }));
+};

package/src/number.ts

@@ -0,0 +1,14 @@
+/**
+ * 将数字或字符串转换为固定小数位数的数字
+ */
+export const numberToFixed = (value: string | number, fixed: number) => {
+  if (value == null) {
+    return null;
+  }
+
+  if (typeof value === "number") {
+    return Number.isInteger(value) ? value : value.toFixed(fixed);
+  }
+
+  return value;
+};

package/src/object.ts

@@ -0,0 +1,17 @@
+import * as R from 'remeda';
+import { EMPTY_STRING } from './string';
+
+/**
+ * 反转对象的键和值
+ */
+export const reverseObj = <T extends Record<string, string | number>>(obj: T) => {
+  return R.mapToObj(Object.entries(obj), R.reverse());
+};
+
+/** 根据 path 返回对象的值 */
+export const getPropByPath = <T extends {}>(obj: T, path: string, defaultValue: any = EMPTY_STRING) => {
+  if (!path) return defaultValue;
+
+  const value = R.pathOr(obj, R.stringToPath(path) as any, defaultValue as any);
+  return value != null ? value : defaultValue;
+};

package/src/remeda.ts

@@ -0,0 +1,10 @@
+import * as R from 'remeda';
+
+export { R };
+
+export * from 'remeda';
+
+/**
+ * 大驼峰
+ */
+export const toPascalCase = (value: string) => R.capitalize(R.toCamelCase(value));

package/src/string.ts

@@ -0,0 +1,6 @@
+/**
+ * 空字符串
+ */
+export const EMPTY_STRING = '—';
+
+export { fileToBase64, blobToBase64, base64ToBlob, base64ToFile } from 'file64';

package/src/time.ts

@@ -0,0 +1,91 @@
+import { EMPTY_STRING } from "./string";
+import * as dateFns from "date-fns";
+import { zhCN } from "date-fns/locale";
+
+export * from "date-fns";
+
+/**
+ * 将时间格式化为YYYY-MM-DD HH:mm:ss的格式
+ * @param datetime 时间
+ * @param nullString 时间不合规比如为null时，返回的字符串
+ * */
+export const dateTimeFormater = (
+  datetime: number | string | Date | null | undefined,
+  format: string = "yyyy-MM-dd HH:mm",
+  nullString: string = EMPTY_STRING,
+  allowLongTerm: boolean = true
+) => {
+  if (
+    datetime == null ||
+    datetime == EMPTY_STRING ||
+    dateFns.isSameDay(datetime, SQL_SERVER_DEFAULT_DATETIME)
+  ) {
+    return nullString;
+  }
+
+  if (allowLongTerm && isLongTermDate(datetime)) {
+    return "长期有效";
+  }
+
+  // console.log("datetime", datetime);
+  return dateFns.format(new Date(datetime), format);
+};
+
+/**
+ * 将时间格式化为YYYY-MM-DD的格式
+ * */
+export const dateFormater = (date: any, nullString = EMPTY_STRING) => {
+  return dateTimeFormater(date, "yyyy-MM-dd", nullString);
+};
+
+export const numToWeekDay = (num: number) => {
+  switch (num) {
+    case 1:
+      return "星期一";
+    case 2:
+      return "星期二";
+    case 3:
+      return "星期三";
+    case 4:
+      return "星期四";
+    case 5:
+      return "星期五";
+    case 6:
+      return "星期六";
+    case 0:
+      return "星期日";
+    default:
+      return "未知";
+  }
+};
+
+/**
+ * 将秒数格式化为 human 可读格式
+ */
+export const formatShortDuration = (seconds: number) => {
+  if (seconds === 0) {
+    return "0秒";
+  }
+
+  const duration = dateFns.intervalToDuration({
+    start: 0,
+    end: seconds * 1000,
+  });
+  // const nonZeroDuration = Object.fromEntries(Object.entries(duration).filter(([_, value]) => value !== 0));
+  return dateFns
+    .formatDuration(duration, { locale: zhCN, zero: false })
+    .replace(" ", "");
+};
+
+/// SQL Server 默认日期
+export const SQL_SERVER_DEFAULT_DATETIME = new Date(1900, 0, 1);
+
+/// 长期有效日期
+export const LONG_TERM_DATE = new Date(9999, 0, 1);
+// dateFns.format(new Date(9999, 0, 1), "yyyy-MM-dd'T'HH:mm:ssXXX", { locale: zhCN });
+
+/// 是否是长期有效时间
+export const isLongTermDate = (date: dateFns.DateArg<Date>) => {
+  if (!date) return false;
+  return dateFns.isSameDay(date, LONG_TERM_DATE);
+};

package/src/ts-pattern.ts

@@ -0,0 +1 @@
+export * from 'ts-pattern';

package/src/tw.ts

@@ -0,0 +1,5 @@
+import { R } from './remeda';
+
+export * from 'tailwind-variants';
+
+export const forTW = R.identity();

package/src/types/type-fest.ts

@@ -0,0 +1 @@
+export type * from "type-fest";

package/src/types/vue-component-type-helpers.ts

@@ -0,0 +1 @@
+export * from "vue-component-type-helpers";

package/tsconfig.json

@@ -0,0 +1,21 @@
+{
+  "compilerOptions": {
+    "target": "ESNext",
+    "module": "ESNext",
+    "moduleResolution": "bundler",
+    "esModuleInterop": true,
+
+    "verbatimModuleSyntax": true,
+    "skipLibCheck": true,
+    "strict": true,
+    "noImplicitAny": false,
+    "noImplicitThis": true,
+
+    "noEmit": true,
+    "allowImportingTsExtensions": true,
+
+    "types": []
+  },
+
+  "exclude": ["dist"]
+}

package/tsdown.config.ts

@@ -0,0 +1,12 @@
+import { defineConfig } from 'tsdown';
+
+export default defineConfig({
+  entry: 'src/**/*.ts',
+  platform: 'neutral',
+
+  target: 'esnext',
+  plugins: [],
+  dts: true,
+  unbundle: true,
+  clean: false,
+});