jcjy-components 0.0.692 → 0.0.694

package/README.md

@@ -1,6 +1,6 @@
 # JCJY Components
 
-Vue 3 组件库，基于 Element Plus 和 Tailwind CSS 构建。
+Vue 3 组件库，基于 Element Plus 与 Tailwind 构建。
 
 ## 安装
 
@@ -16,60 +16,57 @@ yarn add jcjy-components
 
 - Vue 3.0+
 - Element Plus 2.0+
-- Tailwind CSS 4.0+ (推荐，用于样式支持)
+- TailwindCSS 3.x（仅支持 TailwindCSS 项目）
+
+> 说明：当前版本仅支持已集成 TailwindCSS 的宿主项目；第三方接入时需额外引入 Element Plus 全量样式。
 
 ## 使用方法
 
-### 1. 基本安装
+### 1. 插件方式（推荐）
 
-```javascript
+```ts
 import { createApp } from 'vue'
+import App from './App.vue'
 import JcjyComponents from 'jcjy-components'
+import 'element-plus/dist/index.css'
+import 'jcjy-components/style.css'
 
 const app = createApp(App)
-
-// 安装组件库
 app.use(JcjyComponents)
+app.mount('#app')
 ```
 
 ### 2. 按需导入组件
 
-```javascript
+```ts
 import { AuthGateway } from 'jcjy-components'
+import 'element-plus/dist/index.css'
+import 'jcjy-components/style.css'
 
 export default {
   components: {
-    AuthGateway
-  }
+    AuthGateway,
+  },
 }
 ```
 
-### 3. 样式配置
-
-**重要**: 本组件库使用 Tailwind CSS，请确保你的项目中已配置 Tailwind CSS。
+## TypeScript 支持
 
-在你的 `tailwind.config.js` 中添加组件库路径：
+本库已内置类型声明，TS 项目可直接获得类型提示。
 
-```javascript
-/** @type {import('tailwindcss').Config} */
-export default {
-  content: [
-    "./index.html",
-    "./src/**/*.{vue,js,ts,jsx,tsx}",
-    // 添加这行以包含组件库的样式
-    "./node_modules/jcjy-components/**/*.{vue,js,ts,jsx,tsx}",
-  ],
-  theme: {
-    extend: {},
-  },
-  plugins: [],
-  // 禁用 preflight 以避免冲突
-  corePlugins: {
-    preflight: false,
-  },
-}
+```ts
+import type { AuthGatewayConfig } from 'jcjy-components/dist/components/auth-gateway/interface'
 ```
 
+## 样式说明
+
+- 请在宿主项目入口显式引入：`import 'jcjy-components/style.css'`
+- 第三方使用时请同时引入 Element Plus 全量样式：`import 'element-plus/dist/index.css'`
+- 仅支持 TailwindCSS 项目接入，宿主项目需已完成 TailwindCSS 配置
+- 组件库默认未打入 Element Plus 全量样式（含 `base.css`），这是为了降低对宿主项目全局样式污染
+- 组件库已关闭 Tailwind 的 `@tailwind base` 与 `@tailwind components`，仅保留 utilities，避免把全局 reset 样式注入到宿主项目
+- 因此宿主项目的原生标签样式（如 `h1`、`p`、`button`）会保持自身样式，不会被组件库覆盖
+
 ## 组件列表
 
 ### AuthGateway 认证网关
@@ -79,95 +76,41 @@ export default {
 ```vue
 <template>
   <AuthGateway
-    mode="default"
-    @login-success="handleLoginSuccess"
-    @register-success="handleRegisterSuccess"
+    :config="config"
+    :binding="binding"
+    :login="login"
+    :register="register"
+    :wechat-config="wechatConfig"
   />
 </template>
-
-<script setup>
-const handleLoginSuccess = (userInfo) => {
-  console.log('登录成功:', userInfo)
-}
-
-const handleRegisterSuccess = (userInfo) => {
-  console.log('注册成功:', userInfo)
-}
-</script>
 ```
 
-#### Props
-
-| 属性            | 类型    | 默认值    | 说明                                  |
-| --------------- | ------- | --------- | ------------------------------------- |
-| mode            | string  | 'default' | 显示模式：'default', 'center', 'left' |
-| showRegister    | boolean | true      | 是否显示注册入口                      |
-| showWechatLogin | boolean | true      | 是否显示微信登录                      |
-
-#### Events
-
-| 事件名               | 参数     | 说明               |
-| -------------------- | -------- | ------------------ |
-| login-success        | userInfo | 登录成功时触发     |
-| register-success     | userInfo | 注册成功时触发     |
-| wechat-login-success | userInfo | 微信登录成功时触发 |
-
 ### 主题工具
 
-组件库提供主题设置工具：
-
-```javascript
+```ts
 import { theme } from 'jcjy-components'
 
 // 设置主题
-theme.setTheme('dark')
+await theme.setTheme('#409EFF')
 
-// 根据URL参数设置主题
-theme.setThemeByUrl()
+// 根据 URL 参数设置主题
+await theme.setThemeByUrl()
 ```
 
-## Element Plus 依赖
-
-本组件库基于 Element Plus 构建，使用组件库时需要自行安装和配置 Element Plus：
-
-```javascript
-import ElementPlus from 'element-plus'
-import 'element-plus/dist/index.css'
-import * as ElementPlusIconsVue from '@element-plus/icons-vue'
-
-const app = createApp(App)
-
-app.use(ElementPlus)
-
-// 注册所有图标
-for (const [key, component] of Object.entries(ElementPlusIconsVue)) {
-  app.component(key, component)
-}
-```
+## 产物说明
 
-## 项目结构
+发布包默认包含以下关键文件：
 
-```
-jcjy-components/
-├── src/
-│   ├── components/
-│   │   └── auth-gateway/      # 认证网关组件
-│   ├── index.ts               # 入口文件
-│   └── styles.css            # 开发时样式（不打包）
-├── dist/                     # 构建输出
-│   ├── index.es.js           # ES 模块
-│   ├── index.umd.js          # UMD 模块
-│   └── index.d.ts            # TypeScript 类型声明
-├── tailwind.config.js        # Tailwind 配置
-└── vite.config.ts            # Vite 构建配置
-```
+- `dist/index.es.js`（ESM）
+- `dist/index.umd.cjs`（CJS）
+- `dist/jcjy-components.css`（样式）
+- `dist/index.d.ts`（类型声明）
 
 ## 注意事项
 
-1. **样式依赖**: 组件库不打包 CSS，依赖宿主项目的 Tailwind CSS
-2. **Element Plus**: 需要在宿主项目中单独安装和配置
-3. **TypeScript**: 提供完整的类型声明支持
-4. **响应式设计**: 组件支持移动端和桌面端响应式布局
+1. 宿主项目需要自行安装 `vue` 与 `element-plus`（peerDependencies）
+2. 若你在本库中新增了 Element Plus 组件，请同步补齐 `src/styles.css` 中对应的 `theme-chalk` 样式引入
+3. 若发布到 npm，请使用：`pnpm push:npm`
 
 ## 许可证
 

package/dist/components/auth-gateway/bind-org-dialog.vue.d.ts

@@ -0,0 +1,12 @@
+declare function open(): void;
+declare function close(): void;
+declare const __VLS_export: import("vue").DefineComponent<{}, {
+    open: typeof open;
+    close: typeof close;
+}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {} & {
+    confirm: (v: any) => any;
+}, string, import("vue").PublicProps, Readonly<{}> & Readonly<{
+    onConfirm?: ((v: any) => any) | undefined;
+}>, {}, {}, {}, {}, string, import("vue").ComponentProvideOptions, true, {}, any>;
+declare const _default: typeof __VLS_export;
+export default _default;

package/dist/components/auth-gateway/index.vue.d.ts

@@ -0,0 +1,10 @@
+import { type AuthGatewayProps } from "./interface";
+declare const __VLS_export: import("vue").DefineComponent<AuthGatewayProps, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {} & {
+    success: (v: any) => any;
+}, string, import("vue").PublicProps, Readonly<AuthGatewayProps> & Readonly<{
+    onSuccess?: ((v: any) => any) | undefined;
+}>, {
+    strictRegister: boolean;
+}, {}, {}, {}, string, import("vue").ComponentProvideOptions, false, {}, any>;
+declare const _default: typeof __VLS_export;
+export default _default;

package/dist/components/auth-gateway/interface.d.ts

@@ -0,0 +1,50 @@
+export declare const TabKey: {
+    readonly LOGIN: 0;
+    readonly REGISTER: 1;
+    readonly WECHAT: 2;
+    readonly WECHAT_SCAN: 3;
+};
+export type TabKey = (typeof TabKey)[keyof typeof TabKey];
+export interface AuthGatewayProps {
+    config: AuthGatewayConfig;
+    strictRegister?: boolean;
+    binding: (v: {
+        orgName: string;
+        name: string;
+        code: string;
+    }, headers: {
+        token: string;
+    }) => Promise<any>;
+    register: (params: {
+        userName: string;
+        passwd: string;
+        weChatOpenId?: string;
+    }) => Promise<any>;
+    login: (params: {
+        weChatCode?: string;
+        userName?: string;
+        passwd?: string;
+        weChatOpenId?: string;
+    }) => Promise<{
+        err: number;
+        msg: string;
+        weChatUserDetail: any;
+    } | any>;
+    wechatConfig?: {
+        appId: string;
+        redirectUrl: string;
+    };
+}
+export interface AuthGatewayConfig {
+    title?: string;
+    favicon?: string;
+    loginBackground?: string;
+    skipBind?: '0' | '1';
+    hf?: '0' | '1';
+    nb?: '0' | '1';
+    cf?: string;
+    from?: 'inline';
+    hideWx?: string;
+    layout?: 'default' | 'center' | 'left';
+}
+export declare const DEFAULT_CONFIG: AuthGatewayConfig;

package/dist/components/auth-gateway/login-form.vue.d.ts

@@ -0,0 +1,14 @@
+import { TabKey } from "./interface";
+type __VLS_Props = {
+    confirmText?: string;
+    hideLoginMethods?: boolean;
+};
+declare const __VLS_export: import("vue").DefineComponent<__VLS_Props, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {} & {
+    toggle: (v: TabKey) => any;
+    submit: (v: any) => any;
+}, string, import("vue").PublicProps, Readonly<__VLS_Props> & Readonly<{
+    onToggle?: ((v: TabKey) => any) | undefined;
+    onSubmit?: ((v: any) => any) | undefined;
+}>, {}, {}, {}, {}, string, import("vue").ComponentProvideOptions, false, {}, any>;
+declare const _default: typeof __VLS_export;
+export default _default;

package/dist/components/auth-gateway/register-form.vue.d.ts

@@ -0,0 +1,12 @@
+type __VLS_Props = {
+    confirmText?: string;
+};
+declare const __VLS_export: import("vue").DefineComponent<__VLS_Props, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {} & {
+    submit: (v: any) => any;
+    back: () => any;
+}, string, import("vue").PublicProps, Readonly<__VLS_Props> & Readonly<{
+    onSubmit?: ((v: any) => any) | undefined;
+    onBack?: (() => any) | undefined;
+}>, {}, {}, {}, {}, string, import("vue").ComponentProvideOptions, false, {}, any>;
+declare const _default: typeof __VLS_export;
+export default _default;

package/dist/components/auth-gateway/util.d.ts

@@ -0,0 +1,17 @@
+export declare function transformModel(v: {
+    email: string;
+    password: string;
+}): {
+    userName: string;
+    passwd: string | Int32Array<ArrayBufferLike>;
+};
+export declare function setThemeByUrl(src?: string): Promise<void>;
+export declare function setTheme(colors: any[]): void;
+export declare function setTitle(title?: string, favicon?: string): void;
+export declare const passwordValidator: (config?: Partial<{
+    minLength: number;
+    lowercase: number;
+    uppercase: number;
+    numbers: number;
+    symbols: number;
+}>) => (_rule: any, value: string, callback: any) => any;

package/dist/components/auth-gateway/wechat-form.vue.d.ts

@@ -0,0 +1,10 @@
+type __VLS_Props = {
+    info: any;
+};
+declare const __VLS_export: import("vue").DefineComponent<__VLS_Props, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {} & {
+    back: () => any;
+}, string, import("vue").PublicProps, Readonly<__VLS_Props> & Readonly<{
+    onBack?: (() => any) | undefined;
+}>, {}, {}, {}, {}, string, import("vue").ComponentProvideOptions, false, {}, any>;
+declare const _default: typeof __VLS_export;
+export default _default;

package/dist/components/auth-gateway/wechat-scan-view.vue.d.ts

@@ -0,0 +1,13 @@
+declare const __VLS_export: import("vue").DefineComponent<{}, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {} & {
+    submit: (v: {
+        weChatCode: string;
+    }) => any;
+    back: () => any;
+}, string, import("vue").PublicProps, Readonly<{}> & Readonly<{
+    onSubmit?: ((v: {
+        weChatCode: string;
+    }) => any) | undefined;
+    onBack?: (() => any) | undefined;
+}>, {}, {}, {}, {}, string, import("vue").ComponentProvideOptions, true, {}, any>;
+declare const _default: typeof __VLS_export;
+export default _default;

package/dist/index.d.ts

@@ -0,0 +1,14 @@
+import type { App } from 'vue';
+import AuthGateway from './components/auth-gateway/index.vue';
+import { setTheme, setThemeByUrl } from './components/auth-gateway/util';
+import './styles.css';
+export declare const theme: {
+    setTheme: typeof setTheme;
+    setThemeByUrl: typeof setThemeByUrl;
+};
+export { AuthGateway };
+export type { AuthGatewayConfig } from './components/auth-gateway/interface';
+declare const _default: {
+    install(app: App): void;
+};
+export default _default;