@adaptabletools/adaptable-mcp 0.1.0-canary.1 → 0.1.0-canary.3

package/README.md

@@ -62,7 +62,9 @@ Point an MCP client at the same binary with the `mcp` argument (without it the b
 }
 ```
 
-Cursor reads this from `.cursor/mcp.json`, Claude Code from `.mcp.json`; Codex takes the equivalent `[mcp_servers.adaptable]` block in `~/.codex/config.toml`. The server exposes the checking, docs and migration capabilities as tools with the same results as the CLI's `--json` output.
+Cursor reads this from `.cursor/mcp.json`, Claude Code from `.mcp.json`; Codex takes the equivalent `[mcp_servers.adaptable]` block in `~/.codex/config.toml`. The server exposes the checking, docs and migration capabilities as twelve tools (`detect_environment`, `get_compatibility`, `search_docs`, `get_doc`, `get_demo`, `check_state`, `check_expression`, `list_expression_functions`, `check_setup`, `migrate_state`, `migrate_expression`, `list_changes`) with the same envelope as the CLI's `--json` output; every tool also accepts the global options (`cwd`, `major`, `framework`, `offline`, `docsHost`). `adaptable mcp --cwd <dir> --major <n> --offline …` sets defaults for every call. There are no prompts or resources: the workflows live in the skills.
+
+In a long-lived server the docs manifest is re-validated at most once a minute before a manifest-dependent call, and the library package for a project is resolved per call, so one server serves projects on different majors.
 
 ## How it works
 

package/data/changes/21-22.json

@@ -0,0 +1,542 @@
+{
+  "from": 21,
+  "to": 22,
+  "builtFrom": {
+    "releaseNote": "support/version-220-release-note",
+    "sourceSha256": "47efd2183ab6ab528fbff29eecf25e542f5755dc221d492b0ad7f4e560bb8f79"
+  },
+  "records": [
+    {
+      "id": "packages-upgrade-22",
+      "area": "packages",
+      "type": "BREAKING",
+      "title": "AG Grid",
+      "rows": [
+        {
+          "item": "AG Grid",
+          "before": "v.21 pairing",
+          "after": "35.0 (22.0); 22.1 pairs with 35.2",
+          "autoMigrated": "n/a"
+        },
+        {
+          "item": "@adaptabletools/* versions",
+          "before": "21.x",
+          "after": "all on the same 22.x",
+          "autoMigrated": "n/a"
+        }
+      ],
+      "search": [],
+      "always": true,
+      "note": "Bump every @adaptabletools/* package to the same 22.x and AG Grid to 35.0 (22.1 pairs with AG Grid 35.2; use the ag-update skill for AG Grid). If 22 is only a stop on the way to a later major, go straight to the AG Grid version paired with the final target.",
+      "docs": "support/version-220-release-note#chg-packages-upgrade-22"
+    },
+    {
+      "id": "packages-angular-18",
+      "area": "packages",
+      "type": "BREAKING",
+      "title": "Angular wrapper",
+      "rows": [
+        {
+          "item": "Angular wrapper",
+          "before": "Angular >=17.3.0",
+          "after": "Angular >=18.2.14 (@adaptabletools/adaptable-angular-aggrid)",
+          "autoMigrated": "n/a"
+        }
+      ],
+      "search": [
+        "@adaptabletools/adaptable-angular-aggrid"
+      ],
+      "always": false,
+      "note": "Upgrade the application to Angular 18.2.14 or later before or together with AdapTable 22 (Angular 20 if the final target is AdapTable 24).",
+      "docs": "support/version-220-release-note#chg-packages-angular-18"
+    },
+    {
+      "id": "packages-import-from-root",
+      "area": "packages",
+      "type": "DEPRECATED",
+      "title": "Types entry point",
+      "rows": [
+        {
+          "item": "Types entry point",
+          "before": "@adaptabletools/adaptable/types",
+          "after": "@adaptabletools/adaptable (package root exports every type)",
+          "autoMigrated": "n/a"
+        },
+        {
+          "item": "AG Grid entry point",
+          "before": "@adaptabletools/adaptable/agGrid",
+          "after": "@adaptabletools/adaptable (or the framework wrapper root)",
+          "autoMigrated": "n/a"
+        }
+      ],
+      "search": [
+        "@adaptabletools/adaptable/types",
+        "@adaptabletools/adaptable/agGrid"
+      ],
+      "always": false,
+      "note": "Rewrite the imports to the package root (or the framework wrapper root) and merge duplicate import statements; the legacy entry points still resolve but are not documented.",
+      "docs": "support/version-220-release-note#chg-packages-import-from-root"
+    },
+    {
+      "id": "packages-ipushpull-plugin-options",
+      "area": "packages",
+      "type": "BREAKING",
+      "title": "iPushPull plugin options type",
+      "rows": [
+        {
+          "item": "iPushPull plugin options type",
+          "before": "IPushPullPluginOptions exported by @adaptabletools/adaptable",
+          "after": "exported by @adaptabletools/adaptable-plugin-ipushpull",
+          "autoMigrated": "n/a"
+        }
+      ],
+      "search": [
+        "IPushPullPluginOptions"
+      ],
+      "always": false,
+      "note": "Import IPushPullPluginOptions from '@adaptabletools/adaptable-plugin-ipushpull' (with the plugin's default export); the option shape passed to the plugin is unchanged.",
+      "docs": "support/version-220-release-note#chg-packages-ipushpull-plugin-options"
+    },
+    {
+      "id": "css-index-file",
+      "area": "css",
+      "type": "BREAKING",
+      "title": "Root stylesheet",
+      "rows": [
+        {
+          "item": "Root stylesheet",
+          "before": "@adaptabletools/ /base.css",
+          "after": "@adaptabletools/ /index.css",
+          "autoMigrated": "n/a"
+        }
+      ],
+      "search": [
+        "/base.css"
+      ],
+      "always": false,
+      "note": "Replace @adaptabletools/<package>/base.css with @adaptabletools/<package>/index.css everywhere it is imported (CSS @import, JS/TS import, angular.json styles, bundler config, index.html); the Angular package keeps a base.css alias.",
+      "docs": "support/version-220-release-note#chg-css-index-file"
+    },
+    {
+      "id": "css-light-theme-in-index",
+      "area": "css",
+      "type": "DEPRECATED",
+      "title": "Light theme file",
+      "rows": [
+        {
+          "item": "Light theme file",
+          "before": "@adaptabletools/ /themes/light.css import",
+          "after": "light theme is included in index.css; the file is an empty stub (themes/dark.css is still required for the dark theme in 22)",
+          "autoMigrated": "n/a"
+        }
+      ],
+      "search": [
+        "/themes/light.css"
+      ],
+      "always": false,
+      "note": "Remove the themes/light.css import; keep themes/dark.css if the dark theme is used and the target is 22 (drop it too when the target is 23 or later, where both themes are in index.css).",
+      "docs": "support/version-220-release-note#chg-css-light-theme-in-index"
+    },
+    {
+      "id": "css-removed-variables",
+      "area": "css",
+      "type": "BREAKING",
+      "title": "Spacing variables",
+      "rows": [
+        {
+          "item": "Spacing variables",
+          "before": "--ab-space-0 … --ab-space-7",
+          "after": "derived from --ab-base-space: 4px with calc() (mapping under this table)",
+          "autoMigrated": "n/a"
+        },
+        {
+          "item": "Secondary colour variables",
+          "before": "--ab-color-secondary, --ab-color-secondarydark, --ab-color-secondarylight, --ab-color-text-on-secondary, --ab-color-text-on-secondarylight",
+          "after": "the accent family: --ab-color-accent, --ab-color-accentlight, --ab-color-accent-foreground (or --ab-color-primary / --ab-color-primary-foreground)",
+          "autoMigrated": "n/a"
+        },
+        {
+          "item": "Action-button colour variables",
+          "before": "--ab-color-action-edit / -clone / -delete / -share, --ab-color-text-on-edit / -clone / -delete / -share",
+          "after": "removed (23 reintroduces --ab-color-action-* with --ab-color-action-*-foreground)",
+          "autoMigrated": "n/a"
+        },
+        {
+          "item": "Component variables",
+          "before": "--ab-cmp-dialog*, --ab-cmp-help-block*, --ab-cmp-error-box*, --ab-cmp-warning-box*, --ab-cmp-code-block*, --ab-cmp-listgroup*, --ab-cmp-quickfilter*, --ab-cmp-one-page-wizard*, --ab-cmp-expression-editor*, --ab-cmp-module-selector*, --ab-cmp-adaptable-popup*, --ab-cmp-toggle*, --ab-cmp-simple-button*, --ab-cmp-panel* and more (about 100)",
+          "after": "removed — target the components' .ab-* classes directly (AdapTable's CSS is in the adaptable layer, so an unlayered rule wins without !important)",
+          "autoMigrated": "n/a"
+        }
+      ],
+      "search": [
+        "--ab-space-0",
+        "--ab-space-1",
+        "--ab-space-2",
+        "--ab-space-3",
+        "--ab-space-4",
+        "--ab-space-5",
+        "--ab-space-6",
+        "--ab-space-7",
+        "--ab-color-secondary",
+        "--ab-color-text-on-secondary",
+        "--ab-color-action-",
+        "--ab-color-text-on-edit",
+        "--ab-color-text-on-clone",
+        "--ab-color-text-on-delete",
+        "--ab-color-text-on-share",
+        "--ab-cmp-dialog",
+        "--ab-cmp-help-block",
+        "--ab-cmp-error-box",
+        "--ab-cmp-warning-box",
+        "--ab-cmp-code-block",
+        "--ab-cmp-listgroup",
+        "--ab-cmp-quickfilter",
+        "--ab-cmp-one-page-wizard",
+        "--ab-cmp-expression-editor",
+        "--ab-cmp-module-selector",
+        "--ab-cmp-adaptable-popup",
+        "--ab-cmp-toggle--hover__background",
+        "--ab-cmp-toggle--pressed__background",
+        "--ab-cmp-toggle__background",
+        "--ab-cmp-toggle__border-radius",
+        "--ab-cmp-toggle__color",
+        "--ab-cmp-toggle__padding",
+        "--ab-cmp-toggle-button--active__background",
+        "--ab-cmp-toggle-button__font-size",
+        "--ab-cmp-simple-button--outlined__border",
+        "--ab-cmp-simple-button__font-family",
+        "--ab-cmp-simple-button__font-size",
+        "--ab-cmp-simple-button__height",
+        "--ab-cmp-simple-button__padding",
+        "--ab-cmp-simple-button__width",
+        "--ab-cmp-panel__padding",
+        "--ab-cmp-panel_body",
+        "--ab-cmp-Tag__font-size",
+        "--ab-cmp-adaptable-object-list-item-label__padding-top"
+      ],
+      "always": false,
+      "note": "The removed variables resolve to nothing: spacing becomes calc() on --ab-base-space, secondary colours become the accent family (listed under this table), and component overrides are deleted (restyle through the components' .ab-* classes — an unlayered rule wins in the adaptable layer). The full removed list is in Removed CSS Variables above.",
+      "docs": "support/version-220-release-note#chg-css-removed-variables"
+    },
+    {
+      "id": "css-adaptable-layer",
+      "area": "css",
+      "type": "BEHAVIOUR",
+      "title": "CSS layer",
+      "rows": [
+        {
+          "item": "CSS layer",
+          "before": "AdapTable styles unlayered; selector-doubling and !important needed to override",
+          "after": "all AdapTable CSS nested in @layer adaptable",
+          "autoMigrated": "n/a"
+        }
+      ],
+      "search": [
+        "@layer"
+      ],
+      "always": false,
+      "note": "If the application declares its own layers, list adaptable first (@layer adaptable, app, theme; with Tailwind: @layer theme, base, components, adaptable, utilities) and remove selector-doubling and !important hacks that existed only to beat AdapTable's specificity; applications that do not use @layer need no change.",
+      "docs": "support/version-220-release-note#chg-css-adaptable-layer"
+    },
+    {
+      "id": "state-object-name",
+      "area": "state",
+      "type": "DEPRECATED",
+      "title": "Adaptable Objects in Initial State require a Name",
+      "rows": [
+        {
+          "item": "Custom Sort",
+          "before": "CustomSorts without Name",
+          "after": "unique Name required (a deterministic one is generated when missing)",
+          "autoMigrated": "yes"
+        },
+        {
+          "item": "Flashing Cell",
+          "before": "FlashingCellDefinitions without Name",
+          "after": "unique Name required (generated when missing)",
+          "autoMigrated": "yes"
+        },
+        {
+          "item": "Format Column",
+          "before": "FormatColumns without Name",
+          "after": "unique Name required (generated when missing)",
+          "autoMigrated": "yes"
+        },
+        {
+          "item": "Plus Minus",
+          "before": "PlusMinusNudges without Name",
+          "after": "unique Name required (generated when missing)",
+          "autoMigrated": "yes"
+        },
+        {
+          "item": "Shortcut",
+          "before": "Shortcuts without Name",
+          "after": "unique Name required (generated when missing)",
+          "autoMigrated": "yes"
+        },
+        {
+          "item": "Alert",
+          "before": "AlertDefinitions without Name",
+          "after": "unique Name required (generated when missing)",
+          "autoMigrated": "yes"
+        }
+      ],
+      "search": [
+        "CustomSorts:",
+        "FlashingCellDefinitions:",
+        "FormatColumns:",
+        "PlusMinusNudges:",
+        "Shortcuts:",
+        "AlertDefinitions:"
+      ],
+      "always": false,
+      "note": "Add a meaningful Name to every such object in initialState. To take the generated names instead, run the application once after the package bump and copy the objects back from stateApi.getAdaptableState() (or the Grid Info panel). Objects that already had Name (Layouts) or FriendlyName (Calculated Columns) are unchanged.",
+      "docs": "support/version-220-release-note#chg-state-object-name"
+    },
+    {
+      "id": "state-format-column-cell-alignment",
+      "area": "state",
+      "type": "DEPRECATED",
+      "title": "Format Column alignment",
+      "rows": [
+        {
+          "item": "Format Column alignment",
+          "before": "FormatColumn.CellAlignment",
+          "after": "FormatColumn.Style.Alignment (Alignment: 'Left', 'Right', 'Center' or 'Default', available wherever a Style is used)",
+          "autoMigrated": "yes"
+        }
+      ],
+      "search": [
+        "CellAlignment"
+      ],
+      "always": false,
+      "note": "In initialState, move CellAlignment: 'Right' into Style: { Alignment: 'Right' }; rename CellAlignment type imports to Alignment.",
+      "docs": "support/version-220-release-note#chg-state-format-column-cell-alignment"
+    },
+    {
+      "id": "options-predicate-time-default",
+      "area": "options",
+      "type": "BEHAVIOUR",
+      "title": "Date Predicate time comparison (changed in 21.1)",
+      "rows": [
+        {
+          "item": "Date Predicate time comparison (changed in 21.1)",
+          "before": "predicateOptions.evaluateInPredicateUsingTime defaults to true (up to 21.0): Date Predicates compare timestamps",
+          "after": "defaults to false: dates are compared date-only unless the option is set",
+          "autoMigrated": "n/a"
+        }
+      ],
+      "search": [
+        "evaluateInPredicateUsingTime"
+      ],
+      "always": true,
+      "note": "If date filters must keep matching on exact timestamps, set predicateOptions: { evaluateInPredicateUsingTime: true } (a function (context) => boolean is also accepted). Projects already on 21.1 or later have the new default and need nothing.",
+      "docs": "support/version-220-release-note#chg-options-predicate-time-default"
+    },
+    {
+      "id": "options-hide-quick-filter-input",
+      "area": "options",
+      "type": "BREAKING",
+      "title": "Quick Filter input visibility",
+      "rows": [
+        {
+          "item": "Quick Filter input visibility",
+          "before": "columnFilterOptions.hideQuickFilterInput (per-column callback hiding only the text input)",
+          "after": "removed",
+          "autoMigrated": "n/a"
+        }
+      ],
+      "search": [
+        "hideQuickFilterInput"
+      ],
+      "always": false,
+      "note": "Use columnFilterOptions.hideQuickFilterDropdown(context) to hide the operator dropdown, showQuickFilter: false to hide the bar, or the AG Grid column definition (floatingFilter: false) for a single column.",
+      "docs": "support/version-220-release-note#chg-options-hide-quick-filter-input"
+    },
+    {
+      "id": "api-always-hidden-columns",
+      "area": "api",
+      "type": "BREAKING",
+      "title": "Always-hidden columns method",
+      "rows": [
+        {
+          "item": "Always-hidden columns method",
+          "before": "columnApi.getAlwaysHiddenColumns()",
+          "after": "columnApi.getUIHiddenColumns()",
+          "autoMigrated": "n/a"
+        },
+        {
+          "item": "Always-hidden column flag",
+          "before": "AdaptableColumn.alwaysHidden",
+          "after": "AdaptableColumn.isUIHiddenColumn",
+          "autoMigrated": "n/a"
+        }
+      ],
+      "search": [
+        "getAlwaysHiddenColumns",
+        "alwaysHidden"
+      ],
+      "always": false,
+      "note": "columnApi.getAlwaysHiddenColumns() becomes columnApi.getUIHiddenColumns(); column.alwaysHidden becomes column.isUIHiddenColumn.",
+      "docs": "support/version-220-release-note#chg-api-always-hidden-columns"
+    },
+    {
+      "id": "api-custom-sort-signature",
+      "area": "api",
+      "type": "BREAKING",
+      "title": "Create Custom Sort (changed in 21.2)",
+      "rows": [
+        {
+          "item": "Create Custom Sort (changed in 21.2)",
+          "before": "customSortApi.createCustomSort(columnId, values)",
+          "after": "customSortApi.createCustomSort({ name, columnId, values })",
+          "autoMigrated": "n/a"
+        },
+        {
+          "item": "Edit Custom Sort (changed in 21.2)",
+          "before": "customSortApi.editCustomSort(columnId, values)",
+          "after": "customSortApi.editCustomSortValues(columnId, values); editCustomSort takes a full CustomSort object",
+          "autoMigrated": "n/a"
+        }
+      ],
+      "search": [
+        "editCustomSort(",
+        "createCustomSort("
+      ],
+      "always": false,
+      "note": "createCustomSort(col, values) becomes createCustomSort({ name: 'CustomSort-' + col, columnId: col, values }); two-argument editCustomSort(col, values) calls become editCustomSortValues(col, values) — calls that already pass a CustomSort object to editCustomSort are unchanged.",
+      "docs": "support/version-220-release-note#chg-api-custom-sort-signature"
+    },
+    {
+      "id": "api-layout-changed-action",
+      "area": "api",
+      "type": "BREAKING",
+      "title": "Layout Changed action (changed in 21.1)",
+      "rows": [
+        {
+          "item": "Layout Changed action (changed in 21.1)",
+          "before": "LayoutChanged event action 'ADAPTABLE_READY' (first Layout applied at start-up)",
+          "after": "'LAYOUT_READY'",
+          "autoMigrated": "n/a"
+        }
+      ],
+      "search": [
+        "ADAPTABLE_READY"
+      ],
+      "always": false,
+      "note": "Replace the string comparison; the event timing is unchanged. Projects on 21.1 or later already use the new value.",
+      "docs": "support/version-220-release-note#chg-api-layout-changed-action"
+    },
+    {
+      "id": "api-use-case-sensitivity",
+      "area": "api",
+      "type": "BREAKING",
+      "title": "Case sensitivity check (changed in 21.1)",
+      "rows": [
+        {
+          "item": "Case sensitivity check (changed in 21.1)",
+          "before": "predicateApi.useCaseSensitivity() (no argument)",
+          "after": "predicateApi.useCaseSensitivity(columnId) (per-column decision)",
+          "autoMigrated": "n/a"
+        }
+      ],
+      "search": [
+        "useCaseSensitivity()"
+      ],
+      "always": false,
+      "note": "Pass the column id of the value being compared: predicateApi.useCaseSensitivity(columnId). Projects on 21.1 or later already pass it. Note: predicateApi is removed in 24.",
+      "docs": "support/version-220-release-note#chg-api-use-case-sensitivity"
+    },
+    {
+      "id": "api-predefined-config",
+      "area": "api",
+      "type": "BREAKING",
+      "title": "Predefined Config type",
+      "rows": [
+        {
+          "item": "Predefined Config type",
+          "before": "PredefinedConfig type (alias of InitialState)",
+          "after": "InitialState",
+          "autoMigrated": "n/a"
+        },
+        {
+          "item": "Get Predefined Config",
+          "before": "stateApi.getPredefinedConfig()",
+          "after": "stateApi.getInitialState()",
+          "autoMigrated": "n/a"
+        },
+        {
+          "item": "Reload Predefined Config",
+          "before": "stateApi.reloadPredefinedConfig()",
+          "after": "stateApi.reloadInitialState()",
+          "autoMigrated": "n/a"
+        }
+      ],
+      "search": [
+        "getPredefinedConfig",
+        "reloadPredefinedConfig",
+        "PredefinedConfig"
+      ],
+      "always": false,
+      "note": "Type: PredefinedConfig becomes InitialState; getPredefinedConfig() becomes stateApi.getInitialState(); reloadPredefinedConfig() becomes stateApi.reloadInitialState().",
+      "docs": "support/version-220-release-note#chg-api-predefined-config"
+    },
+    {
+      "id": "objects-column-type-name",
+      "area": "objects",
+      "type": "BREAKING",
+      "title": "Column type name union",
+      "rows": [
+        {
+          "item": "Column type name union",
+          "before": "AdaptableColumnType (used by columnOptions.columnTypes)",
+          "after": "AdaptableColumnTypeName",
+          "autoMigrated": "n/a"
+        }
+      ],
+      "search": [
+        "AdaptableColumnType,",
+        "AdaptableColumnType }",
+        "AdaptableColumnType;",
+        "AdaptableColumnType>"
+      ],
+      "always": false,
+      "note": "Rename the type import to AdaptableColumnTypeName; values are unchanged.",
+      "docs": "support/version-220-release-note#chg-objects-column-type-name"
+    },
+    {
+      "id": "objects-transpose-config",
+      "area": "objects",
+      "type": "BREAKING",
+      "title": "Transpose columns switch",
+      "rows": [
+        {
+          "item": "Transpose columns switch",
+          "before": "TransposeConfig.visibleColumns (boolean)",
+          "after": "TransposeConfig.columnsToTranspose (string[] or a function of context)",
+          "autoMigrated": "n/a"
+        },
+        {
+          "item": "Transpose rows switch",
+          "before": "TransposeConfig.visibleRows (boolean)",
+          "after": "TransposeConfig.rowsToTranspose ('VisibleOnly' or 'All')",
+          "autoMigrated": "n/a"
+        },
+        {
+          "item": "Transpose autosize switch",
+          "before": "TransposeConfig.autosize (boolean)",
+          "after": "removed — columns autosize by default",
+          "autoMigrated": "n/a"
+        }
+      ],
+      "search": [
+        "visibleColumns",
+        "visibleRows",
+        "autosize:"
+      ],
+      "always": false,
+      "note": "visibleColumns: true becomes columnsToTranspose: (ctx) => ctx.columns.filter(c => c.visible).map(c => c.columnId) (omit to transpose all); visibleRows: true becomes rowsToTranspose: 'VisibleOnly', false becomes 'All'; delete autosize (columns autosize by default).",
+      "docs": "support/version-220-release-note#chg-objects-transpose-config"
+    }
+  ]
+}