@adaptabletools/adaptable 24.0.0-canary.0 → 24.0.0-canary.10

package/devtools.d.ts

@@ -1,4 +1,223 @@
-import { AdaptableApi } from './types';
+import type { VisibleSettingsPanelNavigationGroup, VisibleSettingsPanelNavigationItem } from './src/Utilities/Helpers/SettingsPanelHelper';
+import type { AdaptableApi, AdaptableColumnDataType, AdaptableModule, AdaptablePersistentState, AdaptableState } from './types';
+/**
+ * One AdapTable instance as reported by `window.__ADAPTABLE_DEVTOOLS__.listInstances()`.
+ */
+export type DevToolsInstanceInfo = {
+    adaptableId: string;
+    adaptableVersion: string;
+    agGridVersion: string;
+    adaptableStateKey: string;
+    primaryKey?: string;
+    userName?: string;
+    gridRuntime: DevToolsGridRuntime;
+};
+/**
+ * Column description returned by `window.__ADAPTABLE_DEVTOOLS__.getColumns()`.
+ *
+ * `id` and `dataType` match the `columns` input of the AdapTable MCP server's
+ * `check_state` and `check_expression` tools.
+ */
+/** One row of the read-only column summary shown in DevTools. */
+export type DevToolsColumnSummaryRow = {
+    key: string;
+    value: string;
+};
+/** A column the DevTools column picker can select. */
+export type DevToolsColumnOption = {
+    id: string;
+    friendlyName: string;
+};
+/**
+ * One tag from a Settings Panel object summary. `color` is a resolved CSS colour
+ * (a colour variable is computed in the page) so the panel can draw the swatch.
+ */
+export type DevToolsObjectTag = {
+    text: string;
+    variant?: 'default' | 'accent' | 'expression';
+    color?: string;
+    italic?: boolean;
+};
+/** One labelled row of tags, matching a Settings Panel summary row. */
+export type DevToolsObjectRow = {
+    label: string;
+    tags: DevToolsObjectTag[];
+};
+/**
+ * An AdapTable object scoped to the column (Alert, Format Column, Styled Column, …).
+ * `rows` are the same summary tags the Settings Panel shows. Read-only.
+ */
+export type DevToolsScopedObject = {
+    module: string;
+    rows: DevToolsObjectRow[];
+};
+/**
+ * Read-only Column Info for one column, returned by
+ * `window.__ADAPTABLE_DEVTOOLS__.getColumnInfo()`.
+ */
+export type DevToolsColumnDetail = {
+    columnId: string;
+    columns: DevToolsColumnOption[];
+    summary: DevToolsColumnSummaryRow[];
+    scopedObjects: DevToolsScopedObject[];
+};
+export type DevToolsColumnInfo = {
+    /** AdapTable column id (AG Grid `colId`) */
+    id: string;
+    friendlyName: string;
+    dataType: AdaptableColumnDataType;
+    field?: string;
+    columnTypes?: string[];
+    visible: boolean;
+    readOnly: boolean;
+    isPrimaryKey: boolean;
+    isGrouped: boolean;
+    pinned: 'left' | 'right' | false;
+    isGeneratedRowGroupColumn: boolean;
+    isGeneratedPivotResultColumn: boolean;
+    isCalculatedColumn: boolean;
+    isFreeTextColumn: boolean;
+    isActionColumn: boolean;
+};
+/**
+ * Snapshot of the facts shown in the Settings Panel `Grid Info` section,
+ * returned by `window.__ADAPTABLE_DEVTOOLS__.getGridInfo()`.
+ */
+export type DevToolsGridInfo = {
+    adaptableId: string;
+    adaptableVersion: string;
+    agGridVersion: string;
+    adaptableStateKey: string;
+    userName?: string;
+    primaryKey?: string;
+    isAutogeneratedPrimaryKey: boolean;
+    licenseKey?: string;
+    layout: {
+        name: string;
+        type: 'Table' | 'Pivot';
+        rowGroups: string[];
+        pivotColumns: string[];
+        sorts: {
+            columnId: string;
+            sortOrder: string;
+        }[];
+    };
+    columnFilters: string;
+    gridFilter?: string;
+    rows: {
+        all: number;
+        visible: number;
+        selected: number;
+    };
+    columns: {
+        all: number;
+        visible: number;
+        calculated: string[];
+        freeText: string[];
+        action: string[];
+    };
+    modules: {
+        available: AdaptableModule[];
+        unavailable: AdaptableModule[];
+    };
+};
+export type DevToolsLogLevel = 'info' | 'success' | 'warn' | 'error' | 'perf';
+/**
+ * A log message AdapTable wrote, kept in the in-page buffer regardless of
+ * `localStorage.debug`.
+ */
+export type DevToolsLogEntry = {
+    timestamp: number;
+    adaptableId: string;
+    channel: string;
+    level: DevToolsLogLevel;
+    /** Message arguments, each formatted as a string (objects as JSON) */
+    args: string[];
+};
+/**
+ * A state-changing Redux action AdapTable dispatched (transient UI actions are skipped).
+ */
+export type DevToolsActionEntry = {
+    timestamp: number;
+    actionName: string;
+};
+/**
+ * In-page API exposed as `window.__ADAPTABLE_DEVTOOLS__` as soon as AdapTable
+ * loads in a browser.
+ *
+ * Built for tools that evaluate JavaScript in the page (coding agents using
+ * Chrome DevTools MCP, Playwright `page.evaluate`, the browser console): every
+ * method returns plain JSON unless noted, so the result survives serialization.
+ *
+ * `adaptableId` can be omitted whenever exactly one AdapTable instance is
+ * mounted; with several instances, pass the id (see `listInstances()`).
+ * Unknown ids throw an `Error` naming the mounted instances.
+ *
+ * ```ts
+ * window.__ADAPTABLE_DEVTOOLS__.listInstances();
+ * window.__ADAPTABLE_DEVTOOLS__.getState('Trades', 'Layout');
+ * window.__ADAPTABLE_DEVTOOLS__.getLogs('Trades', { level: 'error' });
+ * ```
+ *
+ * The AdapTable DevTools Chrome extension uses the same functions.
+ */
+export interface AdaptableDevToolsGlobal {
+    /** Short usage text for anyone who only has the global */
+    help(): string;
+    /** Every mounted AdapTable instance with versions, identity and row counts */
+    listInstances(): DevToolsInstanceInfo[];
+    /**
+     * Full AdapTable State (including the transient `Internal`, `Popup`, `Comment` and
+     * `Plugins` sections), serialized. Pass `section` (e.g. `'Layout'`, `'FormatColumn'`)
+     * for one section only.
+     */
+    getState(adaptableId?: string, section?: keyof AdaptableState | string): any;
+    /**
+     * Persistent (user) state: what AdapTable saves to storage. Use it as the `state`
+     * argument of the MCP `check_state` and `migrate_state` tools.
+     */
+    getPersistentState(adaptableId?: string): AdaptablePersistentState;
+    /** Columns AdapTable knows about, with data types and visibility */
+    getColumns(adaptableId?: string): DevToolsColumnInfo[];
+    /**
+     * Read-only Column Info for one column: summary plus the objects scoped to it.
+     * Omit `columnId` to use the first column. Does not include distinct cell values.
+     */
+    getColumnInfo(adaptableId?: string, columnId?: string): DevToolsColumnDetail;
+    /** The facts shown in the Settings Panel Grid Info section */
+    getGridInfo(adaptableId?: string): DevToolsGridInfo;
+    /**
+     * Most recent AdapTable log messages (default 100, newest last), optionally
+     * filtered by level or channel substring. Messages are buffered whether or not
+     * `localStorage.debug` is set.
+     */
+    getLogs(adaptableId?: string, options?: {
+        level?: DevToolsLogLevel | DevToolsLogLevel[];
+        channel?: string;
+        limit?: number;
+    }): DevToolsLogEntry[];
+    /** Most recent state-changing actions (default 50, newest last) */
+    getRecentActions(adaptableId?: string, limit?: number): DevToolsActionEntry[];
+    /** Restores a state snapshot (as returned by `getState` or `getPersistentState`) */
+    restoreState(adaptableId: string | undefined, state: AdaptablePersistentState): Promise<void>;
+    /** Opens the Settings Panel, at a Module section when given */
+    openSettingsPanel(adaptableId?: string, moduleName?: AdaptableModule): void;
+    /**
+     * Sets `localStorage.debug` (e.g. `'Adaptable:Trades:*'`, `'Adaptable:*:error'`),
+     * `null` removes it. Returns the previous value. Channels created after the call
+     * pick it up at once; reload the page to apply it to every channel.
+     */
+    setLogging(pattern: string | null): string | null;
+    /** Toggles `localStorage.adaptableProfileTracks` (Chrome Performance panel tracks) */
+    enableProfiling(enabled?: boolean): void;
+    /** The live `AdaptableApi` of an instance (not serializable; for in-page use) */
+    getApi(adaptableId?: string): AdaptableApi;
+}
+declare global {
+    interface Window {
+        __ADAPTABLE_DEVTOOLS__?: AdaptableDevToolsGlobal;
+    }
+}
 export type DevToolsMessageAddress = 'adaptable-devtools-contentscript' | 'adaptable-devtools-contentscript-panel' | 'adaptable-devtools-background' | 'adaptable-page';
 export type DevToolsGenericMessage = {
     source: DevToolsMessageAddress;
@@ -19,17 +238,23 @@ export type DevToolsHostPageMessagePayload = {
     adaptableId: string;
     [key: string]: any;
 };
-export type DevToolsHostPageMessageType = 'mount' | 'update' | 'unmount' | 'log' | 'state-change';
+export type DevToolsHostPageMessageType = 'mount' | 'update' | 'unmount' | 'log' | 'state-change' | 'column-info';
 export type DevToolsGridRuntime = {
     allRowsCount: number;
     visibleRowsCount: number;
     selectedRowsCount: number;
 };
+export type DevToolsSettingsPanelNavigationItem = VisibleSettingsPanelNavigationItem;
+export type DevToolsSettingsPanelNavigationGroup = VisibleSettingsPanelNavigationGroup;
 export type DevToolsMountPayload = {
     adaptableId: string;
     adaptableVersion: string;
     agGridVersion: string;
     licenseKey?: string;
+    userName?: string;
+    primaryKey?: string;
+    /** Grouped modules visible in the Settings Panel sidebar for this instance. */
+    settingsPanelNavigation?: DevToolsSettingsPanelNavigationGroup[];
 };
 export type DevToolsHostPageLogMessage = {
     type: Extract<DevToolsHostPageMessageType, 'log'>;
@@ -65,6 +290,16 @@ export type DevToolsHostPageMessage = {
         state: any;
         actionName?: string;
         gridRuntime?: DevToolsGridRuntime;
+        licenseKey?: string;
+        userName?: string;
+        primaryKey?: string;
+        settingsPanelNavigation?: DevToolsSettingsPanelNavigationGroup[];
+    };
+} | {
+    type: Extract<DevToolsHostPageMessageType, 'column-info'>;
+    payload: {
+        adaptableId: string;
+        columnInfo: DevToolsColumnDetail;
     };
 } | DevToolsHostPageLogMessage);
 export type DevToolsHookFn = (adaptableId: string, options: null | DevToolsFnOptions) => void;