twcpt 0.0.2

package/dist/utils/helper/url.d.ts

@@ -0,0 +1,259 @@
+/**
+ * URL 处理工具函数
+ */
+/**
+ * 解析 URL 参数为对象
+ * @param url URL 字符串，默认为当前页面 URL
+ * @returns 参数对象
+ * @example
+ * parseQuery('?name=Tom&age=20')
+ * // { name: 'Tom', age: '20' }
+ *
+ * parseQuery('http://example.com?name=Tom&age=20')
+ * // { name: 'Tom', age: '20' }
+ */
+export declare function parseQuery(url?: string): Record<string, string | string[]>;
+/**
+ * 对象转 URL 参数字符串
+ * @param params 参数对象
+ * @returns URL 参数字符串（不包含 ?）
+ * @example
+ * stringifyQuery({ name: 'Tom', age: 20 })
+ * // 'name=Tom&age=20'
+ *
+ * stringifyQuery({ tags: ['a', 'b', 'c'] })
+ * // 'tags=a&tags=b&tags=c'
+ */
+export declare function stringifyQuery(params: Record<string, any>): string;
+/**
+ * 获取 URL 指定参数的值
+ * @param key 参数名
+ * @param url URL 字符串，默认为当前页面 URL
+ * @returns 参数值，不存在返回 null
+ * @example
+ * getQueryParam('name', '?name=Tom&age=20')
+ * // 'Tom'
+ */
+export declare function getQueryParam(key: string, url?: string): string | null;
+/**
+ * 获取 URL 所有同名参数的值（数组）
+ * @param key 参数名
+ * @param url URL 字符串，默认为当前页面 URL
+ * @returns 参数值数组
+ * @example
+ * getQueryParams('tags', '?tags=a&tags=b&tags=c')
+ * // ['a', 'b', 'c']
+ */
+export declare function getQueryParams(key: string, url?: string): string[];
+/**
+ * 更新 URL 参数（不刷新页面）
+ * @param params 要更新的参数对象
+ * @param mode 更新模式：'push' 添加历史记录，'replace' 替换当前记录
+ * @example
+ * updateQueryParams({ name: 'Tom', age: 20 }, 'push')
+ */
+export declare function updateQueryParams(params: Record<string, any>, mode?: 'push' | 'replace'): void;
+/**
+ * 删除 URL 指定参数（不刷新页面）
+ * @param keys 要删除的参数名数组
+ * @param mode 更新模式：'push' 添加历史记录，'replace' 替换当前记录
+ * @example
+ * removeQueryParams(['name', 'age'], 'replace')
+ */
+export declare function removeQueryParams(keys: string[], mode?: 'push' | 'replace'): void;
+/**
+ * 清空所有 URL 参数（不刷新页面）
+ * @param mode 更新模式：'push' 添加历史记录，'replace' 替换当前记录
+ * @example
+ * clearQueryParams('replace')
+ */
+export declare function clearQueryParams(mode?: 'push' | 'replace'): void;
+/**
+ * 拼接 URL（自动处理斜杠）
+ * @param parts URL 片段数组
+ * @returns 拼接后的 URL
+ * @example
+ * joinUrl('http://example.com/', '/api/', 'users/', '123')
+ * // 'http://example.com/api/users/123'
+ */
+export declare function joinUrl(...parts: string[]): string;
+/**
+ * 解析 URL 为各个组成部分
+ * @param url URL 字符串
+ * @returns URL 各部分的对象
+ * @example
+ * parseUrl('https://user:pass@example.com:8080/path?query=1#hash')
+ * // {
+ * //   protocol: 'https:',
+ * //   username: 'user',
+ * //   password: 'pass',
+ * //   hostname: 'example.com',
+ * //   port: '8080',
+ * //   pathname: '/path',
+ * //   search: '?query=1',
+ * //   hash: '#hash',
+ * //   host: 'example.com:8080',
+ * //   origin: 'https://example.com:8080',
+ * //   href: 'https://user:pass@example.com:8080/path?query=1#hash'
+ * // }
+ */
+export declare function parseUrl(url: string): {
+    protocol: string;
+    username: string;
+    password: string;
+    hostname: string;
+    port: string;
+    pathname: string;
+    search: string;
+    hash: string;
+    host: string;
+    origin: string;
+    href: string;
+    params: Record<string, string | string[]>;
+};
+/**
+ * 构建 URL
+ * @param options URL 各部分配置
+ * @returns 完整的 URL 字符串
+ * @example
+ * buildUrl({
+ *   protocol: 'https',
+ *   hostname: 'example.com',
+ *   pathname: '/api/users',
+ *   params: { page: 1, size: 10 }
+ * })
+ * // 'https://example.com/api/users?page=1&size=10'
+ */
+export declare function buildUrl(options: {
+    protocol?: string;
+    hostname?: string;
+    port?: string | number;
+    pathname?: string;
+    params?: Record<string, any>;
+    hash?: string;
+}): string;
+/**
+ * 判断是否为外部链接（http/https 开头）
+ * @param url URL 字符串
+ * @returns 是否为外部链接
+ * @example
+ * isExternalLink('https://example.com')
+ * // true
+ * isExternalLink('/path/to/page')
+ * // false
+ */
+export declare function isExternalLink(url: string): boolean;
+/**
+ * 判断是否为绝对路径
+ * @param url URL 字符串
+ * @returns 是否为绝对路径
+ * @example
+ * isAbsolutePath('/path/to/page')
+ * // true
+ * isAbsolutePath('path/to/page')
+ * // false
+ */
+export declare function isAbsolutePath(url: string): boolean;
+/**
+ * 判断两个 URL 是否同源
+ * @param url1 URL 1
+ * @param url2 URL 2
+ * @returns 是否同源
+ * @example
+ * isSameOrigin('https://example.com/a', 'https://example.com/b')
+ * // true
+ * isSameOrigin('https://example.com', 'https://other.com')
+ * // false
+ */
+export declare function isSameOrigin(url1: string, url2: string): boolean;
+/**
+ * 编码 URL 参数值
+ * @param value 参数值
+ * @returns 编码后的值
+ * @example
+ * encodeParam('hello world')
+ * // 'hello%20world'
+ */
+export declare function encodeParam(value: string): string;
+/**
+ * 解码 URL 参数值
+ * @param value 编码的参数值
+ * @returns 解码后的值
+ * @example
+ * decodeParam('hello%20world')
+ * // 'hello world'
+ */
+export declare function decodeParam(value: string): string;
+/**
+ * 安全编码 URL（处理已编码的情况）
+ * @param url URL 字符串
+ * @returns 编码后的 URL
+ */
+export declare function safeEncodeUrl(url: string): string;
+/**
+ * 安全解码 URL（处理未编码的情况）
+ * @param url 编码的 URL 字符串
+ * @returns 解码后的 URL
+ */
+export declare function safeDecodeUrl(url: string): string;
+/**
+ * 添加 URL 参数
+ * @param url 原始 URL
+ * @param params 要添加的参数
+ * @returns 添加参数后的 URL
+ * @example
+ * addQueryParams('http://example.com/api', { page: 1, size: 10 })
+ * // 'http://example.com/api?page=1&size=10'
+ *
+ * addQueryParams('http://example.com/api?id=1', { page: 1 })
+ * // 'http://example.com/api?id=1&page=1'
+ */
+export declare function addQueryParams(url: string, params: Record<string, any>): string;
+/**
+ * 移除 URL 中的指定参数
+ * @param url 原始 URL
+ * @param keys 要移除的参数名数组
+ * @returns 移除参数后的 URL
+ * @example
+ * removeQueryParamsFromUrl('http://example.com?a=1&b=2&c=3', ['b', 'c'])
+ * // 'http://example.com?a=1'
+ */
+export declare function removeQueryParamsFromUrl(url: string, keys: string[]): string;
+/**
+ * 获取 URL 的域名
+ * @param url URL 字符串
+ * @returns 域名
+ * @example
+ * getDomain('https://www.example.com/path')
+ * // 'www.example.com'
+ */
+export declare function getDomain(url: string): string;
+/**
+ * 获取 URL 的根域名（不含子域名）
+ * @param url URL 字符串
+ * @returns 根域名
+ * @example
+ * getRootDomain('https://www.example.com/path')
+ * // 'example.com'
+ */
+export declare function getRootDomain(url: string): string;
+/**
+ * 获取当前页面的完整 URL
+ * @returns 当前页面 URL
+ */
+export declare function getCurrentUrl(): string;
+/**
+ * 获取当前页面的路径（不含域名和参数）
+ * @returns 当前页面路径
+ */
+export declare function getCurrentPath(): string;
+/**
+ * 获取当前页面的查询参数
+ * @returns 查询参数对象
+ */
+export declare function getCurrentQuery(): Record<string, string | string[]>;
+/**
+ * 获取当前页面的 Hash
+ * @returns Hash 值（不含 #）
+ */
+export declare function getCurrentHash(): string;

package/dist/utils/icon-map.d.ts

@@ -0,0 +1,19 @@
+export type IconMapResult = {
+    icon: string;
+} | {
+    cls: string;
+    content?: string;
+};
+export type IconMapFn = (iconName: string) => IconMapResult | void;
+/**
+ * twcpt 内置图标映射函数（基于 src/utils/custom-svg.ts 的 base64 svg）。
+ *
+ * 匹配策略（多候选 key）：
+ * - 带/不带 `app:` 前缀
+ * - 原样/小写
+ */
+export declare const twcptIconMapFn: IconMapFn;
+/**
+ * 组合多个 iconMapFn：按顺序尝试，谁先返回结果就用谁的。
+ */
+export declare function composeIconMapFn(...fns: Array<IconMapFn | undefined | null>): IconMapFn;

package/dist/utils/init.d.ts

@@ -0,0 +1,35 @@
+import { App, Ref, InjectionKey } from 'vue';
+import { default as defaultColors } from '../config/colors.json';
+import { Locale } from '../composables/useI18n';
+export declare const PAGE_PERMISSION_KEY: InjectionKey<Ref<string[]>>;
+export declare const PAGE_ACTION_PERMISSION_KEY: InjectionKey<Ref<string[]>>;
+export type ColorConfig = Partial<typeof defaultColors>;
+export interface TWcptInitOptions {
+    app: App;
+    router?: any;
+    store?: any;
+    i18n?: any;
+    pagePermissionIds?: Ref<string[]> | string[];
+    pageActionPermissionIds?: Ref<string[]> | string[];
+    defaultLanguage?: Locale;
+    colors?: ColorConfig;
+    disableBFCache?: boolean;
+}
+/**
+ * 初始化 twcpt 组件库
+ * @param options 初始化配置选项
+ * @example
+ * ```typescript
+ * import { createApp } from 'vue';
+ * import { twcptInit } from 'twcpt';
+ *
+ * const app = createApp(App);
+ * twcptInit({
+ *   app,
+ *   defaultLanguage: 'en-US',
+ *   colors: { primary: '#FF5722' },
+ *   disableBFCache: true,
+ * });
+ * ```
+ */
+export declare function twcptInit(options: TWcptInitOptions): void;

package/dist/utils/resolver.d.ts

@@ -0,0 +1,34 @@
+import { ComponentResolver } from 'unplugin-vue-components/types';
+/**
+ * Resolver for twcpt components
+ * Automatically imports twcpt components (JTW*, JC*, JCh*) when used in templates
+ *
+ * @example
+ * ```ts
+ * import { twcptResolver } from 'twcpt/resolver'
+ *
+ * // in vite.config.ts
+ * Components({
+ *   resolvers: [twcptResolver()]
+ * })
+ * ```
+ */
+export declare function twcptResolver(): ComponentResolver;
+/**
+ * Options for twcptResolver
+ */
+export interface TwcptResolverOptions {
+    /**
+     * Exclude components that should not be auto-imported
+     * @example ['JTWBtn', 'JCTable']
+     */
+    exclude?: string[];
+    /**
+     * Prefix for component resolution (default: none, matches JTW*, JC*, JCh*)
+     */
+    prefix?: string;
+}
+/**
+ * Configurable resolver for twcpt components
+ */
+export declare function twcptResolverWithOptions(options?: TwcptResolverOptions): ComponentResolver;

package/dist/utils/storage.d.ts

@@ -0,0 +1,3 @@
+export declare const getThirdComponentState: () => string | null;
+export declare const setThirdComponentState: (data: any) => void;
+export declare const removeThirdComponentState: () => void;

package/dist/utils/storageSync.d.ts

@@ -0,0 +1,20 @@
+import { Ref } from 'vue';
+/**
+ * 创建一个与 localStorage 同步的响应式 ref
+ * 支持跨标签页同步（通过 storage 事件）
+ *
+ * @param key - localStorage 的 key
+ * @param initialValue - 初始值
+ * @param serializer - 序列化函数（将值转为字符串存储）
+ * @param deserializer - 反序列化函数（从字符串读取值）
+ * @returns 响应式 ref
+ */
+export declare function useLocalStorageSync<T>(key: string, initialValue: T, serializer?: (value: T) => string, deserializer?: (value: string) => T): Ref<T>;
+/**
+ * 创建与 localStorage 同步的页面权限 ID ref
+ */
+export declare function usePagePermissionSync(key: string): Ref<string[]>;
+/**
+ * 创建与 localStorage 同步的页面操作权限 ID ref
+ */
+export declare function usePageActionPermissionSync(key: string): Ref<string[]>;

package/dist/utils/tool.d.ts

@@ -0,0 +1,103 @@
+/**
+ * 格式化数据
+ * 把数字转成指定单位
+ */
+type TSizeUnit = 'B' | 'KB' | 'MB' | 'GB' | 'TB';
+/**
+ * 默认填充函数，处理 falsy 值
+ * @param val 要处理的值
+ * @returns 默认填充的字符串
+ */
+export declare function defaultFill(val: any): any;
+export declare function formatSize(options: {
+    maxUnit?: TSizeUnit;
+    numberFormatOptions?: Intl.NumberFormatOptions;
+    size: number;
+    unit?: TSizeUnit;
+}): string;
+export declare function getUpperSize(sizeUnit: {
+    size: number;
+    unit?: TSizeUnit;
+}, options?: {
+    maxUnit?: TSizeUnit;
+}): {
+    size: number;
+    unit: TSizeUnit;
+};
+/**
+ *
+ * 1. 先检查值是不是数字0或字符串'0'，是的话就应用格式化或返回原值，保留0
+ * 2. 再检查其他所有当空白处理的 falsy 值 (null, undefined, '', false, NaN)
+ * 3. 否则应用可选的自定义格式化函数
+ *
+ * @param customFormatter 可选的自定义格式化函数
+ * @param fallbackValue 默认的替代值，默认是 '-'
+ * @returns QTable columns 接受的格式化函数
+ */
+export declare function defaultFormat(customFormatter?: (val: any, row: any) => string | number, fallbackValue?: string): (val: any, row: any) => any;
+/**
+ * 可接受的日期输入类型
+ */
+export type DateInput = Date | string | number;
+/**
+ * 日期格式化字符串类型
+ * 支持的格式标记：YYYY YY MM M DD D HH H hh h mm m ss s SSS SS S A a
+ */
+export type DateFormatString = string;
+/**
+ * 格式化日期/时间戳的工具函数。
+ * * 示例:
+ * formatDate(Date.now(), 'YYYY-MM-DD HH:mm:ss')
+ * formatDate('2025-11-13T23:00:57.123Z', 'YYYY年MM月DD日')
+ * * @param dateInput 要格式化的日期或时间戳。
+ * @param dateInput
+ * @param formatString 格式化字符串 (例如 'YYYY-MM-DD HH:mm:ss.SSS')。
+ * @returns 格式化后的日期字符串。
+ */
+export declare function formatDate(dateInput: DateInput, formatString?: DateFormatString): string;
+/**
+ *
+ * 结合 defaultFormat 的空值处理逻辑和 formatDate 的日期格式化功能
+ * 1. 先检查值是不是数字0或字符串'0'，是的话就返回原值，保留0
+ * 2. 再检查其他所有当空白处理的 falsy 值 (null, undefined, '', false, NaN)
+ * 3. 否则应用 formatDate 进行格式化
+ *
+ * @param formatString 格式化字符串 (例如 'YYYY-MM-DD HH:mm:ss')
+ * @param fallbackValue 默认的替代值，默认是 '-'
+ * @returns QTable columns 接受的格式化函数
+ */
+export declare function defaultDateFormat(formatString?: DateFormatString, fallbackValue?: string): (val: DateInput | null | undefined, _row: any) => string;
+/**
+ * 流量数据格式化函数：
+ * 1. 用 defaultFormat 处理 falsy 值，显示 '-'，0 除外
+ * 2. 用 formatSize 进行流量单位转换，默认从 B 开始转换
+ */
+export declare function defaultDataFormat(fallbackValue?: string, options?: {
+    digits?: number;
+    unit?: TSizeUnit;
+}): (val: any, row: any) => any;
+/**
+ * 流量数据格式化函数2，输入如果是 【unit】/ 1024 是整数，则转换为父级的单位，如果不是整数，则保留当前单位。
+ * 1. 使用 defaultFormat 处理 falsy 值 (显示 '-'，0 除外)。
+ * 2. 智能单位转换：如果值能被 1024 整除，自动向上转换单位（MB → GB → TB）。
+ * 3. 如果不能整除，保持原始单位。
+ */
+export declare function defaultAutoDataFormat(fallbackValue?: string, options?: {
+    digits?: number;
+    unit?: TSizeUnit;
+}): (val: any, row: any) => any;
+/**
+ * 流量单位转换函数，支持 B、KB、MB、GB、TB 之间的任意转换
+ * @param value 要转换的数值
+ * @param fromUnit 源单位
+ * @param toUnit 目标单位
+ * @param options 配置项
+ * @param options.digits 保留小数位数，默认为 2
+ * @param options.showUnit 是否显示单位，默认为 true
+ * @returns 转换后的字符串或数字
+ */
+export declare function convertDataUnit(value: number | string, fromUnit: TSizeUnit, toUnit: TSizeUnit, options?: {
+    digits?: number;
+    showUnit?: boolean;
+}): string | number;
+export { setTitleAndLogo, getTitle, getNavLogo } from './website-config';

package/dist/utils/website-config.d.ts

@@ -0,0 +1,15 @@
+/**
+ * 根据域名修改网页的标签栏logo
+ */
+export declare function setTitleAndLogo(): void;
+/**
+ * 根据域名返回平台名称
+ * @param lang
+ * @returns
+ */
+export declare function getTitle(lang: string): Record<string, string>;
+/**
+ * 根据域名返回导航栏logo
+ * @returns
+ */
+export declare function getNavLogo(): string;

package/package.json

@@ -0,0 +1,90 @@
+{
+  "name": "twcpt",
+  "version": "0.0.2",
+  "description": "A Vue 3 component library built with Vite and TypeScript, featuring components integrated with Element-plus.",
+  "main": "dist/twcpt.umd.js",
+  "module": "dist/twcpt.es.js",
+  "types": "dist/index.d.ts",
+  "type": "module",
+  "scripts": {
+    "p": "npm publish",
+    "build:colors": "node scripts/generate-colors.js",
+    "build:svg": "node scripts/generate-custom-svg.js",
+    "build:types": "node scripts/generate-global-types.js",
+    "build": "vite build",
+    "build-all": "npm run build:colors && npm run build:svg && npm run build:types && vite build",
+    "dev": "npm run build:colors && npm run build:svg && vite build --watch",
+    "yalc:publish": "npm run build-all && npx yalc push",
+    "yalc:push": "npm run build-all && npx yalc push",
+    "yalc:dev": "node scripts/yalc-dev.js",
+    "patch": "npm version patch && npm run p",
+    "minor": "npm version minor && npm run p",
+    "major": "npm version major && npm run p"
+  },
+  "files": [
+    "dist",
+    "README.md",
+    "LICENSE"
+  ],
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/twcpt.es.js",
+      "require": "./dist/twcpt.cjs.js"
+    },
+    "./resolver": {
+      "types": "./dist/resolver.d.ts",
+      "import": "./dist/resolver.mjs",
+      "require": "./dist/resolver.cjs"
+    },
+    "./charts": {
+      "types": "./dist/charts.d.ts",
+      "import": "./dist/charts.es.js",
+      "require": "./dist/charts.cjs.js"
+    },
+    "./twcpt.css": "./dist/index.css",
+    "./twcpt-styles.css": "./dist/twcpt-styles.css",
+    "./dist/index.css": "./dist/index.css",
+    "./dist/twcpt-styles.css": "./dist/twcpt-styles.css"
+  },
+  "peerDependencies": {
+    "chart.js": "^4.0.0",
+    "element-plus": "^2.5.5",
+    "vue": "^3.0.0"
+  },
+  "devDependencies": {
+    "@vitejs/plugin-vue": "^5.2.1",
+    "chart.js": "^4.4.7",
+    "debug": "^4.4.3",
+    "prettier": "^2.5.1",
+    "element-plus": "^2.5.5",
+    "resolve": "^1.22.11",
+    "sass": "^1.94.2",
+    "typescript": "^5.9.3",
+    "unplugin-vue-components": "^30.0.0",
+    "vite": "^6.0.7",
+    "vite-plugin-dts": "^4.5.4",
+    "vue": "^3.5.25"
+  },
+  "keywords": [
+    "vue",
+    "element-plus",
+    "component-library",
+    "typescript"
+  ],
+  "author": "tw-hejian",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://codeup.aliyun.com/kwtw/frontend/twcpt",
+    "directory": "."
+  },
+  "homepage": "https://www.npmjs.com/package/twcpt",
+  "bugs": {
+    "url": "https://codeup.aliyun.com/kwtw/frontend/twcpt/issues"
+  },
+  "engines": {
+    "node": ">=16.0.0"
+  },
+  "dependencies": {}
+}