@platforma-sdk/ui-vue 1.67.0 → 1.68.0

package/src/components/PlAgCsvExporter/export-csv.ts

@@ -1,74 +1,111 @@
-import {
-  type ColDef,
-  type ColGroupDef,
-  createGrid,
-  type GridApi,
-  type GridOptions,
-  ServerSideRowModelModule,
-} from "ag-grid-enterprise";
+import { type ColDef, type ColGroupDef, type GridApi } from "ag-grid-enterprise";
+import type {
+  PTableHandle,
+  PTableDownloadFormat,
+  PTableColumnSpec,
+  PFrameSpecDriver,
+  WritePTableToFsResult,
+} from "@platforma-sdk/model";
+import { getPTableColumnId } from "@platforma-sdk/model";
+import { isNil } from "es-toolkit";
+import { Nil } from "@milaboratories/helpers";
+import { getServices } from "../../internal/getServices";
 
-function createGridDiv(): HTMLDivElement {
-  const div = document.createElement("div");
+/** Options for the native CSV export path. */
+export interface ExportOptions {
+  tableHandle: PTableHandle;
+  format: PTableDownloadFormat;
+  defaultFileName?: string;
+}
 
-  div.style.visibility = "hidden";
-  div.style.position = "absolute";
+/**
+ * CSV export via the platforma desktop runtime. Prompts for a save
+ * destination via the `Dialog` service, then streams the PTable to the
+ * chosen path via `PFrame.writePTableToFs`.
+ */
+export async function exportCsv(
+  gridApi: GridApi,
+  nativeOptions: ExportOptions,
+): Promise<undefined | WritePTableToFsResult> {
+  const { dialog, pframe, pframeSpec } = getServices();
+  if (isNil(dialog)) {
+    throw new Error("dialog service is not available in the current environment");
+  }
+  if (isNil(pframe)) {
+    throw new Error("pframe service is not available");
+  }
+  if (isNil(pframeSpec)) {
+    throw new Error("pframeSpec service is not available");
+  }
 
-  document.body.appendChild(div);
-  return div;
-}
+  const specs = await pframe.getSpec(nativeOptions.tableHandle);
+  const columnIndices = collectVisibleColumnIndices(gridApi, specs, pframeSpec);
+  if (isNil(columnIndices)) {
+    return undefined;
+  }
 
-function destroyGridDiv(cellFake: HTMLDivElement) {
-  document.body.removeChild(cellFake);
-}
+  const { canceled, path } = await dialog.showSaveDialog({
+    defaultFileName:
+      (nativeOptions.defaultFileName ?? `table_${formatTimestamp(new Date())}`) +
+      `.${nativeOptions.format}.gz`,
+  });
+  if (canceled || isNil(path)) {
+    return undefined;
+  }
 
-export async function exportCsv(gridApi: GridApi, completed: () => void) {
-  const rowModel = gridApi.getGridOption("rowModelType");
-  switch (rowModel) {
-    case "clientSide": {
-      gridApi.exportDataAsCsv();
-      return completed();
-    }
+  return pframe.writePTableToFs(nativeOptions.tableHandle, {
+    path,
+    format: nativeOptions.format,
+    columnIndices,
+    compression: { type: "gzip" },
+  });
+}
 
-    case "serverSide": {
-      const state = gridApi.getServerSideGroupLevelState();
-      if (state.length === 0 || state[0].rowCount <= state[0].cacheBlockSize!) {
-        gridApi.exportDataAsCsv();
-        return completed();
-      }
+function formatTimestamp(d: Date): string {
+  const pad = (n: number) => String(n).padStart(2, "0");
+  return (
+    `${pad(d.getDate())}-${pad(d.getMonth() + 1)}-${d.getFullYear()}` +
+    `_${pad(d.getHours())}-${pad(d.getMinutes())}-${pad(d.getSeconds())}`
+  );
+}
 
-      let exportStarted = false;
-      const gridDiv = createGridDiv();
-      const gridOptions: GridOptions = {
-        rowModelType: "serverSide",
-        columnDefs:
-          gridApi
-            .getColumnDefs()
-            ?.filter((def: ColDef | ColGroupDef): def is ColDef => !("children" in def))
-            .map((def) => ({
-              headerName: def.headerName,
-              field: def.field,
-              valueFormatter: def.valueFormatter,
-              valueGetter: def.valueGetter,
-            })) ?? [],
-        serverSideDatasource: gridApi.getGridOption("serverSideDatasource"),
-        cacheBlockSize: state[0].rowCount,
-        onModelUpdated: (event) => {
-          const state = event.api.getServerSideGroupLevelState();
-          if (!exportStarted && state.length > 0 && state[0].rowCount === state[0].cacheBlockSize) {
-            exportStarted = true;
-            event.api.exportDataAsCsv();
-            destroyGridDiv(gridDiv);
-            return completed();
-          }
-        },
-        defaultCsvExportParams: gridApi.getGridOption("defaultCsvExportParams"),
-      };
-      return createGrid(gridDiv, gridOptions, { modules: [ServerSideRowModelModule] });
-    }
+/**
+ * Checks whether the native CSV export capability is available in the
+ * current platforma runtime environment. Both `Dialog` and `PFrame`
+ * services must be present — desktop-app wires them, web/preview do not.
+ */
+export function isCsvExportAvailable(): boolean {
+  try {
+    const services = getServices();
+    return !isNil(services?.dialog) && !isNil(services?.pframe);
+  } catch {
+    return false;
+  }
+}
 
-    default: {
-      completed();
-      throw Error(`exportCsv unsupported for rowModelType = ${rowModel}`);
-    }
+/**
+ * Collect unified column indices for visible (non-hidden) columns from the
+ * ag-grid column defs, remapped onto the provided PTable spec array so the
+ * indices match the current table handle (ColDef.field indices may be stale
+ * or diverge from the spec order).
+ */
+export function collectVisibleColumnIndices(
+  gridApi: GridApi,
+  specs: PTableColumnSpec[],
+  pframeSpec: PFrameSpecDriver,
+): Nil | number[] {
+  const columnDefs = gridApi.getColumnDefs();
+  if (isNil(columnDefs)) {
+    return;
   }
+
+  return columnDefs
+    .filter(
+      (def: ColDef | ColGroupDef): def is ColDef =>
+        !("children" in def) && def.hide !== true && !isNil(def.context),
+    )
+    .map((def) =>
+      pframeSpec.findTableColumn(specs, getPTableColumnId(def.context as PTableColumnSpec)),
+    )
+    .filter((index): index is number => index !== -1);
 }

package/src/components/PlAgDataTable/PlAgDataTableV2.vue

@@ -554,8 +554,13 @@ watchEffect(() => {
       @updateFilters="(v) => (filtersState = v)"
       @resetDefaultFilters="resetDefaultFilters"
       @updateDefaultFilters="(v) => (defaultFiltersState = v)"
+      v-model="filtersState"
+    />
+    <PlAgCsvExporter
+      v-if="gridApi && showExportButton"
+      :api="gridApi"
+      :table-handle="'model' in settings ? settings?.model?.visibleTableHandle : undefined"
     />
-    <PlAgCsvExporter v-if="gridApi && showExportButton" :api="gridApi" />
     <PlAgDataTableSheets v-model="sheetsState" :settings="sheetsSettings">
       <template v-if="$slots['before-sheets']" #before>
         <slot name="before-sheets" />

package/src/components/PlAgDataTable/compositions/useGrid.ts

@@ -81,11 +81,14 @@ export function useGrid({
       text: noRowsText,
     } satisfies PlAgOverlayNoRowsParams,
     defaultCsvExportParams: {
-      allColumns: true,
       suppressQuotes: true,
       columnSeparator: "\t",
       fileName: "table.tsv",
     },
+    getContextMenuItems: (params) =>
+      (params.defaultItems ?? []).filter(
+        (item) => item !== "export" && item !== "csvExport" && item !== "excelExport",
+      ),
     onGridReady: (event) => {
       const api = event.api;
       autoSizeRowNumberColumn(api);

package/src/components/PlAgDataTable/sources/table-source-v2.ts

@@ -396,11 +396,11 @@ function selectDisplayableIndices(
     .filter(([, spec]) => {
       switch (spec.type) {
         case "axis":
-          return !isPartitionedAxis(spec.id);
+          return !isColumnHidden(spec.spec) && !isPartitionedAxis(spec.id);
         case "column":
           return (
-            !isLabelColumnSpec(spec.spec) &&
             !isColumnHidden(spec.spec) &&
+            !isLabelColumnSpec(spec.spec) &&
             !isLinkerColumnSpec(spec.spec)
           );
       }

package/src/{usePlugin.ts → composition/usePlugin.ts}

@@ -1,5 +1,5 @@
 import { inject, type Reactive } from "vue";
-import { pluginDataKey } from "./defineApp";
+import { pluginDataKey } from "../defineApp";
 import type {
   PluginHandle,
   InferFactoryData,

package/src/composition/useServices.ts

@@ -0,0 +1,5 @@
+import { getServices } from "../internal/getServices";
+
+export function useServices() {
+  return getServices();
+}

package/src/internal/createAppV3.ts

@@ -12,8 +12,9 @@ import type {
   PluginHandle,
   InferFactoryData,
   InferFactoryOutputs,
-  InferFactoryUiServices,
   PluginFactoryLike,
+  UiServices as AllUiServices,
+  InferFactoryUiServices,
 } from "@platforma-sdk/model";
 import {
   hasAbortError,
@@ -23,7 +24,6 @@ import {
   isPluginOutputKey,
   pluginOutputPrefix,
 } from "@platforma-sdk/model";
-import { type UiServices as AllUiServices } from "@milaboratories/pl-model-common";
 import type { Ref } from "vue";
 import { reactive, computed, ref, markRaw } from "vue";
 import type { OutputValues, OutputErrors, AppSettings } from "../types";
@@ -32,7 +32,7 @@ import { ensureOutputHasStableFlag, MultiError } from "../utils";
 import { applyPatch } from "fast-json-patch";
 import { UpdateSerializer } from "./UpdateSerializer";
 import { watchIgnorable } from "@vueuse/core";
-import type { PluginState, PluginAccess } from "../usePlugin";
+import type { PluginState, PluginAccess } from "../composition/usePlugin";
 import { logDebug, logError } from "./utils";
 import { getServices } from "./getServices";
 
@@ -208,7 +208,7 @@ export function createAppV3<
         .dispose()
         .then(unwrapResult)
         .catch((err) => {
-          error("error in dispose", err);
+          error("platforma error in dispose", err);
         });
     });
 

package/src/internal/service_factories.ts

@@ -19,5 +19,6 @@ export function createUiServiceRegistry(options: UiServiceOptions) {
   return new UiServiceRegistry(Services, {
     PFrameSpec: () => new SpecDriver(),
     PFrame: () => options.proxy(Services.PFrame),
+    Dialog: () => options.proxy(Services.Dialog),
   });
 }

package/src/lib.ts

@@ -37,8 +37,8 @@ export * from "./components/PlDatasetSelector";
 
 export * from "./defineApp";
 
-export { usePlugin } from "./usePlugin";
-export type { PluginState } from "./usePlugin";
+export { usePlugin } from "./composition/usePlugin";
+export type { PluginState } from "./composition/usePlugin";
 export type {
   PluginHandle,
   PluginFactoryLike,

package/dist/usePlugin.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"usePlugin.d.ts","sourceRoot":"","sources":["../src/usePlugin.ts"],"names":[],"mappings":"AAAA,OAAO,EAAU,KAAK,QAAQ,EAAE,MAAM,KAAK,CAAC;AAE5C,OAAO,KAAK,EACV,YAAY,EACZ,gBAAgB,EAChB,mBAAmB,EACnB,sBAAsB,EACtB,iBAAiB,EAClB,MAAM,sBAAsB,CAAC;AAE9B,sEAAsE;AACtE,MAAM,WAAW,WAAW,CAC1B,IAAI,GAAG,OAAO,EACd,OAAO,GAAG,OAAO,EACjB,QAAQ,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC;IAElC,QAAQ,CAAC,KAAK,EAAE,QAAQ,CAAC;QACvB,IAAI,EAAE,IAAI,CAAC;QACX,OAAO,EAAE,OAAO,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAC5C;aAAG,CAAC,IAAI,MAAM,OAAO,GAAG,OAAO,CAAC,CAAC,CAAC,GAAG,SAAS;SAAE,GAChD,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;QAC5B,YAAY,EAAE,OAAO,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GACjD;aAAG,CAAC,IAAI,MAAM,OAAO,CAAC,CAAC,EAAE,KAAK;SAAE,GAChC,MAAM,CAAC,MAAM,EAAE,KAAK,GAAG,SAAS,CAAC,CAAC;KACvC,CAAC,CAAC;IACH,QAAQ,CAAC,QAAQ,EAAE,QAAQ,CAAC;CAC7B;AAED,wFAAwF;AACxF,MAAM,WAAW,YAAY;IAC3B,sBAAsB,CAAC,CAAC,SAAS,iBAAiB,EAChD,MAAM,EAAE,YAAY,CAAC,CAAC,CAAC,GACtB,WAAW,CAAC,gBAAgB,CAAC,CAAC,CAAC,EAAE,mBAAmB,CAAC,CAAC,CAAC,EAAE,sBAAsB,CAAC,CAAC,CAAC,CAAC,CAAC;CACxF;AAED;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,wBAAgB,SAAS,CAAC,CAAC,SAAS,iBAAiB,EAAE,MAAM,EAAE,YAAY,CAAC,CAAC,CAAC,uFAW7E"}

package/dist/usePlugin.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"usePlugin.js","names":[],"sources":["../src/usePlugin.ts"],"sourcesContent":["import { inject, type Reactive } from \"vue\";\nimport { pluginDataKey } from \"./defineApp\";\nimport type {\n  PluginHandle,\n  InferFactoryData,\n  InferFactoryOutputs,\n  InferFactoryUiServices,\n  PluginFactoryLike,\n} from \"@platforma-sdk/model\";\n\n/** Per-plugin reactive model exposed to consumers via usePlugin(). */\nexport interface PluginState<\n  Data = unknown,\n  Outputs = unknown,\n  Services = Record<string, unknown>,\n> {\n  readonly model: Reactive<{\n    data: Data;\n    outputs: Outputs extends Record<string, unknown>\n      ? { [K in keyof Outputs]: Outputs[K] | undefined }\n      : Record<string, unknown>;\n    outputErrors: Outputs extends Record<string, unknown>\n      ? { [K in keyof Outputs]?: Error }\n      : Record<string, Error | undefined>;\n  }>;\n  readonly services: Services;\n}\n\n/** Internal interface for plugin access — provided via Vue injection to usePlugin(). */\nexport interface PluginAccess {\n  getOrCreatePluginState<F extends PluginFactoryLike>(\n    handle: PluginHandle<F>,\n  ): PluginState<InferFactoryData<F>, InferFactoryOutputs<F>, InferFactoryUiServices<F>>;\n}\n\n/**\n * Composable for accessing a plugin's reactive model: data, outputs, and outputErrors.\n *\n * Mirrors the `app.model` access pattern — `plugin.model.data` is reactive and deep-watched,\n * mutations are automatically queued and sent to storage.\n *\n * @param handle - Opaque plugin handle obtained from `app.plugins`.\n * @typeParam F - The plugin factory type (inferred from the handle)\n *\n * @example\n * ```vue\n * <script setup lang=\"ts\">\n * import { usePlugin, type InferPluginHandle } from '@platforma-sdk/ui-vue';\n * import type { CounterPlugin } from './plugins/counter';\n *\n * const props = defineProps<{ instance: InferPluginHandle<CounterPlugin> }>();\n * const plugin = usePlugin(props.instance);\n *\n * plugin.model.data.count += 1;          // reactive, triggers storage update\n * plugin.model.outputs.displayText       // computed, plugin's own outputs only\n * plugin.model.outputErrors.displayText  // Error | undefined\n * </script>\n * ```\n */\nexport function usePlugin<F extends PluginFactoryLike>(handle: PluginHandle<F>) {\n  const access = inject<PluginAccess>(pluginDataKey);\n\n  if (!access) {\n    throw new Error(\n      \"usePlugin requires a V3 block (BlockModelV3). \" +\n        \"Make sure the block uses apiVersion 3 and the plugin is installed.\",\n    );\n  }\n\n  return access.getOrCreatePluginState<F>(handle);\n}\n"],"mappings":";;;AA2DA,SAAgB,EAAuC,GAAyB;CAC9E,IAAM,IAAS,EAAqB,EAAc;AAElD,KAAI,CAAC,EACH,OAAU,MACR,mHAED;AAGH,QAAO,EAAO,uBAA0B,EAAO"}