@hzw-tech/utils 0.0.1

package/dist/ts/utils.d.ts

@@ -0,0 +1,128 @@
+import type { GConfig } from './config';
+declare function getConfig(): GConfig;
+declare function getType(data: any): string;
+declare function isJson(data: string): boolean;
+declare function isEmpty(value: any): boolean;
+interface IStorage {
+    set: (key: string, value: any, replace?: boolean) => any;
+    get: <T = any>(key: string) => T;
+    remove: (key: string) => void;
+    clear: () => void;
+}
+/**
+ * 本地存储，set存储时传入replace=true表示替换原来的字段，false则先获取原先字段并Object.assign来合并,prefix表示存储前缀，默认是hzw-
+ * @param type sessionStorage还是localStorage
+ * @returns Object {set:'存储方法',get:'获取方法'}
+ */
+declare function storageHandler(type?: string): IStorage;
+/**
+ * 合并对象参数,对象数据缺省传递时会自动补全属性值
+ * 如果旧对象有问题，返回新对象，反之返回旧对象
+ * 如果oldObj在newObj中对应属性为undefined，则使用oldObj对应属性值
+ * 否则如果oldObj属性为object，且则进行递归判断
+ * 其他情况下，比如oldObj和newObj类型不一致等，不做处理，以newObj为准
+ * 注意：newObj传递的null或0或空字符串与旧值不一致也会覆盖旧值
+ */
+declare function mergeObject<T>(oldObj: any, newObj: any): T;
+declare function debounce(fn: any, delay?: number): (...params: any[]) => void;
+declare function throttle(fn: any, delay?: number): (...params: any[]) => void;
+declare function clone<T>(source: any): T;
+declare function urlParser(url: string): Record<string, any> | undefined;
+/**
+ * 根据value查找对象的key
+ * @param obj object对象
+ * @param value 值
+ * @returns 键
+ */
+declare function objectKey(obj: Record<string, any>, value: any): string;
+/**
+ * 通用的创建下载链接的功能
+ * @param {Blob | string} res - 表示要下载的数据，可以是 Blob 对象或下载链接。
+ * @param {string} fileName - 下载文件的名称。
+ * @returns {void}
+ */
+declare function createDownloadLink(res: Blob | string, fileName: string): void;
+/**
+ * 从一维数组中的元素或者元素的属性中删除指定值
+ * @param arr
+ * @param find
+ * @param property
+ */
+declare function arrayDelete<T>(arr: T[], find: any, property?: string): void;
+declare function getAssetsFile(url: string): string;
+/**
+ * 初始化console日志,当浏览器url中输入?debug=1时,开启debug模式
+ * const log=logger('[PERMISSION]');
+ * log('test');
+ * @param prefix 日志前缀
+ * @param color 日志颜色
+ * @returns console日志
+ */
+declare function logger(prefix?: string, color?: string): ((...params: any[]) => void);
+declare function kebabCaseToCamelCase(str: string): string;
+/**
+ * 枚举或对象类型根据值获取key
+ * @param data enum或者object对象
+ * @param value
+ * @returns key
+ */
+declare function enumGetKeyByValue(data: any, value: any): string | undefined;
+declare function getByteLength(str: string): number;
+/**
+ * 代码修改逻辑后用户本地存储的数据不一致时，
+ * 可以修改package.json的version，此时会清除localStorage
+ */
+declare function clearLocalStorage(): void;
+declare function isNumeric(value: any): value is number | string;
+declare function encodeToLetters(str: string): string;
+declare function decodeFromLetters(encoded: string): string;
+declare function cls(classes: string[]): string;
+/**
+ * 手机号中间4位隐藏
+ * @param phone 手机号
+ * @returns 隐藏后的手机号
+ */
+declare function phoneHider(phone: string): string;
+export declare const utils: {
+    getConfig: typeof getConfig;
+    getType: typeof getType;
+    isJson: typeof isJson;
+    isEmpty: typeof isEmpty;
+    storageHandler: typeof storageHandler;
+    mergeObject: typeof mergeObject;
+    debounce: typeof debounce;
+    throttle: typeof throttle;
+    clone: typeof clone;
+    urlParser: typeof urlParser;
+    objectKey: typeof objectKey;
+    createDownloadLink: typeof createDownloadLink;
+    arrayDelete: typeof arrayDelete;
+    getAssetsFile: typeof getAssetsFile;
+    logger: typeof logger;
+    kebabCaseToCamelCase: typeof kebabCaseToCamelCase;
+    enumGetKeyByValue: typeof enumGetKeyByValue;
+    getByteLength: typeof getByteLength;
+    clearLocalStorage: typeof clearLocalStorage;
+    isNumeric: typeof isNumeric;
+    encodeToLetters: typeof encodeToLetters;
+    decodeFromLetters: typeof decodeFromLetters;
+    cls: typeof cls;
+    phoneHider: typeof phoneHider;
+    aes: {
+        encrypt(data: any, secretKey?: string): string;
+        decrypt(encryptedData: any, secretKey?: string): any;
+    };
+    storage: {
+        set: (key: string, value: any, replace?: boolean) => any;
+        get: <T = any>(key: string) => T;
+        remove: (key: string) => void;
+        clear: () => void;
+    };
+    session: {
+        set: (key: string, value: any, replace?: boolean) => any;
+        get: <T = any>(key: string) => T;
+        remove: (key: string) => void;
+        clear: () => void;
+    };
+};
+export {};

package/dist/ts/validators.d.ts

@@ -0,0 +1,29 @@
+declare function validatePhoneEmail(rule: any, value: any, callback: any): void;
+declare function validateEmail(rule: any, value: any, callback: any): void;
+declare function validateEmailAddress(rule: any, value: any, callback: any): void;
+declare function validatePassword(rule: any, value: any, callback: any): void;
+declare function validateCheckPass(rule: any, value: string, callback: any): void;
+declare function validatePhone(rule: any, value: any, callback: any): void;
+declare function validatePhoneNumber(rule: any, value: any, callback: any): void;
+declare function validateRealName(rule: string, value: string, callback: any): void;
+declare function validateZh(rule: any, value: any, callback: any): void;
+declare function validateEn(rule: any, value: any, callback: any): void;
+declare function validateResearchPlan(rule: any, value: any, callback: any): void;
+declare function validateUsername(rule: any, value: any, callback: any): void;
+declare function validatePasswordWithSymbol(rule: any, value: any, callback: any): void;
+export declare const validators: {
+    validatePhoneEmail: typeof validatePhoneEmail;
+    validateEmail: typeof validateEmail;
+    validateEmailAddress: typeof validateEmailAddress;
+    validatePassword: typeof validatePassword;
+    validateCheckPass: typeof validateCheckPass;
+    validatePhone: typeof validatePhone;
+    validatePhoneNumber: typeof validatePhoneNumber;
+    validateRealName: typeof validateRealName;
+    validateZh: typeof validateZh;
+    validateEn: typeof validateEn;
+    validateResearchPlan: typeof validateResearchPlan;
+    validateUsername: typeof validateUsername;
+    validatePasswordWithSymbol: typeof validatePasswordWithSymbol;
+};
+export {};

package/dist/types/global.d.ts

@@ -0,0 +1,188 @@
+/* eslint-disable */
+/* prettier-ignore */
+// @ts-nocheck
+// noinspection JSUnusedGlobalSymbols
+// Generated by unplugin-auto-import
+// biome-ignore lint: disable
+export {}
+declare global {
+  const ApiRequest: typeof import('../ts/request').ApiRequest
+  const EffectScope: typeof import('vue').EffectScope
+  const acceptHMRUpdate: typeof import('pinia').acceptHMRUpdate
+  const bem: typeof import('../ts/bem').bem
+  const computed: typeof import('vue').computed
+  const config: typeof import('../ts/config').config
+  const createApp: typeof import('vue').createApp
+  const createPinia: typeof import('pinia').createPinia
+  const css: typeof import('../ts/bem').css
+  const customRef: typeof import('vue').customRef
+  const defineAsyncComponent: typeof import('vue').defineAsyncComponent
+  const defineComponent: typeof import('vue').defineComponent
+  const defineStore: typeof import('pinia').defineStore
+  const effectScope: typeof import('vue').effectScope
+  const getActivePinia: typeof import('pinia').getActivePinia
+  const getCurrentInstance: typeof import('vue').getCurrentInstance
+  const getCurrentScope: typeof import('vue').getCurrentScope
+  const getCurrentWatcher: typeof import('vue').getCurrentWatcher
+  const h: typeof import('vue').h
+  const inject: typeof import('vue').inject
+  const isProxy: typeof import('vue').isProxy
+  const isReactive: typeof import('vue').isReactive
+  const isReadonly: typeof import('vue').isReadonly
+  const isRef: typeof import('vue').isRef
+  const isShallow: typeof import('vue').isShallow
+  const mapActions: typeof import('pinia').mapActions
+  const mapGetters: typeof import('pinia').mapGetters
+  const mapState: typeof import('pinia').mapState
+  const mapStores: typeof import('pinia').mapStores
+  const mapWritableState: typeof import('pinia').mapWritableState
+  const markRaw: typeof import('vue').markRaw
+  const nextTick: typeof import('vue').nextTick
+  const onActivated: typeof import('vue').onActivated
+  const onBeforeMount: typeof import('vue').onBeforeMount
+  const onBeforeUnmount: typeof import('vue').onBeforeUnmount
+  const onBeforeUpdate: typeof import('vue').onBeforeUpdate
+  const onDeactivated: typeof import('vue').onDeactivated
+  const onErrorCaptured: typeof import('vue').onErrorCaptured
+  const onMounted: typeof import('vue').onMounted
+  const onRenderTracked: typeof import('vue').onRenderTracked
+  const onRenderTriggered: typeof import('vue').onRenderTriggered
+  const onScopeDispose: typeof import('vue').onScopeDispose
+  const onServerPrefetch: typeof import('vue').onServerPrefetch
+  const onUnmounted: typeof import('vue').onUnmounted
+  const onUpdated: typeof import('vue').onUpdated
+  const onWatcherCleanup: typeof import('vue').onWatcherCleanup
+  const provide: typeof import('vue').provide
+  const reactive: typeof import('vue').reactive
+  const readonly: typeof import('vue').readonly
+  const ref: typeof import('vue').ref
+  const reg: typeof import('../ts/reg').reg
+  const request: typeof import('../ts/request').request
+  const resolveComponent: typeof import('vue').resolveComponent
+  const setActivePinia: typeof import('pinia').setActivePinia
+  const setMapStoreSuffix: typeof import('pinia').setMapStoreSuffix
+  const shallowReactive: typeof import('vue').shallowReactive
+  const shallowReadonly: typeof import('vue').shallowReadonly
+  const shallowRef: typeof import('vue').shallowRef
+  const storeToRefs: typeof import('pinia').storeToRefs
+  const toRaw: typeof import('vue').toRaw
+  const toRef: typeof import('vue').toRef
+  const toRefs: typeof import('vue').toRefs
+  const toValue: typeof import('vue').toValue
+  const triggerRef: typeof import('vue').triggerRef
+  const unref: typeof import('vue').unref
+  const useAttrs: typeof import('vue').useAttrs
+  const useCssModule: typeof import('vue').useCssModule
+  const useCssVars: typeof import('vue').useCssVars
+  const useId: typeof import('vue').useId
+  const useModel: typeof import('vue').useModel
+  const useSlots: typeof import('vue').useSlots
+  const useTemplateRef: typeof import('vue').useTemplateRef
+  const utils: typeof import('../ts/utils').utils
+  const validators: typeof import('../ts/validators').validators
+  const watch: typeof import('vue').watch
+  const watchEffect: typeof import('vue').watchEffect
+  const watchPostEffect: typeof import('vue').watchPostEffect
+  const watchSyncEffect: typeof import('vue').watchSyncEffect
+}
+// for type re-export
+declare global {
+  // @ts-ignore
+  export type { Component, Slot, Slots, ComponentPublicInstance, ComputedRef, DirectiveBinding, ExtractDefaultPropTypes, ExtractPropTypes, ExtractPublicPropTypes, InjectionKey, PropType, Ref, ShallowRef, MaybeRef, MaybeRefOrGetter, VNode, WritableComputedRef } from 'vue'
+  import('vue')
+  // @ts-ignore
+  export type { IBem, IBemCss } from '../ts/bem'
+  import('../ts/bem')
+  // @ts-ignore
+  export type { GConfig } from '../ts/config'
+  import('../ts/config')
+  // @ts-ignore
+  export type { ApiRequest, IRequestConfig } from '../ts/request'
+  import('../ts/request')
+}
+
+// for vue template auto import
+import { UnwrapRef } from 'vue'
+declare module 'vue' {
+  interface GlobalComponents {}
+  interface ComponentCustomProperties {
+    readonly ApiRequest: UnwrapRef<typeof import('../ts/request')['ApiRequest']>
+    readonly EffectScope: UnwrapRef<typeof import('vue')['EffectScope']>
+    readonly acceptHMRUpdate: UnwrapRef<typeof import('pinia')['acceptHMRUpdate']>
+    readonly bem: UnwrapRef<typeof import('../ts/bem')['bem']>
+    readonly computed: UnwrapRef<typeof import('vue')['computed']>
+    readonly config: UnwrapRef<typeof import('../ts/config')['config']>
+    readonly createApp: UnwrapRef<typeof import('vue')['createApp']>
+    readonly createPinia: UnwrapRef<typeof import('pinia')['createPinia']>
+    readonly css: UnwrapRef<typeof import('../ts/bem')['css']>
+    readonly customRef: UnwrapRef<typeof import('vue')['customRef']>
+    readonly defineAsyncComponent: UnwrapRef<typeof import('vue')['defineAsyncComponent']>
+    readonly defineComponent: UnwrapRef<typeof import('vue')['defineComponent']>
+    readonly defineStore: UnwrapRef<typeof import('pinia')['defineStore']>
+    readonly effectScope: UnwrapRef<typeof import('vue')['effectScope']>
+    readonly getActivePinia: UnwrapRef<typeof import('pinia')['getActivePinia']>
+    readonly getCurrentInstance: UnwrapRef<typeof import('vue')['getCurrentInstance']>
+    readonly getCurrentScope: UnwrapRef<typeof import('vue')['getCurrentScope']>
+    readonly getCurrentWatcher: UnwrapRef<typeof import('vue')['getCurrentWatcher']>
+    readonly h: UnwrapRef<typeof import('vue')['h']>
+    readonly inject: UnwrapRef<typeof import('vue')['inject']>
+    readonly isProxy: UnwrapRef<typeof import('vue')['isProxy']>
+    readonly isReactive: UnwrapRef<typeof import('vue')['isReactive']>
+    readonly isReadonly: UnwrapRef<typeof import('vue')['isReadonly']>
+    readonly isRef: UnwrapRef<typeof import('vue')['isRef']>
+    readonly isShallow: UnwrapRef<typeof import('vue')['isShallow']>
+    readonly mapActions: UnwrapRef<typeof import('pinia')['mapActions']>
+    readonly mapGetters: UnwrapRef<typeof import('pinia')['mapGetters']>
+    readonly mapState: UnwrapRef<typeof import('pinia')['mapState']>
+    readonly mapStores: UnwrapRef<typeof import('pinia')['mapStores']>
+    readonly mapWritableState: UnwrapRef<typeof import('pinia')['mapWritableState']>
+    readonly markRaw: UnwrapRef<typeof import('vue')['markRaw']>
+    readonly nextTick: UnwrapRef<typeof import('vue')['nextTick']>
+    readonly onActivated: UnwrapRef<typeof import('vue')['onActivated']>
+    readonly onBeforeMount: UnwrapRef<typeof import('vue')['onBeforeMount']>
+    readonly onBeforeUnmount: UnwrapRef<typeof import('vue')['onBeforeUnmount']>
+    readonly onBeforeUpdate: UnwrapRef<typeof import('vue')['onBeforeUpdate']>
+    readonly onDeactivated: UnwrapRef<typeof import('vue')['onDeactivated']>
+    readonly onErrorCaptured: UnwrapRef<typeof import('vue')['onErrorCaptured']>
+    readonly onMounted: UnwrapRef<typeof import('vue')['onMounted']>
+    readonly onRenderTracked: UnwrapRef<typeof import('vue')['onRenderTracked']>
+    readonly onRenderTriggered: UnwrapRef<typeof import('vue')['onRenderTriggered']>
+    readonly onScopeDispose: UnwrapRef<typeof import('vue')['onScopeDispose']>
+    readonly onServerPrefetch: UnwrapRef<typeof import('vue')['onServerPrefetch']>
+    readonly onUnmounted: UnwrapRef<typeof import('vue')['onUnmounted']>
+    readonly onUpdated: UnwrapRef<typeof import('vue')['onUpdated']>
+    readonly onWatcherCleanup: UnwrapRef<typeof import('vue')['onWatcherCleanup']>
+    readonly provide: UnwrapRef<typeof import('vue')['provide']>
+    readonly reactive: UnwrapRef<typeof import('vue')['reactive']>
+    readonly readonly: UnwrapRef<typeof import('vue')['readonly']>
+    readonly ref: UnwrapRef<typeof import('vue')['ref']>
+    readonly reg: UnwrapRef<typeof import('../ts/reg')['reg']>
+    readonly request: UnwrapRef<typeof import('../ts/request')['request']>
+    readonly resolveComponent: UnwrapRef<typeof import('vue')['resolveComponent']>
+    readonly setActivePinia: UnwrapRef<typeof import('pinia')['setActivePinia']>
+    readonly setMapStoreSuffix: UnwrapRef<typeof import('pinia')['setMapStoreSuffix']>
+    readonly shallowReactive: UnwrapRef<typeof import('vue')['shallowReactive']>
+    readonly shallowReadonly: UnwrapRef<typeof import('vue')['shallowReadonly']>
+    readonly shallowRef: UnwrapRef<typeof import('vue')['shallowRef']>
+    readonly storeToRefs: UnwrapRef<typeof import('pinia')['storeToRefs']>
+    readonly toRaw: UnwrapRef<typeof import('vue')['toRaw']>
+    readonly toRef: UnwrapRef<typeof import('vue')['toRef']>
+    readonly toRefs: UnwrapRef<typeof import('vue')['toRefs']>
+    readonly toValue: UnwrapRef<typeof import('vue')['toValue']>
+    readonly triggerRef: UnwrapRef<typeof import('vue')['triggerRef']>
+    readonly unref: UnwrapRef<typeof import('vue')['unref']>
+    readonly useAttrs: UnwrapRef<typeof import('vue')['useAttrs']>
+    readonly useCssModule: UnwrapRef<typeof import('vue')['useCssModule']>
+    readonly useCssVars: UnwrapRef<typeof import('vue')['useCssVars']>
+    readonly useId: UnwrapRef<typeof import('vue')['useId']>
+    readonly useModel: UnwrapRef<typeof import('vue')['useModel']>
+    readonly useSlots: UnwrapRef<typeof import('vue')['useSlots']>
+    readonly useTemplateRef: UnwrapRef<typeof import('vue')['useTemplateRef']>
+    readonly utils: UnwrapRef<typeof import('../ts/utils')['utils']>
+    readonly validators: UnwrapRef<typeof import('../ts/validators')['validators']>
+    readonly watch: UnwrapRef<typeof import('vue')['watch']>
+    readonly watchEffect: UnwrapRef<typeof import('vue')['watchEffect']>
+    readonly watchPostEffect: UnwrapRef<typeof import('vue')['watchPostEffect']>
+    readonly watchSyncEffect: UnwrapRef<typeof import('vue')['watchSyncEffect']>
+  }
+}

package/dist/types/index.d.ts

@@ -0,0 +1,24 @@
+/**
+ * 通用接口返回,status是状态码,message一般请求错误会返回信息,data是具体返回数据
+ */
+declare interface GRes<T> {
+  message: string
+  status: number
+  data: T
+}
+/**
+ * 通用分页接口返回,在通用接口返回基础上数据格式细分了分页信息
+ * records是数据的数组,total是数据总量,size是每页数据数量
+ */
+declare type GRecords<T> = GRes<{ records: T[], total: number, size: number }>
+declare interface GOption<T> {
+  label: string
+  value: T
+  disabled?: boolean
+}
+declare interface GKeyValue<T> {
+  key: string
+  value: T
+}
+declare module '*.js'
+declare module '*.vue'

package/dist/types/window.d.ts

@@ -0,0 +1,13 @@
+import type { GConfig } from '../ts/config'
+
+declare global {
+  interface Window {
+    config: GConfig
+    bem: typeof bem
+    css: IBemCss
+    utils: typeof utils
+    reg: typeof reg
+    validators: typeof validators
+    request: typeof request
+  }
+}

package/dist/vite.d.ts

@@ -0,0 +1,30 @@
+declare module '@hzwtech.com/utils/dist/vite' {
+  import type { Options as AutoImportOptions } from 'unplugin-auto-import/types'
+  import type { Plugin } from 'vite'
+
+  export interface ScssOptions {
+    additionalData: string
+    [key: string]: any
+  }
+
+  /**
+   * Configure unplugin-auto-import for Vite
+   * @param options - Configuration options
+   */
+  export function autoImport(options?: Partial<AutoImportOptions>): Plugin
+
+  /**
+   * SCSS configuration options
+   */
+  export function scss(opt?: ScssOptions): ScssOptions
+
+  /**
+   * Default export containing both autoImport and scss
+   */
+  const viteConfig: {
+    autoImport: typeof autoImport
+    scss: typeof scss
+  }
+
+  export default viteConfig
+}

package/dist/vite.js

@@ -0,0 +1,42 @@
+import process from 'node:process'
+import AutoImportVite from 'unplugin-auto-import/vite'
+
+function scss(options) {
+  let additionalData = ''
+  if (options && options.additionalData) {
+    additionalData = options.additionalData
+  }
+  return {
+    additionalData: `
+    @use "@hzwtech.com/utils/dist/styles/reference/index.scss" as *;
+    ${additionalData}
+    `,
+    ...options,
+  }
+}
+function autoImport(options) {
+  const { mode } = process.env
+  const isPublish = mode === 'publish'
+  const optDefault = {
+    imports: ['pinia', 'vue'],
+    eslintrc: {
+      enabled: true,
+      globalsPropValue: 'writable',
+    },
+    vueTemplate: true,
+    dirs: ['./src/ts'],
+    dts: isPublish ? './src/types/global.d.ts' : false,
+    dtsMode: 'overwrite',
+  }
+
+  if (!isPublish && !optDefault.imports.includes('@hzwtech.com/utils')) {
+    optDefault.imports.push({ '@hzwtech.com/utils': ['utils', 'css', 'bem'] })
+  }
+  const opt = Object.assign({}, optDefault, options)
+  return AutoImportVite(opt)
+}
+
+export default {
+  autoImport,
+  scss,
+}

package/eslint.config.mjs

@@ -0,0 +1,3 @@
+import eslint from './src/js/eslint.js'
+
+export default eslint()

package/index.html

@@ -0,0 +1,12 @@
+<!doctype html>
+<html lang="en">
+  <head>
+    <meta charset="UTF-8" />
+    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+    <title>dev</title>
+  </head>
+  <body>
+    <div id="app"></div>
+    <script type="module" src="/src/main.ts"></script>
+  </body>
+</html>

package/package.json

@@ -0,0 +1,56 @@
+{
+  "name": "@hzw-tech/utils",
+  "type": "module",
+  "version": "0.0.1",
+  "description": "通用前端工具包，包含请求,正则校验,全局ts声明等",
+  "author": "hzw-tech",
+  "license": "MIT",
+  "keywords": [
+    "typescript",
+    "bem",
+    "reg",
+    "utils"
+  ],
+  "main": "dist/index.js",
+  "module": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "scripts": {
+    "start": "cross-env mode=publish vite --host --port 9999",
+    "build": "rimraf dist && pnpm run sass && pnpm run build-rollup",
+    "build-rollup": "cross-env mode=publish rollup -c",
+    "build-ts": "tsc && tsc --module esnext",
+    "sass": "sass src/styles:src/styles",
+    "release": "npm publish --access public",
+    "lint": "eslint --fix src/**/*.ts"
+  },
+  "peerDependencies": {
+    "@antfu/eslint-config": "^6.1.0",
+    "eslint-plugin-format": "^1.0.2",
+    "sass": "^1.93.3",
+    "unplugin-auto-import": "^20.2.0",
+    "vue": "^3.5.18",
+    "typescript": "^5.7.3",
+    "pinia": "^3.0.3",
+    "axios": "^1.11.0",
+    "crypto-js": "^4.2.0",
+    "element-plus": "^2.10.5",
+    "vite": "^7.0.6"
+  },
+  "dependencies": {
+    "@vitejs/plugin-vue": "^6.0.1",
+    "json-bigint": "^1.0.0"
+  },
+  "devDependencies": {
+    "@rollup/plugin-commonjs": "^28.0.2",
+    "@rollup/plugin-node-resolve": "^16.0.0",
+    "@rollup/plugin-terser": "^0.4.4",
+    "@rollup/plugin-typescript": "^12.1.2",
+    "@types/crypto-js": "^4.2.2",
+    "@types/json-bigint": "^1.0.4",
+    "cross-env": "^10.1.0",
+    "rimraf": "^6.0.1",
+    "rollup": "^4.34.4",
+    "rollup-plugin-copy": "^3.5.0",
+    "tslib": "^2.8.1"
+  }
+}

package/readme.md

@@ -0,0 +1,115 @@
+# @hzw-tech/utils
+
+简称ftw，ts前端工具包，包含常用css类以及ts工具方法等。
+
+## 1.安装
+
+```bash
+pnpm i @hzw-tech/utils
+// 或
+yarn add @hzw-tech/utils
+```
+
+## 2.使用
+
+### vue项目使用
+
+main.ts文件中：
+
+```ts
+import hzwUtils from '@hzw-tech/utils'
+import { createPinia } from 'pinia'
+import { createApp } from 'vue'
+import App from './App.vue'
+import '@hzw-tech/utils/dist/styles/index.scss'// 引入全局样式文件
+
+const app = createApp(App)
+app.use(router)
+app.mount('#app')
+app.use(hzwUtils, { storage: { prefix: 'hzw' } })
+```
+
+之后可以在ts文件和vue中使用bem，utils等工具方法，比如
+
+```html
+<template>
+  <h1 :class="[css.bm('color', 'red')]">132</h1>
+</template>
+<script>
+  console.log('aes:', utils.aes.encrypt('test'))
+</script>
+
+```
+
+### ts支持
+
+在项目的tsconfig.json中将@hzw-tech/utils相关ts声明文件加入到types中，这样可以在ts中获得类型提示
+
+```json
+{
+  "compilerOptions": {
+    "types": ["@hzw-tech/utils/dist/types/index", "@hzw-tech/utils/dist/types/global"]
+  }
+}
+```
+
+### vite配置
+
+在vite中配置autoImport后，会将ftw的相关方法注入到ts和vue文件中
+
+```ts
+import vite from '@hzw-tech/utils/dist/vite'
+import vue from '@vitejs/plugin-vue'
+import { defineConfig } from 'vite'
+
+// https://vite.dev/config/
+export default defineConfig({
+  plugins: [vue(), vite.autoImport()],
+  css: {
+    preprocessorOptions: {
+      // 引入通用的全局mixin和变量
+      scss: vite.scss(),
+    },
+  },
+})
+```
+
+### 主题修改，自定义scss变量
+
+1.新建一个scss文件，比如src/styles/index.scss，内容如下：
+
+```scss
+@forward '@hzw-tech/utils/dist/styles/reference/config.scss' with (
+  $colors: (
+    'red': blue,
+    //你的自定义变量
+  )
+);
+@forward '@hzw-tech/utils/dist/styles/reference/index.scss';
+
+```
+
+2.修改vite中全局变量以及mixins的引用
+
+```ts
+{
+  css: {
+    // https://vitejs.dev/config/shared-options.html#css-preprocessoroptions
+    preprocessorOptions: {
+      scss: {
+        additionalData: '@use "@/styles/index.scss" as *;'
+      }
+    }
+  }
+}
+```
+
+## 3.工具列表
+
+[bem](./dist/ts/bem.d.ts)
+[reg](./dist/ts/reg.d.ts)
+[request](./dist/ts/request.d.ts)
+[validators](./dist/ts/validators.d.ts)
+[utils](./dist/ts/utils.d.ts)
+
+[通用样式大全](./dist/styles/index.css)