rhjy-ui 0.2.4 → 0.2.5

package/README.md

@@ -1,92 +1,121 @@
-# rhjy-ui
-
-`rhjy-ui` is a Vue 3 and Element Plus business UI component library. The first release contains a configurable data-center suite for displaying asynchronous import, export, generation and other background tasks.
-
-## Install
-
-```bash
-pnpm add rhjy-ui vue element-plus @element-plus/icons-vue
-```
-
-Import the package stylesheet once in the application entrypoint:
-
-```ts
-import 'rhjy-ui/style.css'
-```
-
-## Responsive Info Grid
-
-Responsive Info Grid arranges title-content pairs in a configurable grid and switches column counts at the 1200px and 768px breakpoints.
-
-```vue
-<script setup lang="ts">
-import {
-  RhResponsiveInfoGrid,
-  RhResponsiveInfoGridItem,
-} from 'rhjy-ui'
-</script>
-
-<template>
-  <RhResponsiveInfoGrid>
-    <RhResponsiveInfoGridItem title="Project: " content="Smart Campus" />
-    <RhResponsiveInfoGridItem title="Owner: " content="Operations Team" />
-    <RhResponsiveInfoGridItem title="Devices: " :content="128" />
-    <RhResponsiveInfoGridItem title="Summary: " content="All systems operational" :span="2" />
-  </RhResponsiveInfoGrid>
-</template>
-```
-
+# rhjy-ui
+
+`rhjy-ui` is a Vue 3 and Element Plus business UI component library. The first release contains a configurable data-center suite for displaying asynchronous import, export, generation and other background tasks.
+
+## Install
+
+```bash
+pnpm add rhjy-ui vue element-plus @element-plus/icons-vue
+```
+
+Import the package stylesheet once in the application entrypoint:
+
+```ts
+import 'rhjy-ui/style.css'
+```
+
+## Responsive Info Grid
+
+Responsive Info Grid arranges title-content pairs in a configurable grid and switches column counts at the 1200px and 768px breakpoints.
+
+```vue
+<script setup lang="ts">
+import {
+  RhResponsiveInfoGrid,
+  RhResponsiveInfoGridItem,
+} from 'rhjy-ui'
+</script>
+
+<template>
+  <RhResponsiveInfoGrid>
+    <RhResponsiveInfoGridItem title="Project: " content="Smart Campus" />
+    <RhResponsiveInfoGridItem title="Owner: " content="Operations Team" />
+    <RhResponsiveInfoGridItem title="Devices: " :content="128" />
+    <RhResponsiveInfoGridItem title="Summary: " content="All systems operational" :span="2" />
+  </RhResponsiveInfoGrid>
+</template>
+```
+
 See the [Responsive Info Grid component README](https://unpkg.com/rhjy-ui@0.2.2/src/responsive-info-grid/README.md) for subpath imports, the complete props and slots reference, responsive behavior, and more examples.
-
-## Data center panel
-
-`rhjy-ui` never receives an API URL. Each application supplies a `loadTasks` function and converts its own response into the standard task model.
-
-```vue
-<script setup lang="ts">
-import { RhDataCenter } from 'rhjy-ui'
-import type {
-  RhDataCenterCategory,
-  RhDataCenterLoadTasks,
-} from 'rhjy-ui/data-center'
-
-const categories: RhDataCenterCategory[] = [
-  { key: 'all', label: '全部任务' },
-  { key: 'generate', label: '数据生成' },
-  { key: 'import', label: '数据导入' },
-  { key: 'export', label: '数据导出' },
-]
-
-const loadTasks: RhDataCenterLoadTasks = async ({ category }) => {
-  const response = await requestTaskList({
-    taskType: category.key === 'all' ? undefined : category.key,
-  })
-
-  return {
-    items: response.list,
-    total: response.total,
-  }
-}
-
-const handleTaskAction = ({ action, task }) => {
-  if (action === 'download') {
-    window.open(task.raw.fileUrl)
-  }
-}
-</script>
-
-<template>
+
+## Data center panel
+
+`rhjy-ui` never receives an API URL. Each application supplies a `loadTasks` function and converts its own response into the standard task model.
+
+```vue
+<script setup lang="ts">
+import { RhDataCenter } from 'rhjy-ui'
+import type {
+  RhDataCenterCategory,
+  RhDataCenterLoadTasks,
+} from 'rhjy-ui/data-center'
+
+const categories: RhDataCenterCategory[] = [
+  { key: 'all', label: '全部任务' },
+  { key: 'generate', label: '数据生成' },
+  { key: 'import', label: '数据导入' },
+  { key: 'export', label: '数据导出' },
+]
+
+const loadTasks: RhDataCenterLoadTasks = async ({ category }) => {
+  const response = await requestTaskList({
+    taskType: category.key === 'all' ? undefined : category.key,
+  })
+
+  return {
+    items: response.list,
+    total: response.total,
+  }
+}
+
+const handleTaskAction = ({ action, task }) => {
+  if (action === 'download') {
+    window.open(task.raw.fileUrl)
+  }
+}
+</script>
+
+<template>
   <RhDataCenter
     :categories="categories"
     :load-tasks="loadTasks"
     sidebar-width="160px"
     @task-action="handleTaskAction"
   />
-</template>
-```
-
+</template>
+```
+
 The “全部任务” rule is application-owned. It may omit `taskType`, pass a fixed value, or combine multiple requests without changing the component.
 
+### Reuse the business adapter
+
+When multiple applications use the same data-center protocol, use `createRhDataCenterAdapter` to share response conversion, status messages, sorting, counts, and default download actions. The application still injects its own API functions; the package never receives an API URL.
+
+```ts
+import {
+  createRhDataCenterAdapter,
+  type RhDataCenterCategory,
+} from 'rhjy-ui/data-center'
+import { clickDownloadBtByTaskId, getMyTaskList } from '@/services/dataCenter'
+
+const categories: RhDataCenterCategory[] = [
+  { key: 'all', label: '全部任务', query: { taskType: 0 } },
+  { key: 2, label: '数据导入', query: { taskType: 2 } },
+  { key: 3, label: '数据导出', query: { taskType: 3 } },
+]
+
+const { loadTasks, handleTaskAction } = createRhDataCenterAdapter({
+  api: {
+    getTaskList: getMyTaskList,
+    downloadTask: ({ taskId }) => clickDownloadBtByTaskId({ taskId }),
+  },
+  categories,
+  taskKind: { import: [2], export: [3] },
+})
+```
+
+Use `parseResponse` when the application response wrapper or success rule differs. Use `mapTask` or `resolveActions` for an application-specific field or operation without changing the shared adapter. `RhDataCenter` remains responsible for polling; the adapter handles one query and one task action at a time.
+
 Use `sidebar-width` with a number or CSS size string to adjust the data type panel width. Its default value is `124px`.
 
 Category counts are optional and application-owned. Set `show-category-count` to `false` to hide every category count, or pass `category-counts` to display values before individual categories are loaded:
@@ -101,49 +130,100 @@ Category counts are optional and application-owned. Set `show-category-count` to
 ```
 
 When counts are enabled, the component uses `categoryCounts`, then a loaded result's `counts`, and finally the category result's `total`.
-
-## Task tip flow
-
-Use `useRhDataCenter` after a page successfully creates a background task:
-
-```vue
-<script setup lang="ts">
-import { RhDataCenterTip, useRhDataCenter } from 'rhjy-ui'
-
-const { tipVisible, tipConfig, showTip } = useRhDataCenter()
-
-const startExport = async () => {
-  const result = await createExportTask()
-  showTip({
-    type: 'export',
-    minutes: Number(result.minutes),
-    title: '导出文件生成中，大概需要',
-    content: '现在你可关闭弹框，去做其他事情了。',
-  })
-}
-</script>
-
-<template>
-  <RhDataCenterTip v-model="tipVisible" v-bind="tipConfig" />
-</template>
-```
-
-## Standard task model
-
-The adapter returns `id`, `categoryKey`, `title`, `createdAt`, `progress`, and one of `waiting`, `processing`, `success`, or `failed`. Optional `tag`, `message`, `actions`, and `raw` provide display and application action context.
-
-## Styling
-
-Override CSS variables at the application root when needed:
-
-```css
-:root {
-  --rh-ui-data-center-primary: #00828a;
-  --rh-ui-data-center-panel-width: 606px;
-  --rh-ui-data-center-panel-height: 500px;
-}
-```
-
-## Releases
-
+
+Task tags read `raw.taskTypeName` by default. When an API uses another field name, pass `task-tag-field` without changing the task adapter:
+
+```vue
+<RhDataCenter
+  :categories="categories"
+  :load-tasks="loadTasks"
+  task-tag-field="taskTypeName"
+/>
+```
+
+## Task tip flow
+
+Use `useRhDataCenter` after a page successfully creates a background task:
+
+```vue
+<script setup lang="ts">
+import { RhDataCenterTip, useRhDataCenter } from 'rhjy-ui'
+
+const { tipVisible, tipConfig, showTip } = useRhDataCenter()
+
+const startExport = async () => {
+  const result = await createExportTask()
+  showTip({
+    type: 'export',
+    minutes: Number(result.minutes),
+    title: '导出文件生成中，大概需要',
+    content: '现在你可关闭弹框，去做其他事情了。',
+  })
+}
+</script>
+
+<template>
+  <RhDataCenterTip v-model="tipVisible" v-bind="tipConfig" />
+</template>
+```
+
+`RhDataCenterTip` 默认使用简化引导动画；需要使用带数据处理中心图片、手势和方向切换的引导时，可传入 `guideVariant="normal"` 或 `guideVariant="super"`。
+
+## Standard task model
+
+The adapter returns `id`, `categoryKey`, `title`, `createdAt`, `progress`, and one of `waiting`, `processing`, `success`, or `failed`. Optional `tag`, `message`, `actions`, and `raw` provide display and application action context.
+
+For completed tasks with rejected records, pass the normalized `failCount` field. The task item keeps the completed progress bar, shows `失败记录（xx条）` in red, and hides the normal completion message when the count is zero. The application still supplies the failure-record action and handles its download event.
+
+For processing tasks, pass `taskSeconds` to show `总时长约X分XX秒` instead of the default processing message. If `taskSeconds` is omitted, the provided `message` is displayed.
+
+## Styling
+
+Override CSS variables at the application root when needed:
+
+```css
+:root {
+  --rh-ui-data-center-primary: #00828a;
+  --rh-ui-data-center-panel-width: 606px;
+  --rh-ui-data-center-panel-height: 500px;
+}
+```
+
+## Build and publish
+
+After changing the source code or component assets, run the package script in the `rh-ui` directory to regenerate `dist`:
+
+```bash
+cd D:\workfile\sass-workspace\packages\rh-ui
+npm run package
+```
+
+The workspace equivalent is:
+
+```bash
+pnpm --filter rhjy-ui package
+```
+
+Before publishing, update the `version` field in `package.json`. You can inspect the files that will be published with:
+
+```bash
+npm pack --dry-run
+```
+
+After confirming the tarball contents, publish the public package:
+
+```bash
+npm login --registry=https://registry.npmjs.org --auth-type=web
+npm publish --access public --registry=https://registry.npmjs.org
+```
+
+If the account uses two-factor authentication, npm opens the browser authentication flow. After publishing, update the consuming application with the explicit version:
+
+```bash
+cd D:\workfile\wise-school-admin
+npm install rhjy-ui@0.2.5
+```
+
+## Releases
+
 The package is published with compiled `dist` output. Consumers should use an explicit version such as `rhjy-ui@0.2.2`; application-specific API adapters remain in the consuming project.

package/dist/data-center/RhDataCenter.vue.d.ts

@@ -35,6 +35,7 @@ declare const __VLS_component: import('vue').DefineComponent<import('vue').Extra
     width?: string | number;
     panelHeight?: string | number;
     sidebarWidth?: string | number;
+    taskTagField?: string;
     panelRight?: string | number;
     pollInterval?: number;
     refreshOnOpen?: boolean;
@@ -49,6 +50,7 @@ declare const __VLS_component: import('vue').DefineComponent<import('vue').Extra
     width: number;
     panelHeight: number;
     sidebarWidth: number;
+    taskTagField: string;
     panelRight: number;
     pollInterval: number;
     refreshOnOpen: boolean;
@@ -71,6 +73,7 @@ declare const __VLS_component: import('vue').DefineComponent<import('vue').Extra
     width?: string | number;
     panelHeight?: string | number;
     sidebarWidth?: string | number;
+    taskTagField?: string;
     panelRight?: string | number;
     pollInterval?: number;
     refreshOnOpen?: boolean;
@@ -85,6 +88,7 @@ declare const __VLS_component: import('vue').DefineComponent<import('vue').Extra
     width: number;
     panelHeight: number;
     sidebarWidth: number;
+    taskTagField: string;
     panelRight: number;
     pollInterval: number;
     refreshOnOpen: boolean;
@@ -103,6 +107,7 @@ declare const __VLS_component: import('vue').DefineComponent<import('vue').Extra
     label: string;
     width: string | number;
     sidebarWidth: string | number;
+    taskTagField: string;
     showCategoryCount: boolean;
     modelValue: boolean;
     panelHeight: string | number;

package/dist/data-center/RhDataCenterPanel.vue.d.ts

@@ -26,6 +26,7 @@ declare const __VLS_component: import('vue').DefineComponent<import('vue').Extra
     loadTasks: RhDataCenterLoadTasks;
     activeCategoryKey?: string | number;
     sidebarWidth?: string | number;
+    taskTagField?: string;
     closeable?: boolean;
     showTotal?: boolean;
     showCategoryCount?: boolean;
@@ -34,6 +35,7 @@ declare const __VLS_component: import('vue').DefineComponent<import('vue').Extra
 }>, {
     activeCategoryKey: any;
     sidebarWidth: number;
+    taskTagField: string;
     closeable: boolean;
     showTotal: boolean;
     showCategoryCount: boolean;
@@ -50,6 +52,7 @@ declare const __VLS_component: import('vue').DefineComponent<import('vue').Extra
     loadTasks: RhDataCenterLoadTasks;
     activeCategoryKey?: string | number;
     sidebarWidth?: string | number;
+    taskTagField?: string;
     closeable?: boolean;
     showTotal?: boolean;
     showCategoryCount?: boolean;
@@ -58,6 +61,7 @@ declare const __VLS_component: import('vue').DefineComponent<import('vue').Extra
 }>, {
     activeCategoryKey: any;
     sidebarWidth: number;
+    taskTagField: string;
     closeable: boolean;
     showTotal: boolean;
     showCategoryCount: boolean;
@@ -70,6 +74,7 @@ declare const __VLS_component: import('vue').DefineComponent<import('vue').Extra
 }>, {
     activeCategoryKey: string | number;
     sidebarWidth: string | number;
+    taskTagField: string;
     closeable: boolean;
     showTotal: boolean;
     showCategoryCount: boolean;

package/dist/data-center/RhDataCenterTip.vue.d.ts

@@ -1,3 +1,5 @@
+import { RhDataCenterTipGuideVariant } from './types';
+
 declare function __VLS_template(): {
     extra?(_: {}): any;
 };
@@ -9,6 +11,7 @@ declare const __VLS_component: import('vue').DefineComponent<import('vue').Extra
     content?: string;
     width?: string | number;
     showGuideAnimation?: boolean;
+    guideVariant?: RhDataCenterTipGuideVariant;
 }>, {
     modelValue: boolean;
     minutes: any;
@@ -17,6 +20,7 @@ declare const __VLS_component: import('vue').DefineComponent<import('vue').Extra
     content: string;
     width: string;
     showGuideAnimation: boolean;
+    guideVariant: string;
 }>>, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {
     "update:modelValue": (value: boolean) => void;
     close: () => void;
@@ -28,6 +32,7 @@ declare const __VLS_component: import('vue').DefineComponent<import('vue').Extra
     content?: string;
     width?: string | number;
     showGuideAnimation?: boolean;
+    guideVariant?: RhDataCenterTipGuideVariant;
 }>, {
     modelValue: boolean;
     minutes: any;
@@ -36,6 +41,7 @@ declare const __VLS_component: import('vue').DefineComponent<import('vue').Extra
     content: string;
     width: string;
     showGuideAnimation: boolean;
+    guideVariant: string;
 }>>> & Readonly<{
     onClose?: () => any;
     "onUpdate:modelValue"?: (value: boolean) => any;
@@ -47,6 +53,7 @@ declare const __VLS_component: import('vue').DefineComponent<import('vue').Extra
     modelValue: boolean;
     minutes: number;
     showGuideAnimation: boolean;
+    guideVariant: RhDataCenterTipGuideVariant;
 }, {}, {}, {}, string, import('vue').ComponentProvideOptions, true, {}, any>;
 declare const _default: __VLS_WithTemplateSlots<typeof __VLS_component, ReturnType<typeof __VLS_template>>;
 export default _default;

package/dist/data-center/adapter.d.ts

@@ -0,0 +1,3 @@
+import { RhDataCenterAdapterOptions, RhDataCenterAdapterResult } from './types';
+
+export declare const createRhDataCenterAdapter: <RawTask extends object, Query = Record<string, unknown>, Response = unknown>(options: RhDataCenterAdapterOptions<RawTask, Query, Response>) => RhDataCenterAdapterResult;

package/dist/data-center/constants.d.ts

@@ -5,8 +5,19 @@ export declare const RH_DATA_CENTER_TASK_STATUS: {
     readonly Failed: "failed";
 };
 export declare const RH_DATA_CENTER_DEFAULT_LABEL = "\u6570\u636E\u5904\u7406\u4E2D\u5FC3";
-export declare const RH_DATA_CENTER_DEFAULT_WIDTH = 606;
+export declare const RH_DATA_CENTER_DEFAULT_WIDTH = 715;
 export declare const RH_DATA_CENTER_DEFAULT_HEIGHT = 500;
-export declare const RH_DATA_CENTER_DEFAULT_SIDEBAR_WIDTH = 124;
+export declare const RH_DATA_CENTER_DEFAULT_SIDEBAR_WIDTH = 160;
 export declare const RH_DATA_CENTER_DEFAULT_POLL_INTERVAL = 1000;
-export declare const RH_DATA_CENTER_RECENT_DAYS_TEXT = "-\u6B64\u5904\u4EC5\u5C55\u793A\u8FD115\u5929\u5185\u7684\u6570\u636E-";
+export declare const RH_DATA_CENTER_RECENT_DAYS_TEXT = "\u4EC5\u5C55\u793A\u8FD115\u5929\u5185\u7684\u6570\u636E";
+export declare const DOWNLOAD_ACTION = "download";
+export declare const DOWNLOAD_FAILURE_ACTION = "downloadFailure";
+export declare const RH_DATA_CENTER_ACTION: {
+    readonly Download: "download";
+    readonly DownloadFailure: "downloadFailure";
+};
+export declare const RH_DATA_CENTER_ACTION_LABEL: {
+    readonly Download: "下载文件";
+    readonly Redownload: "重新下载文件";
+    readonly DownloadFailure: "下载失败记录";
+};