@atscript/vue-table 0.1.132 → 0.1.134

package/dist/index.mjs

@@ -1,36 +1,191 @@
-import { a as useTableContext, m as extractIdentifier, n as createTableState, o as useTableContextOptional, t as createStaticTableState, x as ROW_ACTIONS_TYPE } from "./use-table-state-BxX3SpeW.mjs";
-import { n as useTableSelection } from "./use-table-selection-C84z4OZy.mjs";
-import { a as AS_PRESETS_APP, i as useLocalDraft, n as useTable, o as injectPresetsApp, r as usePresets, t as clearTableCache } from "./use-table-CyFcVtUN.mjs";
-import { t as useTableNavBridge } from "./use-table-nav-bridge-DeGeaQX-.mjs";
-import { t as useTableComponent } from "./use-table-component-K6xj1obF.mjs";
-import { t as getCellValue } from "./get-cell-value-C8LLc_Rr.mjs";
-import { t as as_cell_array_default } from "./as-cell-array-2qmJ1lT2.mjs";
-import { t as as_cell_date_default } from "./as-cell-date-BwFgi6O0.mjs";
-import { n as useCellLocale, t as provideCellLocale } from "./use-cell-locale-MQXoONh5.mjs";
-import { t as as_cell_json_default } from "./as-cell-json--95Xq6yq.mjs";
-import { t as as_cell_number_default } from "./as-cell-number-DKRaS9pM.mjs";
-import { t as formatCellValue } from "./format-cell-D1Ziv96Q.mjs";
-import { t as as_cell_union_default } from "./as-cell-union-C9FukGqF.mjs";
-import { t as as_column_menu_default } from "./as-column-menu-kTIQfLTi.mjs";
-import { t as as_config_dialog_default } from "./as-config-dialog-BehfqIGd.mjs";
-import { t as as_confirm_dialog_default } from "./as-confirm-dialog-bpN4A-KN.mjs";
-import { t as as_filter_input_default } from "./as-filter-input-BM23TNeh.mjs";
-import { t as as_filter_dialog_default } from "./as-filter-dialog-D1qzq-8b.mjs";
-import { t as as_table_header_cell_default } from "./as-table-header-cell-Bdhl5Lox.mjs";
-import { t as as_window_table_default } from "./as-window-table-DWujiUQy.mjs";
-import { t as as_filter_field_default } from "./as-filter-field-DirBmnbb.mjs";
-import { t as as_filters_default } from "./as-filters-beIud9sF.mjs";
-import { t as as_preset_dialog_default } from "./as-preset-dialog-CDqCAR7N.mjs";
-import { t as as_row_actions_default } from "./as-row-actions-xqJeAdQl.mjs";
-import { t as as_table_cell_value_default } from "./as-table-cell-value-CPcFxSOj.mjs";
-import { t as as_table_root_default } from "./as-table-root-BLReUbRH.mjs";
-import { t as as_table_default } from "./as-table-CDSG2yED.mjs";
-import { t as as_table_actions_default } from "./as-table-actions-DMxeaczm.mjs";
-import { t as as_preset_picker_default } from "./as-preset-picker-CISaxEZ0.mjs";
+import { D as ROW_ACTIONS_TYPE, a as useTableContext, b as extractIdentifier, n as createTableState, o as useTableContextOptional, r as provideTableContext, t as createStaticTableState } from "./use-table-state-mBXx11aH.mjs";
+import { t as getCellValue } from "./get-cell-value-Cb3X8nUn.mjs";
+import { n as useTableSelection } from "./use-table-selection-ULbKT2xW.mjs";
+import { a as useLocalDraft, i as usePresets, o as AS_PRESETS_APP, r as useTable, s as injectPresetsApp, t as clearTableCache } from "./use-table-BFhbfWgY.mjs";
+import { t as useTableNavBridge } from "./use-table-nav-bridge-DzJN5v9a.mjs";
+import { t as useTableComponent } from "./use-table-component-CRmLHdqi.mjs";
+import { t as as_table_root_default } from "./as-table-root-C1A6JkwL.mjs";
+import { t as as_cell_array_default } from "./as-cell-array-BWHkJX3I.mjs";
+import { t as as_cell_date_default } from "./as-cell-date-mGlnDeLP.mjs";
+import { n as useCellLocale, t as provideCellLocale } from "./use-cell-locale-CxQOQsns.mjs";
+import { t as as_cell_json_default } from "./as-cell-json-2I081xnO.mjs";
+import { t as as_cell_number_default } from "./as-cell-number-CP2AZI9g.mjs";
+import { t as formatCellValue } from "./format-cell-Bx7wNc4X.mjs";
+import { t as as_cell_union_default } from "./as-cell-union-NHpDCXty.mjs";
+import { t as as_column_menu_default } from "./as-column-menu-BMTS3DO2.mjs";
+import { t as as_config_dialog_default } from "./as-config-dialog-BUBHiVlf.mjs";
+import { t as as_confirm_dialog_default } from "./as-confirm-dialog-G4ZoL_Xo.mjs";
+import { t as as_filter_input_default } from "./as-filter-input-C8KmOus8.mjs";
+import { t as as_filter_dialog_default } from "./as-filter-dialog-BJWH8cvc.mjs";
+import { t as as_table_header_cell_default } from "./as-table-header-cell-Xd3cvnII.mjs";
+import { t as as_window_table_default } from "./as-window-table-BH0tDDnr.mjs";
+import { t as as_filter_field_default } from "./as-filter-field-B2skq4K0.mjs";
+import { t as as_filters_default } from "./as-filters-DogNVlqr.mjs";
+import { t as as_preset_dialog_default } from "./as-preset-dialog-BwHV6Y77.mjs";
+import { t as as_row_actions_default } from "./as-row-actions-BkIsJVBm.mjs";
+import { t as as_table_cell_value_default } from "./as-table-cell-value-BVcfhhCb.mjs";
+import { t as as_table_default } from "./as-table-BEvsX87E.mjs";
+import { t as as_table_actions_default } from "./as-table-actions-B5upF1bQ.mjs";
+import { t as as_preset_picker_default } from "./as-preset-picker-B0JnyAPA.mjs";
 import { getDefaultClientFactory, resetDefaultClientFactory, setDefaultClientFactory } from "@atscript/ui";
 import { computed, effectScope, ref, shallowRef } from "vue";
-import { AppPrefsClient, PRESET_ASPECTS, STANDARD_PRESET_ID, SYSTEM_PRESET_PREFIX, columnFilterType, conditionsForType, defaultCondition, isAuthError, isFilled, isSystemPresetId, resolveSystemPresets } from "@atscript/ui-table";
+import { AppPrefsClient, ExportAbortError, PRESET_ASPECTS, STANDARD_PRESET_ID, SYSTEM_PRESET_PREFIX, collectExportRows, columnFilterType, conditionsForType, defaultCondition, isFilled, isSystemPresetId, isUnavailableError, resolveExportValue, resolveSystemPresets, toCsv, urlQueryConsumesKey, withStableOrder } from "@atscript/ui-table";
 import { StorageSerializers, useEventBus, useStorage } from "@vueuse/core";
+//#region src/composables/use-table-export.ts
+/**
+* Export the table's data as it is queried right now.
+*
+* The export snapshots the table's own query at call time — the same filters,
+* sorters, search term, force-filters and `$select` projection the on-screen
+* fetch uses (`state.buildQuery()`), through the same fetch path
+* (`state.fetchPage()`, so a custom `queryFn` is honoured) — then pages
+* through every result instead of one page. The primary key(s) are appended
+* to the sort as a tiebreaker so pages never overlap or skip.
+*
+* Values come out of the same column metadata the cells read: union/enum keys
+* become their labels, dates become ISO strings, arrays join. Override per
+* column with `formatters`, or globally with `formatCell`.
+*
+* ```ts
+* const { exportRows } = useTableExport()
+* downloadExport(await exportRows({ filename: "orders.csv", csv: { bom: true } }))
+* ```
+*
+* Since 0.1.134.
+*/
+function useTableExport(ctx) {
+	const state = (ctx ?? useTableContext()).state;
+	const progress = ref(null);
+	const exporting = computed(() => progress.value !== null);
+	function resolveColumns(selection, opts) {
+		if (selection && selection !== "visible") {
+			const byPath = new Map(state.allColumns.value.map((c) => [c.path, c]));
+			return selection.map((path) => byPath.get(path) ?? rawColumn(path));
+		}
+		const local = state.localColumnPaths.value;
+		const visible = state.columns.value;
+		if (local.size === 0) return visible;
+		return visible.filter((c) => !local.has(c.path) || opts.formatters?.[c.path]);
+	}
+	/**
+	* One value resolver per column, built once per run: the formatter lookup
+	* and the union-option index happen here instead of per cell.
+	*/
+	function resolversFor(columns, opts) {
+		return columns.map((column) => {
+			const perColumn = opts.formatters?.[column.path];
+			const formatCell = opts.formatCell;
+			const labels = column.options?.length ? new Map(column.options.map((o) => [o.key, o.label])) : null;
+			return (row) => {
+				const raw = getCellValue(row, column.path);
+				if (perColumn) {
+					const out = perColumn(raw, column, row);
+					if (out !== void 0) return out;
+				}
+				if (formatCell) {
+					const out = formatCell(raw, column, row);
+					if (out !== void 0) return out;
+				}
+				if (labels !== null && (typeof raw === "string" || typeof raw === "number")) {
+					const hit = labels.get(String(raw));
+					if (hit !== void 0) return hit;
+				}
+				return resolveExportValue(raw);
+			};
+		});
+	}
+	async function exportRows(opts = {}) {
+		if (progress.value !== null) throw new Error("[vue-table] exportRows() is already running on this handle.");
+		const columns = resolveColumns(opts.columns, opts);
+		const columnPaths = columns.map((c) => c.path);
+		const query = withStableOrder(state.buildQuery({
+			columnPaths,
+			includeActions: false
+		}), state.tableDef.value?.primaryKeys ?? []);
+		const resolvers = resolversFor(columns, opts);
+		progress.value = { done: 0 };
+		try {
+			const { rows: matrix, total } = await collectExportRows({
+				query,
+				pageSize: opts.pageSize,
+				maxRows: opts.maxRows,
+				signal: opts.signal,
+				fetchPage: state.fetchPage,
+				mapRow: (row) => resolvers.map((resolve) => resolve(row)),
+				onProgress: (done, reported) => {
+					progress.value = {
+						done,
+						total: reported
+					};
+					opts.onProgress?.(done, reported);
+				}
+			});
+			const header = columns.map((c) => c.label || c.path);
+			const base = {
+				columns: header,
+				columnPaths,
+				rowCount: matrix.length,
+				total
+			};
+			if (opts.format === "rows") return {
+				...base,
+				format: "rows",
+				rows: matrix
+			};
+			return {
+				...base,
+				format: "csv",
+				filename: withCsvSuffix(opts.filename ?? "export.csv"),
+				csv: toCsv(header, matrix, opts.csv)
+			};
+		} finally {
+			progress.value = null;
+		}
+	}
+	return {
+		exportRows,
+		exporting,
+		progress
+	};
+}
+/**
+* Hand a finished CSV export to the browser as a file download. Returns
+* `false` without doing anything when there is no DOM (SSR / a worker), so a
+* server render can call it unguarded.
+*
+* Since 0.1.134.
+*/
+function downloadExport(result) {
+	if (result.format !== "csv") throw new Error("[vue-table] downloadExport() needs a `format: 'csv'` export result.");
+	if (typeof document === "undefined" || typeof URL?.createObjectURL !== "function") return false;
+	const blob = new Blob([result.csv], { type: "text/csv;charset=utf-8" });
+	const href = URL.createObjectURL(blob);
+	const anchor = document.createElement("a");
+	anchor.href = href;
+	anchor.download = result.filename;
+	anchor.style.display = "none";
+	document.body.appendChild(anchor);
+	anchor.click();
+	anchor.remove();
+	URL.revokeObjectURL(href);
+	return true;
+}
+function withCsvSuffix(name) {
+	return name.toLowerCase().endsWith(".csv") ? name : `${name}.csv`;
+}
+/** Minimal column for an export path that is not one of the table's columns. */
+function rawColumn(path) {
+	return {
+		path,
+		label: path,
+		type: "text",
+		sortable: false,
+		filterable: false,
+		nullable: true,
+		order: 0
+	};
+}
+//#endregion
 //#region src/composables/use-table-filter.ts
 /**
 * Per-field filter state composable.
@@ -187,11 +342,19 @@ function findCleanEq(segment) {
 * dependency on `vue-router` is added to `@atscript/vue-table`. Consumers
 * pass in their already-resolved `useRoute()` and `useRouter()` instances.
 *
-* Scope: **owns the whole query string**. The getter returns the entire
-* `route.query` serialized; the setter replaces `route.query` wholesale.
-* Apps that need the table to coexist with non-table query params should
-* write their own `computed` instead — that pattern is small and keeps the
-* library's contract crisp.
+* Scope: the bridge owns **only what the table reads back** (since 0.1.133).
+* A key is the table's iff `urlQueryStringToState` would consume it — see
+* `urlQueryConsumesKey` — or the bridge has written it before. Read and
+* write therefore agree in both directions: a key the parser ignores (a host
+* flag, an unrecognised `$control`) is never removed, and a key the parser
+* reads is the bridge's to remove. Every write merges into the current
+* `route.query`, in place.
+*
+* Without a `prefix` the bridge cannot tell a plain `field=value` filter from
+* a page-owned flag of the same shape, so a plain key that was already in the
+* URL when the bridge mounted counts as foreign until the bridge writes it
+* itself. Pass `prefix` when a route carries a host key that could collide
+* with a column path, or when it carries two tables.
 *
 * @example
 * ```vue
@@ -199,6 +362,9 @@ function findCleanEq(segment) {
 * import { useRoute, useRouter } from 'vue-router';
 * import { useTableUrlQuery } from '@atscript/vue-table';
 * const urlQuery = useTableUrlQuery(useRoute(), useRouter());
+* // Two tables on one route:
+* // const left = useTableUrlQuery(useRoute(), useRouter(), { prefix: 'a' });
+* // const right = useTableUrlQuery(useRoute(), useRouter(), { prefix: 'b' });
 * <\/script>
 * <template>
 *   <AsTableRoot v-model:url-query="urlQuery" url="/db/products" .../>
@@ -207,25 +373,46 @@ function findCleanEq(segment) {
 */
 function useTableUrlQuery(route, router, opts = {}) {
 	const navigate = (opts.mode ?? "replace") === "push" ? router.push.bind(router) : router.replace.bind(router);
+	const prefix = opts.prefix ? `${opts.prefix}.` : "";
+	const written = /* @__PURE__ */ new Set();
+	function isOwn(key) {
+		if (prefix) return key.startsWith(prefix);
+		return written.has(key) || urlQueryConsumesKey(key);
+	}
 	return computed({
 		get: () => {
 			const q = route.query;
 			const parts = [];
 			for (const key in q) {
+				if (prefix && !key.startsWith(prefix)) continue;
+				const own = prefix ? key.slice(prefix.length) : key;
 				const v = q[key];
-				if (Array.isArray(v)) for (const item of v) parts.push(item == null ? key : `${key}=${item}`);
-				else if (v == null) parts.push(key);
-				else parts.push(`${key}=${v}`);
+				if (Array.isArray(v)) for (const item of v) parts.push(item == null ? own : `${own}=${item}`);
+				else if (v == null) parts.push(own);
+				else parts.push(`${own}=${v}`);
 			}
 			return parts.join("&");
 		},
 		set: (urlString) => {
-			const query = {};
+			const serialized = /* @__PURE__ */ new Map();
 			for (const segment of splitSegments(urlString)) {
 				const eqIdx = findCleanEq(segment);
-				if (eqIdx > 0) query[segment.slice(0, eqIdx)] = segment.slice(eqIdx + 1);
-				else query[segment] = null;
+				const key = eqIdx > 0 ? `${prefix}${segment.slice(0, eqIdx)}` : `${prefix}${segment}`;
+				serialized.set(key, eqIdx > 0 ? segment.slice(eqIdx + 1) : null);
+				written.add(key);
+			}
+			const query = {};
+			for (const key in route.query) {
+				if (!isOwn(key)) {
+					query[key] = route.query[key];
+					continue;
+				}
+				if (serialized.has(key)) {
+					query[key] = serialized.get(key);
+					serialized.delete(key);
+				}
 			}
+			for (const [key, value] of serialized) query[key] = value;
 			navigate({ query });
 		}
 	});
@@ -316,7 +503,7 @@ function createInstance(app, opts) {
 				cache.value = { ...result.prefs };
 				existing.value = result.row;
 			} catch (err) {
-				if (isAuthError(err)) {
+				if (isUnavailableError(err)) {
 					denied.value = true;
 					clearCache();
 					existing.value = null;
@@ -497,4 +684,4 @@ function getColumnWidth(column) {
 	return column.width || DEFAULT_WIDTHS[column.type] || "15em";
 }
 //#endregion
-export { AS_PRESETS_APP, as_cell_array_default as AsCellArray, as_cell_date_default as AsCellDate, as_cell_json_default as AsCellJson, as_cell_number_default as AsCellNumber, as_cell_union_default as AsCellUnion, as_column_menu_default as AsColumnMenu, as_config_dialog_default as AsConfigDialog, as_confirm_dialog_default as AsConfirmDialog, as_filter_dialog_default as AsFilterDialog, as_filter_field_default as AsFilterField, as_filter_input_default as AsFilterInput, as_filters_default as AsFilters, as_preset_dialog_default as AsPresetDialog, as_preset_picker_default as AsPresetPicker, as_row_actions_default as AsRowActions, as_table_default as AsTable, as_table_actions_default as AsTableActions, as_table_cell_value_default as AsTableCellValue, as_table_header_cell_default as AsTableHeaderCell, as_table_root_default as AsTableRoot, as_window_table_default as AsWindowTable, PRESET_ASPECTS, STANDARD_PRESET_ID, SYSTEM_PRESET_PREFIX, clearTableCache, createDefaultCellTypes, createDefaultControls, createStaticTableState, createTableState, extractIdentifier, formatCellValue, getCellValue, getColumnWidth, getDefaultClientFactory, injectPresetsApp, isSystemPresetId, provideCellLocale, resetDefaultClientFactory, resolveSystemPresets, setDefaultClientFactory, useAppPrefs, useCellLocale, useLocalDraft, usePresets, useTable, useTableActions, useTableComponent, useTableContext, useTableContextOptional, useTableFilter, useTableNavBridge, useTableSearch, useTableSelection, useTableUrlQuery };
+export { AS_PRESETS_APP, as_cell_array_default as AsCellArray, as_cell_date_default as AsCellDate, as_cell_json_default as AsCellJson, as_cell_number_default as AsCellNumber, as_cell_union_default as AsCellUnion, as_column_menu_default as AsColumnMenu, as_config_dialog_default as AsConfigDialog, as_confirm_dialog_default as AsConfirmDialog, as_filter_dialog_default as AsFilterDialog, as_filter_field_default as AsFilterField, as_filter_input_default as AsFilterInput, as_filters_default as AsFilters, as_preset_dialog_default as AsPresetDialog, as_preset_picker_default as AsPresetPicker, as_row_actions_default as AsRowActions, as_table_default as AsTable, as_table_actions_default as AsTableActions, as_table_cell_value_default as AsTableCellValue, as_table_header_cell_default as AsTableHeaderCell, as_table_root_default as AsTableRoot, as_window_table_default as AsWindowTable, ExportAbortError, PRESET_ASPECTS, STANDARD_PRESET_ID, SYSTEM_PRESET_PREFIX, clearTableCache, createDefaultCellTypes, createDefaultControls, createStaticTableState, createTableState, downloadExport, extractIdentifier, formatCellValue, getCellValue, getColumnWidth, getDefaultClientFactory, injectPresetsApp, isSystemPresetId, provideCellLocale, provideTableContext, resetDefaultClientFactory, resolveSystemPresets, setDefaultClientFactory, useAppPrefs, useCellLocale, useLocalDraft, usePresets, useTable, useTableActions, useTableComponent, useTableContext, useTableContextOptional, useTableExport, useTableFilter, useTableNavBridge, useTableSearch, useTableSelection, useTableUrlQuery };