react-semaphor 0.1.178 → 0.1.180

package/dist/types/main.d.ts

@@ -243,6 +243,26 @@ declare type Actions_3 = TableActions & ExplorerActions & DrillActions & {
     setOnClose: (onClose: () => void) => void;
 };
 
+/**
+ * Represents an active or recently completed export job.
+ */
+export declare interface ActiveExport {
+    id: string;
+    status: 'pending' | 'processing' | 'chunking' | 'compacting' | 'completed' | 'failed' | 'cancelled';
+    progress: number;
+    title: string;
+    totalRows: number;
+    totalChunks: number;
+    completedChunks: number;
+    startedAt: Date;
+    lastUpdatedAt: Date;
+    completedAt?: Date;
+    downloadUrl?: string;
+    fileSize?: number;
+    error?: string;
+    expiresAt: Date;
+}
+
 export declare function AdvancedModeToggle({ className, switchClassName, }: AdvancedModeToggleProps): JSX.Element | null;
 
 declare interface AdvancedModeToggleProps {
@@ -424,6 +444,11 @@ export declare interface CalculatedFieldFormula {
  */
 export declare type CalculatedFieldOperation = 'sum' | 'difference' | 'product' | 'ratio' | 'change' | 'percentage' | 'scale' | 'custom';
 
+/**
+ * Cancel/delete an export job
+ */
+export declare function cancelExport(apiServiceUrl: string, token: string, exportId: string): Promise<void>;
+
 export declare interface CardConfig {
     groupByColumns?: GroupByField[];
     metricColumns?: MetricField[];
@@ -483,6 +508,8 @@ export declare interface CardInteractionConfig {
 
 export declare type CardMode = 'explorer' | 'dev';
 
+export declare type CardType = 'table' | 'aggregateTable' | 'pivotTable';
+
 declare type CardWithContent = BaseCustomCard & {
     content: React.FC<{
         card: TCard;
@@ -692,6 +719,41 @@ export declare type ContainerId = 'groupBy' | 'metrics' | 'pivotBy' | 'sortBy' |
  */
 export declare const createEmptyKpiConfig: () => CardConfig;
 
+/**
+ * Create a new export job
+ */
+export declare function createExport(apiServiceUrl: string, token: string, params: CreateExportRequest): Promise<CreateExportResponse>;
+
+/** Request to create a new export job */
+export declare interface CreateExportRequest {
+    type: 'visual' | 'card';
+    dashboardId: string;
+    visualId?: string;
+    cardId?: string;
+    title?: string;
+    connection_id: string;
+    cardType: string;
+    cardConfig: CardConfig;
+    cardDataSource: DataSource;
+    active_filters: TFilterValue[];
+    timezone?: string;
+    totalRows: number;
+    format: ExportFormat;
+    formatOptions?: ExportFormattingConfig;
+}
+
+/** Response from creating an export job */
+export declare interface CreateExportResponse {
+    exportId: string;
+    status: ExportStatus;
+    totalChunks: number;
+    chunkSize: number;
+    estimatedRows: number;
+    wasTruncated?: boolean;
+    originalRows?: number;
+    maxRows?: number;
+}
+
 declare interface CreateResourceRequest {
     title: string;
     description?: string;
@@ -1297,6 +1359,13 @@ declare interface ExplorerActions {
     reorderJoins: (cardId: string, joinIds: string[]) => void;
 }
 
+/** API error response */
+export declare interface ExportApiError {
+    error: string;
+    message?: string;
+    details?: string;
+}
+
 export declare type ExportDataPayload = {
     cardId: string;
     title: string;
@@ -1304,6 +1373,111 @@ export declare type ExportDataPayload = {
     sql: string;
 };
 
+export declare class ExportError extends Error {
+    readonly status: number;
+    readonly details?: ExportApiError | undefined;
+    constructor(message: string, status: number, details?: ExportApiError | undefined);
+}
+
+export declare type ExportFormat = 'csv';
+
+/** Formatting configuration passed to the export job */
+export declare interface ExportFormattingConfig {
+    useFormattedValues: boolean;
+    timezone: string;
+    locale: string;
+    delimiter: ',' | ';' | '\t';
+    includeHeaders: boolean;
+    columnSettings?: Record<string, unknown>;
+    visibleColumns?: string[];
+}
+
+/** Export job from list endpoint */
+export declare interface ExportJobListItem {
+    id: string;
+    title?: string;
+    status: ExportStatus;
+    format: string;
+    totalRows: number;
+    completedChunks: number;
+    totalChunks: number;
+    fileSize?: number;
+    error?: string;
+    createdAt: string;
+    completedAt?: string;
+    expiresAt: string;
+    dashboardId?: string;
+    cardId?: string;
+}
+
+/** Export job status response */
+export declare interface ExportJobStatus {
+    id: string;
+    status: ExportStatus;
+    progress: number;
+    totalRows: number;
+    completedChunks: number;
+    totalChunks: number;
+    fileSize?: number;
+    error?: string;
+    createdAt: string;
+    completedAt?: string;
+    expiresAt: string;
+}
+
+/**
+ * Individual export notification item.
+ *
+ * Shows different UI based on export status:
+ * - In Progress: Progress bar with percentage
+ * - Completed: Download button with file size
+ * - Failed: Error message with dismiss option
+ */
+export declare function ExportNotificationItem({ export: exp, onRemove, }: ExportNotificationItemProps): JSX.Element;
+
+declare interface ExportNotificationItemProps {
+    /** The export data to display */
+    export: ActiveExport;
+    /** Called when user clicks dismiss/remove */
+    onRemove?: (id: string) => void;
+}
+
+/**
+ * List of export notifications.
+ *
+ * Displays all active and recent exports with their status,
+ * progress, and download options.
+ */
+export declare function ExportNotificationList(): JSX.Element;
+
+export declare type ExportStatus = 'pending' | 'processing' | 'chunking' | 'compacting' | 'completed' | 'failed' | 'cancelled';
+
+declare type ExportStore = ExportStoreState & {
+    actions: ExportStoreActions;
+};
+
+declare type ExportStoreActions = {
+    /** Add a new export to the store */
+    addExport: (exportData: ActiveExport) => void;
+    /** Update an existing export */
+    updateExport: (id: string, updates: Partial<ActiveExport>) => void;
+    /** Remove an export from the store */
+    removeExport: (id: string) => void;
+    /** Get all in-progress exports */
+    getInProgressExports: () => ActiveExport[];
+    /** Get all exports as an array */
+    getAllExports: () => ActiveExport[];
+    /** Clear all completed/failed exports */
+    clearCompleted: () => void;
+    /** Check if there are any in-progress exports */
+    hasInProgressExports: () => boolean;
+};
+
+declare type ExportStoreState = {
+    /** Map of export ID to export data */
+    activeExports: Map<string, ActiveExport>;
+};
+
 export declare interface Field {
     /**
      * Unique identifier for this field instance (for joins, UI state, etc.).
@@ -1458,6 +1632,11 @@ export declare type FilterValue = string | number | boolean | Date | null | [num
 
 export declare function fmt(str: string): string;
 
+/**
+ * Format file size in human readable format
+ */
+export declare function formatFileSize(bytes?: number): string;
+
 export declare function getColumnDataType(column: TDataColumn): string;
 
 export declare type GetDashboardResponse = {
@@ -1468,6 +1647,28 @@ export declare type GetDashboardResponse = {
     assistantProfileId?: string;
 };
 
+/**
+ * Get download URL for a completed export
+ *
+ * The backend returns a presigned S3 URL in JSON response.
+ */
+export declare function getDownloadUrl(apiServiceUrl: string, token: string, exportId: string): Promise<string>;
+
+/**
+ * Get list of user's exports
+ */
+export declare function getExports(apiServiceUrl: string, token: string, options?: {
+    status?: ExportStatus[];
+    limit?: number;
+}): Promise<{
+    exports: ExportJobListItem[];
+}>;
+
+/**
+ * Get status of a specific export job
+ */
+export declare function getExportStatus(apiServiceUrl: string, token: string, exportId: string): Promise<ExportJobStatus>;
+
 export declare function getFilterValueType(filter: TFilter): "string" | "number" | "date" | "boolean";
 
 export declare function getFormattedTableNameForQuery({ schemaName, tableName, modelName, connectionType, databaseName, }: {
@@ -1685,6 +1886,16 @@ export declare function isColumnInSqlGen(column: TDataColumn, sqlGen: SqlGen): b
 
 export declare function isDateDataType(dataType: string): boolean;
 
+/**
+ * Check if an export has completed (successfully or with failure)
+ */
+export declare function isExportComplete(status: ExportStatus): boolean;
+
+/**
+ * Check if an export is still in progress
+ */
+export declare function isExportInProgress(status: ExportStatus): boolean;
+
 export declare function isNumberDataType(dataType: string): boolean;
 
 export declare function isTextDataType(dataType: string): boolean;
@@ -1822,6 +2033,17 @@ export declare type ModelItem = DropdownItem;
 
 declare type NoneOptions = {};
 
+/**
+ * Notification bell icon with badge.
+ *
+ * Shows a badge when there are:
+ * - In-progress exports (shows count)
+ * - Completed exports that haven't been dismissed (shows dot)
+ *
+ * Clicking opens a popover with the full export notification list.
+ */
+export declare function NotificationBell(): JSX.Element;
+
 export declare type NumberAxisFormat = {
     decimalPlaces?: number;
     suffix?: string;
@@ -3110,6 +3332,8 @@ export declare interface URLParameter {
     field?: Field;
 }
 
+export declare const useActiveExports: () => Map<string, ActiveExport>;
+
 export declare function useCard(cardId: string): {
     data: any;
     card: TCard;
@@ -3233,6 +3457,42 @@ setState(nextStateOrUpdater: EditorStore | Partial<EditorStore> | ((state: Writa
 setState(nextStateOrUpdater: EditorStore | ((state: WritableDraft<EditorStore>) => void), shouldReplace: true): void;
 }>;
 
+export declare const useExportActions: () => ExportStoreActions;
+
+/**
+ * Hook that manages smart polling for export status updates.
+ *
+ * Features:
+ * - Dynamic polling intervals (10s → 15s → 30s) based on export duration
+ * - Page Visibility API integration (pauses when tab is hidden)
+ * - Automatic download URL fetching when export completes
+ * - Only polls when there are in-progress exports
+ *
+ * @returns Object with polling state
+ */
+export declare function useExportPolling(): {
+    isPolling: boolean;
+    isTabVisible: boolean;
+    inProgressCount: number;
+};
+
+/**
+ * Hook that recovers active exports when the app mounts or page refreshes.
+ *
+ * This ensures that:
+ * - Users don't lose track of their exports after a page refresh
+ * - The notification tray shows all in-progress exports
+ * - Polling resumes for any ongoing exports
+ *
+ * Should be called once at the app root level (e.g., in dashboard-plus.tsx).
+ */
+export declare function useExportRecovery(): void;
+
+export declare const useExportStore: UseBoundStore<Omit<StoreApi<ExportStore>, "setState"> & {
+setState(nextStateOrUpdater: ExportStore | Partial<ExportStore> | ((state: WritableDraft<ExportStore>) => void), shouldReplace?: false): void;
+setState(nextStateOrUpdater: ExportStore | ((state: WritableDraft<ExportStore>) => void), shouldReplace: true): void;
+}>;
+
 /**
  * Hook that exposes print state to the window object for Lambda/Puppeteer to access.
  *
@@ -3253,6 +3513,8 @@ setState(nextStateOrUpdater: EditorStore | ((state: WritableDraft<EditorStore>)
  */
 export declare function useExposePrintState(isPdfRender: boolean, printState: PrintState | null): void;
 
+export declare const useInProgressExportsCount: () => number;
+
 export declare const useManagementStore: UseBoundStore<Omit<StoreApi<ManagementStore>, "setState"> & {
 setState(nextStateOrUpdater: ManagementStore | Partial<ManagementStore> | ((state: WritableDraft<ManagementStore>) => void), shouldReplace?: false): void;
 setState(nextStateOrUpdater: ManagementStore | ((state: WritableDraft<ManagementStore>) => void), shouldReplace: true): void;

package/package.json

@@ -5,7 +5,7 @@
     "email": "support@semaphor.cloud"
   },
   "license": "MIT",
-  "version": "0.1.178",
+  "version": "0.1.180",
   "description": "Fully interactive and customizable dashboards for your apps.",
   "keywords": [
     "react",
@@ -37,6 +37,11 @@
       "import": "./dist/surfboard/index.js",
       "require": "./dist/surfboard/index.cjs"
     },
+    "./format-utils": {
+      "types": "./dist/types/format-utils.d.ts",
+      "import": "./dist/format-utils/index.js",
+      "require": "./dist/format-utils/index.cjs"
+    },
     "./style.css": "./dist/style.css"
   },
   "scripts": {
@@ -135,6 +140,14 @@
     "react": "^18.0.0 || ^19.0.0",
     "react-dom": "^18.0.0 || ^19.0.0"
   },
+  "peerDependenciesMeta": {
+    "react": {
+      "optional": true
+    },
+    "react-dom": {
+      "optional": true
+    }
+  },
   "overrides": {
     "react": "$react",
     "react-dom": "$react-dom"

package/dist/chunks/editor-action-buttons-JE9t84-4.js

@@ -1,6 +0,0 @@
-"use strict";const s=require("react/jsx-runtime"),e=require("./index-CdfFCbJb.js"),v=require("./use-visual-utils-Cnju2tnE.js"),C=require("react");/**
- * @license lucide-react v0.453.0 - ISC
- *
- * This source code is licensed under the ISC license.
- * See the LICENSE file in the root directory of this source tree.
- */const E=e.createLucideIcon("Save",[["path",{d:"M15.2 3a2 2 0 0 1 1.4.6l3.8 3.8a2 2 0 0 1 .6 1.4V19a2 2 0 0 1-2 2H5a2 2 0 0 1-2-2V5a2 2 0 0 1 2-2z",key:"1c8476"}],["path",{d:"M17 21v-7a1 1 0 0 0-1-1H8a1 1 0 0 0-1 1v7",key:"1ydtos"}],["path",{d:"M7 3v4a1 1 0 0 0 1 1h7",key:"t51u73"}]]);function g({className:d,variant:l="outline"}){var m;const{setCardSql:i}=e.useEditorActions();e.useEditorStore(t=>t.frame);const u=e.useEditorStore(t=>t.card);v.useRemoteChartStore(((m=u.customCardPreferences)==null?void 0:m.url)||""),e.useEditorStore(t=>t.selectedSchemaName),e.useEditorStore(t=>t.selectedDatamodelId),e.useEditorStore(t=>t.selectedDatabaseName),e.useEditorStore(t=>t.selectedTableName),e.useEditorStore(t=>t.selectedConnectionId),e.useEditorStore(t=>t.isShowingVisual),u.sql;const a=e.useEditorStore(t=>t.onSave),{getUpdatedFrame:o}=v.useVisualUtils();function c(){const t=o();a==null||a(t)}return s.jsxs(e.Button,{onClick:c,className:e.cn("h-8",d),size:"sm",variant:l,children:[s.jsx(e.Check,{className:"mr-2 size-4 font-bold"}),"Accept"]})}function b({className:d,variant:l="default"}){const i=e.useQueryClient(),[u,a]=C.useState(!1),o=e.useDashboardStore(n=>n.actions.setIsDashboardPanelOpen),{setIsVisualEditing:c}=e.useDashboardActions(),{getUpdatedFrame:m}=v.useVisualUtils(),t=e.useSelectedVisual(),r=e.useEditorStore(n=>n.frame),y=e.useUpdateVisualMutation(),h=()=>{const n=m(),p=(r==null?void 0:r.visualId)||(t==null?void 0:t.id);if(!p){e.ue.error("No visual to save");return}a(!0),y.mutate({visualId:p,data:{frameObject:n}},{onSuccess:()=>{a(!1),o(!0),e.ue.success("Visual updated successfully"),i.invalidateQueries({queryKey:["resource-by-id","visual",p],exact:!0})},onError:()=>{a(!1),e.ue.error("Failed to update visual")}})};return s.jsxs(e.Button,{onClick:h,className:e.cn("h-8",d),size:"sm",variant:l,children:[u&&s.jsxs(s.Fragment,{children:[s.jsx(e.LoaderCircle,{className:"mr-2 size-4 animate-spin font-bold"})," Saving"]}),!u&&s.jsxs(s.Fragment,{children:[s.jsx(E,{className:"mr-2 size-4 font-bold"}),"Save to Library"]})]})}function x({className:d}){const l=e.useQueryClient(),[i,u]=C.useState(!1),a=e.useSelectedVisual(),o=e.useEditorStore(n=>n.frame),c=e.useDashboardStore(n=>n.selectedSheetId),{updateFrame:m,setIsVisualEditing:t}=e.useDashboardActions(),{getUpdatedFrame:r}=v.useVisualUtils(),y=e.useUpdateVisualMutation(),h=async()=>{if(!c){e.ue.error("No sheet selected");return}const n=(o==null?void 0:o.visualId)||(a==null?void 0:a.id);if(!n){e.ue.error("No visual to update");return}u(!0);try{const p=r();await y.mutateAsync({visualId:n,data:{frameObject:p}});const f={...p,visualId:n};m(c,f),l.invalidateQueries({queryKey:["visuals"]}),l.invalidateQueries({queryKey:["visual",n]}),e.ue.success("Saved to library and applied locally"),setTimeout(()=>{t(!1)},300)}catch(p){console.error("Failed to save and apply:",p),e.ue.error("Failed to save and apply changes")}finally{u(!1)}};return s.jsx(e.Button,{onClick:h,className:e.cn("h-8",d),size:"sm",variant:"default",disabled:i,children:i?s.jsxs(s.Fragment,{children:[s.jsx(e.LoaderCircle,{className:"mr-2 size-4 animate-spin font-bold"})," Saving..."]}):s.jsxs(s.Fragment,{children:[s.jsx(E,{className:"mr-2 size-4 font-bold"}),"Save & Apply"]})})}function A({className:d}){const{getUpdatedFrame:l}=v.useVisualUtils();e.useEditorStore(t=>t.frame);const i=e.useDashboardStore(t=>t.selectedSheetId),{updateFrame:u,setIsVisualEditing:a}=e.useDashboardActions(),[o,c]=C.useState(!1),m=()=>{if(!i){e.ue.error("No sheet selected");return}c(!0);const r={...l(),visualId:void 0};u(i,r),setTimeout(()=>{c(!1),e.ue.success("Changes applied. Visual is now local to this dashboard"),a(!1)},300)};return s.jsxs(e.Button,{onClick:m,className:e.cn("h-8",d),size:"sm",variant:"outline",children:[o&&s.jsxs(s.Fragment,{children:[s.jsx(e.LoaderCircle,{className:"mr-2 size-4 animate-spin font-bold"})," Applying"]}),!o&&s.jsxs(s.Fragment,{children:[s.jsx(e.Check,{className:"mr-2 size-4 font-bold"}),"Apply Locally"]})]})}function j({className:d}){const{setTempQueryData:l,setSqlGen:i}=e.useEditorActions(),u=e.useQueryClient(),a=e.useEditorStore(r=>r.tempQueryData),o=e.useEditorStore(r=>r.onClose),c=e.useEditorStore(r=>r.card),{queryKey:m}=e.useDashboardCardQuery(c);function t(){if(a){const{queryKey:r,queryData:y}=a;r&&y&&u.setQueryData(r,y)}i({}),o==null||o()}return s.jsxs(e.Button,{onClick:t,className:e.cn("h-8",d),size:"sm",variant:"outline",children:[s.jsx(e.X,{className:"mr-2 size-4"}),"Close"]})}function D(){const{setTempQueryData:d}=e.useEditorActions(),l=e.useQueryClient();e.useEditorStore(S=>S.isDevMode);const i=e.useEditorStore(S=>S.tempQueryData),u=e.useEditorStore(S=>S.card),{queryKey:a}=e.useDashboardCardQuery(u),{setCardSql:o,setSqlGen:c,setCardPython:m,setCardCustomCfg:t,setCardPreferences:r,updateDataSource:y,clearQueryConfig:h,setCardConfig:n,setCardType:p}=e.useEditorActions();function f(){const S=l.getQueryData(a);i!=null&&i.queryData||d({queryKey:a,queryData:S}),l.setQueryData(a,null),l.removeQueries({queryKey:a,exact:!0}),o(""),c({}),h(),n(void 0),m(""),t(""),r({}),p("bar")}return s.jsxs(e.Button,{onClick:f,className:"h-8",size:"sm",variant:"secondary",children:[s.jsx(e.X,{className:"mr-2 size-3.5"}),"Clear"]})}exports.EditorAcceptButton=g;exports.EditorCancelButton=j;exports.EditorClearButton=D;exports.Save=E;exports.VisualApplyLocalButton=A;exports.VisualSaveAndApplyButton=x;exports.VisualSaveButton=b;