@bsg-export/vue 1.0.6

package/dist/ExportButton.vue.d.ts

@@ -0,0 +1,55 @@
+/**
+ * ExportButton - 开箱即用的导出按钮组件
+ *
+ * @example
+ * ```vue
+ * <ExportButton table-id="my-table" filename="报表.xlsx" :format="ExportFormat.Xlsx">
+ *   导出 Excel
+ * </ExportButton>
+ * ```
+ */
+import type { ExportFormat } from '@bsg-export/types';
+/** 组件 Props */
+export interface ExportButtonProps {
+    /** 要导出的 HTML 表格元素的 ID */
+    tableId: string;
+    /** 导出文件名 */
+    filename?: string;
+    /** 导出格式 */
+    format?: ExportFormat;
+    /** 是否排除隐藏行/列 */
+    excludeHidden?: boolean;
+    /** 是否添加 UTF-8 BOM（仅 CSV 有效） */
+    withBom?: boolean;
+    /** 是否禁用按钮 */
+    disabled?: boolean;
+    /** 初始化中的提示文本 */
+    initializingText?: string;
+    /** 导出中的提示文本（支持 {progress} 占位符） */
+    loadingText?: string;
+}
+declare var __VLS_1: {};
+type __VLS_Slots = {} & {
+    default?: (props: typeof __VLS_1) => any;
+};
+declare const __VLS_component: import("vue").DefineComponent<ExportButtonProps, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
+    success: () => any;
+    error: (error: Error) => any;
+    progress: (progress: number) => any;
+}, string, import("vue").PublicProps, Readonly<ExportButtonProps> & Readonly<{
+    onSuccess?: (() => any) | undefined;
+    onError?: ((error: Error) => any) | undefined;
+    onProgress?: ((progress: number) => any) | undefined;
+}>, {
+    disabled: boolean;
+    initializingText: string;
+    loadingText: string;
+}, {}, {}, {}, string, import("vue").ComponentProvideOptions, false, {}, any>;
+declare const _default: __VLS_WithSlots<typeof __VLS_component, __VLS_Slots>;
+export default _default;
+type __VLS_WithSlots<T, S> = T & {
+    new (): {
+        $slots: S;
+    };
+};
+//# sourceMappingURL=ExportButton.vue.d.ts.map

package/dist/ExportButton.vue.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ExportButton.vue.d.ts","sourceRoot":"","sources":["../src/ExportButton.vue"],"names":[],"mappings":"AA4FA;;;;;;;;;GASG;AAEH,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAC;AAItD,eAAe;AACf,MAAM,WAAW,iBAAiB;IAChC,yBAAyB;IACzB,OAAO,EAAE,MAAM,CAAC;IAChB,YAAY;IACZ,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,WAAW;IACX,MAAM,CAAC,EAAE,YAAY,CAAC;IACtB,gBAAgB;IAChB,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB,+BAA+B;IAC/B,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,aAAa;IACb,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,gBAAgB;IAChB,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,kCAAkC;IAClC,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AA4ED,QAAA,IAAI,OAAO,IAAW,CAAE;AACxB,KAAK,WAAW,GAAG,EAAE,GACnB;IAAE,OAAO,CAAC,EAAE,CAAC,KAAK,EAAE,OAAO,OAAO,KAAK,GAAG,CAAA;CAAE,CAAC;AAwB/C,QAAA,MAAM,eAAe;;;;;;;;;cA3GR,OAAO;sBAEC,MAAM;iBAEX,MAAM;6EA+GpB,CAAC;wBACkB,eAAe,CAAC,OAAO,eAAe,EAAE,WAAW,CAAC;AAAzE,wBAA0E;AAa1E,KAAK,eAAe,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,GAAG;IAChC,QAAO;QACN,MAAM,EAAE,CAAC,CAAC;KAEV,CAAA;CACD,CAAC"}

package/dist/index.d.ts

@@ -0,0 +1,13 @@
+/**
+ * @bsg-export/vue - belobog-stellar-grid 的 Vue 3 官方封装
+ *
+ * 提供 Composable 和组件，简化在 Vue 项目中使用表格导出功能。
+ *
+ * @packageDocumentation
+ */
+export { useExporter } from './use-exporter';
+export type { ExportTableOptions, ExportTablesXlsxOptions, ExportCsvBatchOptions, ExportXlsxBatchOptions, ExportTablesBatchOptions, } from './use-exporter';
+export { default as ExportButton } from './ExportButton.vue';
+export type { Column, MergeCellValue, CellValue, MergeableCellValue, DataRow, ExportDataOptions, SheetConfig, BatchSheetConfig, ProgressCallback, } from '@bsg-export/types';
+export { ExportFormat } from '@bsg-export/types';
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAGH,OAAO,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAC7C,YAAY,EACV,kBAAkB,EAClB,uBAAuB,EACvB,qBAAqB,EACrB,sBAAsB,EACtB,wBAAwB,GACzB,MAAM,gBAAgB,CAAC;AAGxB,OAAO,EAAE,OAAO,IAAI,YAAY,EAAE,MAAM,oBAAoB,CAAC;AAG7D,YAAY,EACV,MAAM,EACN,cAAc,EACd,SAAS,EACT,kBAAkB,EAClB,OAAO,EACP,iBAAiB,EACjB,WAAW,EACX,gBAAgB,EAChB,gBAAgB,GACjB,MAAM,mBAAmB,CAAC;AAE3B,OAAO,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAC"}

package/dist/index.js

@@ -0,0 +1,8 @@
+import { useExporter } from "./use-exporter";
+import { default as default2 } from "./ExportButton.vue";
+import { ExportFormat } from "@bsg-export/types";
+export {
+  default2 as ExportButton,
+  ExportFormat,
+  useExporter
+};

package/dist/use-exporter.d.ts

@@ -0,0 +1,104 @@
+/**
+ * useExporter - WASM 导出管理 Composable
+ *
+ * 自动管理 WASM 初始化生命周期，提供类型安全的导出方法和响应式状态。
+ *
+ * @example
+ * ```vue
+ * <script setup lang="ts">
+ * import { useExporter, ExportFormat } from '@bsg-export/vue';
+ *
+ * const { initialized, loading, progress, exportTable } = useExporter();
+ * </script>
+ *
+ * <template>
+ *   <button @click="exportTable({ tableId: 'my-table', filename: '报表.xlsx', format: ExportFormat.Xlsx })"
+ *           :disabled="!initialized || loading">
+ *     {{ loading ? `导出中 ${progress}%` : '导出 Excel' }}
+ *   </button>
+ * </template>
+ * ```
+ */
+import type { ExportFormat, ExportDataOptions, SheetConfig, BatchSheetConfig, DataRow } from '@bsg-export/types';
+/** export_table 的参数配置 */
+export interface ExportTableOptions {
+    /** 要导出的 HTML 表格元素的 ID */
+    tableId: string;
+    /** 导出文件名 */
+    filename?: string;
+    /** 导出格式 */
+    format?: ExportFormat;
+    /** 是否排除隐藏行/列 */
+    excludeHidden?: boolean;
+    /** 是否添加 UTF-8 BOM（仅 CSV 有效） */
+    withBom?: boolean;
+    /** 回调失败是否中断导出 */
+    strictProgressCallback?: boolean;
+}
+/** 多工作表导出的参数配置 */
+export interface ExportTablesXlsxOptions {
+    /** Sheet 配置数组 */
+    sheets: SheetConfig[];
+    /** 导出文件名 */
+    filename?: string;
+}
+/** 分批导出 CSV 的参数配置 */
+export interface ExportCsvBatchOptions {
+    /** 要导出的 HTML 表格元素的 ID */
+    tableId: string;
+    /** 可选的独立 tbody ID */
+    tbodyId?: string;
+    /** 导出文件名 */
+    filename?: string;
+    /** 每批处理行数 */
+    batchSize?: number;
+    /** 是否排除隐藏行/列 */
+    excludeHidden?: boolean;
+    /** 是否添加 UTF-8 BOM */
+    withBom?: boolean;
+}
+/** 分批导出 XLSX 的参数配置 */
+export interface ExportXlsxBatchOptions {
+    /** 要导出的 HTML 表格元素的 ID */
+    tableId: string;
+    /** 可选的独立 tbody ID */
+    tbodyId?: string;
+    /** 导出文件名 */
+    filename?: string;
+    /** 每批处理行数 */
+    batchSize?: number;
+    /** 是否排除隐藏行/列 */
+    excludeHidden?: boolean;
+}
+/** 多工作表分批导出的参数配置 */
+export interface ExportTablesBatchOptions {
+    /** Sheet 配置数组 */
+    sheets: BatchSheetConfig[];
+    /** 导出文件名 */
+    filename?: string;
+    /** 每批处理行数 */
+    batchSize?: number;
+}
+/**
+ * WASM 导出管理 Composable
+ *
+ * 自动初始化 WASM 模块，提供类型安全的导出方法，
+ * 管理 loading / progress / error 响应式状态。
+ */
+export declare function useExporter(): {
+    /** WASM 是否已初始化完成 */
+    initialized: import("vue").Ref<boolean, boolean>;
+    /** 是否正在导出 */
+    loading: import("vue").Ref<boolean, boolean>;
+    /** 导出进度 (0-100) */
+    progress: import("vue").Ref<number, number>;
+    /** 错误信息 */
+    error: import("vue").Ref<Error | null, Error | null>;
+    exportTable: (options: ExportTableOptions) => void;
+    exportData: (data: DataRow[], options?: ExportDataOptions) => void;
+    exportTablesXlsx: (options: ExportTablesXlsxOptions) => void;
+    exportCsvBatch: (options: ExportCsvBatchOptions) => Promise<void>;
+    exportXlsxBatch: (options: ExportXlsxBatchOptions) => Promise<void>;
+    exportTablesBatch: (options: ExportTablesBatchOptions) => Promise<void>;
+};
+//# sourceMappingURL=use-exporter.d.ts.map

package/dist/use-exporter.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"use-exporter.d.ts","sourceRoot":"","sources":["../src/use-exporter.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;GAoBG;AAGH,OAAO,KAAK,EACV,YAAY,EACZ,iBAAiB,EACjB,WAAW,EACX,gBAAgB,EAEhB,OAAO,EACR,MAAM,mBAAmB,CAAC;AAE3B,yBAAyB;AACzB,MAAM,WAAW,kBAAkB;IACjC,yBAAyB;IACzB,OAAO,EAAE,MAAM,CAAC;IAChB,YAAY;IACZ,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,WAAW;IACX,MAAM,CAAC,EAAE,YAAY,CAAC;IACtB,gBAAgB;IAChB,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB,+BAA+B;IAC/B,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,iBAAiB;IACjB,sBAAsB,CAAC,EAAE,OAAO,CAAC;CAClC;AAED,kBAAkB;AAClB,MAAM,WAAW,uBAAuB;IACtC,iBAAiB;IACjB,MAAM,EAAE,WAAW,EAAE,CAAC;IACtB,YAAY;IACZ,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED,qBAAqB;AACrB,MAAM,WAAW,qBAAqB;IACpC,yBAAyB;IACzB,OAAO,EAAE,MAAM,CAAC;IAChB,qBAAqB;IACrB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,YAAY;IACZ,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,aAAa;IACb,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,gBAAgB;IAChB,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB,qBAAqB;IACrB,OAAO,CAAC,EAAE,OAAO,CAAC;CACnB;AAED,sBAAsB;AACtB,MAAM,WAAW,sBAAsB;IACrC,yBAAyB;IACzB,OAAO,EAAE,MAAM,CAAC;IAChB,qBAAqB;IACrB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,YAAY;IACZ,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,aAAa;IACb,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,gBAAgB;IAChB,aAAa,CAAC,EAAE,OAAO,CAAC;CACzB;AAED,oBAAoB;AACpB,MAAM,WAAW,wBAAwB;IACvC,iBAAiB;IACjB,MAAM,EAAE,gBAAgB,EAAE,CAAC;IAC3B,YAAY;IACZ,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,aAAa;IACb,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAuBD;;;;;GAKG;AACH,wBAAgB,WAAW;IA2IvB,oBAAoB;;IAEpB,aAAa;;IAEb,mBAAmB;;IAEnB,WAAW;;2BAnFiB,kBAAkB;uBAetB,OAAO,EAAE,YAAY,iBAAiB;gCAU7B,uBAAuB;8BAWnB,qBAAqB;+BAepB,sBAAsB;iCAcpB,wBAAwB;EA2BnE"}

package/dist/use-exporter.js

@@ -0,0 +1,147 @@
+import { ref, onMounted, onUnmounted } from "vue";
+let wasmModule = null;
+let wasmInitPromise = null;
+async function initWasm() {
+  if (wasmModule) return wasmModule;
+  if (!wasmInitPromise) {
+    wasmInitPromise = import("belobog-stellar-grid").then(async (mod) => {
+      await mod.default();
+      wasmModule = mod;
+      return mod;
+    });
+  }
+  return wasmInitPromise;
+}
+function useExporter() {
+  const initialized = ref(false);
+  const loading = ref(false);
+  const progress = ref(0);
+  const error = ref(null);
+  let mounted = true;
+  onMounted(() => {
+    mounted = true;
+    initWasm().then(() => {
+      if (mounted) initialized.value = true;
+    }).catch((err) => {
+      if (mounted) error.value = err instanceof Error ? err : new Error(String(err));
+    });
+  });
+  onUnmounted(() => {
+    mounted = false;
+  });
+  const createProgressCallback = () => {
+    return (p) => {
+      if (mounted) progress.value = p;
+    };
+  };
+  const wrapSync = (fn) => {
+    if (!initialized.value || !wasmModule) return;
+    loading.value = true;
+    progress.value = 0;
+    error.value = null;
+    try {
+      fn();
+      if (mounted) progress.value = 100;
+    } catch (err) {
+      if (mounted) error.value = err instanceof Error ? err : new Error(String(err));
+    } finally {
+      if (mounted) loading.value = false;
+    }
+  };
+  const wrapAsync = async (fn) => {
+    if (!initialized.value || !wasmModule) return;
+    loading.value = true;
+    progress.value = 0;
+    error.value = null;
+    try {
+      await fn();
+      if (mounted) progress.value = 100;
+    } catch (err) {
+      if (mounted) error.value = err instanceof Error ? err : new Error(String(err));
+    } finally {
+      if (mounted) loading.value = false;
+    }
+  };
+  const exportTable = (options) => {
+    wrapSync(() => {
+      wasmModule.export_table(
+        options.tableId,
+        options.filename,
+        options.format,
+        options.excludeHidden,
+        createProgressCallback(),
+        options.withBom,
+        options.strictProgressCallback
+      );
+    });
+  };
+  const exportData = (data, options) => {
+    wrapSync(() => {
+      const opts = options ? { ...options, progressCallback: options.progressCallback ?? createProgressCallback() } : { progressCallback: createProgressCallback() };
+      wasmModule.export_data(data, opts);
+    });
+  };
+  const exportTablesXlsx = (options) => {
+    wrapSync(() => {
+      wasmModule.export_tables_xlsx(
+        options.sheets,
+        options.filename,
+        createProgressCallback()
+      );
+    });
+  };
+  const exportCsvBatch = async (options) => {
+    await wrapAsync(async () => {
+      await wasmModule.export_table_to_csv_batch(
+        options.tableId,
+        options.tbodyId,
+        options.filename,
+        options.batchSize,
+        options.excludeHidden,
+        createProgressCallback(),
+        options.withBom
+      );
+    });
+  };
+  const exportXlsxBatch = async (options) => {
+    await wrapAsync(async () => {
+      await wasmModule.export_table_to_xlsx_batch(
+        options.tableId,
+        options.tbodyId,
+        options.filename,
+        options.batchSize,
+        options.excludeHidden,
+        createProgressCallback()
+      );
+    });
+  };
+  const exportTablesBatch = async (options) => {
+    await wrapAsync(async () => {
+      await wasmModule.export_tables_to_xlsx_batch(
+        options.sheets,
+        options.filename,
+        options.batchSize,
+        createProgressCallback()
+      );
+    });
+  };
+  return {
+    /** WASM 是否已初始化完成 */
+    initialized,
+    /** 是否正在导出 */
+    loading,
+    /** 导出进度 (0-100) */
+    progress,
+    /** 错误信息 */
+    error,
+    exportTable,
+    exportData,
+    exportTablesXlsx,
+    exportCsvBatch,
+    exportXlsxBatch,
+    exportTablesBatch
+  };
+}
+export {
+  useExporter
+};

package/package.json

@@ -0,0 +1,48 @@
+{
+  "name": "@bsg-export/vue",
+  "version": "1.0.6",
+  "description": "belobog-stellar-grid 的 Vue 3 官方封装组件",
+  "type": "module",
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js"
+    }
+  },
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "build": "vue-tsc --declaration --emitDeclarationOnly --outDir dist && esbuild src/index.ts src/use-exporter.ts --outdir=dist --format=esm --bundle=false",
+    "typecheck": "vue-tsc --noEmit"
+  },
+  "keywords": [
+    "belobog",
+    "stellar-grid",
+    "vue",
+    "export",
+    "table"
+  ],
+  "author": "Kurisu <makise_kurisuu@outlook.jp>",
+  "license": "MIT OR Apache-2.0",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/kurisu994/belobog-stellar-grid",
+    "directory": "packages/vue"
+  },
+  "peerDependencies": {
+    "belobog-stellar-grid": ">=1.0.0",
+    "vue": ">=3.3.0"
+  },
+  "dependencies": {
+    "@bsg-export/types": "file:../types"
+  },
+  "devDependencies": {
+    "esbuild": "^0.25.0",
+    "typescript": "^5.7.0",
+    "vue": "^3.5.0",
+    "vue-tsc": "^2.2.0"
+  }
+}