@adaptabletools/adaptable-mcp 0.1.0-canary.0 → 0.1.0-canary.2

package/dist/core/state/rules/dashboard-toolbar-names.js

@@ -0,0 +1,48 @@
+import { asArray, isObj } from '../expressions.js';
+import { closest, strings } from './helpers.js';
+import { defineRule } from './rule.js';
+/**
+ * `Dashboard.Tabs[].Toolbars` and `Dashboard.PinnedToolbars` name built-in toolbars
+ * of the checked major or custom toolbars from `dashboardOptions.customToolbars`.
+ * The type is `AdaptableDashboardToolbars | string[]`, so the compiler cannot catch a typo.
+ */
+export default defineRule({
+    id: 'dashboard/toolbar-names',
+    docs: 'ui-dashboard-tabs-toolbars',
+    check({ state, options, names }) {
+        const dashboard = isObj(state.Dashboard) ? state.Dashboard : undefined;
+        if (!dashboard) {
+            return [];
+        }
+        const dashboardOptions = options && isObj(options.dashboardOptions) ? options.dashboardOptions : undefined;
+        const custom = asArray(dashboardOptions?.customToolbars)
+            .map((toolbar) => (isObj(toolbar) && typeof toolbar.name === 'string' ? toolbar.name : undefined))
+            .filter((name) => !!name);
+        const known = [...names.dashboardToolbars, ...custom];
+        const issues = [];
+        const check = (list, path) => {
+            strings(list).forEach((name, i) => {
+                if (known.includes(name)) {
+                    return;
+                }
+                const suggestion = closest(name, known);
+                issues.push({
+                    path: `${path}[${i}]`,
+                    severity: options ? 'error' : 'warning',
+                    message: options
+                        ? `"${name}" is neither a built-in toolbar nor a custom toolbar in \`dashboardOptions.customToolbars\`.`
+                        : `"${name}" is not a built-in toolbar; if it is a custom toolbar it must be defined in \`dashboardOptions.customToolbars\` (the Adaptable Options were not visible to this check).`,
+                    fix: suggestion ? `Did you mean "${suggestion}"?` : `Built-in toolbars: ${names.dashboardToolbars.join(', ')}.`,
+                });
+            });
+        };
+        asArray(dashboard.Tabs).forEach((tab, i) => {
+            if (isObj(tab)) {
+                check(tab.Toolbars, `Dashboard.Tabs[${i}].Toolbars`);
+            }
+        });
+        check(dashboard.PinnedToolbars, 'Dashboard.PinnedToolbars');
+        return issues;
+    },
+});
+//# sourceMappingURL=dashboard-toolbar-names.js.map

package/dist/core/state/rules/dashboard-toolbar-names.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"dashboard-toolbar-names.js","sourceRoot":"","sources":["../../../../src/core/state/rules/dashboard-toolbar-names.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,KAAK,EAAE,MAAM,mBAAmB,CAAC;AACnD,OAAO,EAAE,OAAO,EAAE,OAAO,EAAE,MAAM,cAAc,CAAC;AAChD,OAAO,EAAE,UAAU,EAAkB,MAAM,WAAW,CAAC;AAEvD;;;;GAIG;AACH,eAAe,UAAU,CAAC;IACxB,EAAE,EAAE,yBAAyB;IAC7B,IAAI,EAAE,4BAA4B;IAClC,KAAK,CAAC,EAAE,KAAK,EAAE,OAAO,EAAE,KAAK,EAAE;QAC7B,MAAM,SAAS,GAAG,KAAK,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC;QACvE,IAAI,CAAC,SAAS,EAAE,CAAC;YACf,OAAO,EAAE,CAAC;QACZ,CAAC;QACD,MAAM,gBAAgB,GAAG,OAAO,IAAI,KAAK,CAAC,OAAO,CAAC,gBAAgB,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,gBAAgB,CAAC,CAAC,CAAC,SAAS,CAAC;QAC3G,MAAM,MAAM,GAAG,OAAO,CAAC,gBAAgB,EAAE,cAAc,CAAC;aACrD,GAAG,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,OAAO,OAAO,CAAC,IAAI,KAAK,QAAQ,CAAC,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC;aACjG,MAAM,CAAC,CAAC,IAAI,EAAkB,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;QAC5C,MAAM,KAAK,GAAG,CAAC,GAAG,KAAK,CAAC,iBAAiB,EAAE,GAAG,MAAM,CAAC,CAAC;QACtD,MAAM,MAAM,GAAgB,EAAE,CAAC;QAC/B,MAAM,KAAK,GAAG,CAAC,IAAa,EAAE,IAAY,EAAQ,EAAE;YAClD,OAAO,CAAC,IAAI,CAAC,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,CAAC,EAAE,EAAE;gBAChC,IAAI,KAAK,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC;oBACzB,OAAO;gBACT,CAAC;gBACD,MAAM,UAAU,GAAG,OAAO,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;gBACxC,MAAM,CAAC,IAAI,CAAC;oBACV,IAAI,EAAE,GAAG,IAAI,IAAI,CAAC,GAAG;oBACrB,QAAQ,EAAE,OAAO,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,SAAS;oBACvC,OAAO,EAAE,OAAO;wBACd,CAAC,CAAC,IAAI,IAAI,8FAA8F;wBACxG,CAAC,CAAC,IAAI,IAAI,0KAA0K;oBACtL,GAAG,EAAE,UAAU,CAAC,CAAC,CAAC,iBAAiB,UAAU,IAAI,CAAC,CAAC,CAAC,sBAAsB,KAAK,CAAC,iBAAiB,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG;iBAChH,CAAC,CAAC;YACL,CAAC,CAAC,CAAC;QACL,CAAC,CAAC;QACF,OAAO,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,OAAO,CAAC,CAAC,GAAG,EAAE,CAAC,EAAE,EAAE;YACzC,IAAI,KAAK,CAAC,GAAG,CAAC,EAAE,CAAC;gBACf,KAAK,CAAC,GAAG,CAAC,QAAQ,EAAE,kBAAkB,CAAC,YAAY,CAAC,CAAC;YACvD,CAAC;QACH,CAAC,CAAC,CAAC;QACH,KAAK,CAAC,SAAS,CAAC,cAAc,EAAE,0BAA0B,CAAC,CAAC;QAC5D,OAAO,MAAM,CAAC;IAChB,CAAC;CACF,CAAC,CAAC"}

package/dist/core/state/rules/format-column-pivot-display-format.js

@@ -0,0 +1,43 @@
+import { asArray, eachInSection, isObj } from '../expressions.js';
+import { defineRule } from './rule.js';
+/**
+ * A Format Column's DisplayFormat is matched against the generated pivot result column
+ * (`pivot_<pivotColumn>_<value>_<columnId>`), so a ColumnIds scope on the aggregation column
+ * never reaches it; only Style and Rule are inherited from the base column.
+ */
+export default defineRule({
+    id: 'format-column/pivot-display-format',
+    docs: 'handbook-column-formatting-display-format',
+    check({ state }) {
+        const pivotAggregated = new Map();
+        for (const layout of asArray(isObj(state.Layout) ? state.Layout.Layouts : undefined)) {
+            if (isObj(layout) && layout.PivotColumns !== undefined) {
+                for (const item of asArray(layout.PivotAggregationColumns)) {
+                    if (isObj(item) && typeof item.ColumnId === 'string' && !pivotAggregated.has(item.ColumnId)) {
+                        pivotAggregated.set(item.ColumnId, String(layout.Name));
+                    }
+                }
+            }
+        }
+        if (!pivotAggregated.size) {
+            return [];
+        }
+        const issues = [];
+        eachInSection(state, 'FormatColumn', 'FormatColumns', (formatColumn, path) => {
+            if (formatColumn.DisplayFormat === undefined || !isObj(formatColumn.Scope)) {
+                return;
+            }
+            const hit = asArray(formatColumn.Scope.ColumnIds).find((id) => typeof id === 'string' && pivotAggregated.has(id));
+            if (hit) {
+                issues.push({
+                    path: `${path}.Scope`,
+                    severity: 'warning',
+                    message: `DisplayFormat scoped to "${hit}" does not format its pivot result columns in Layout "${pivotAggregated.get(hit)}" (only Style and Rule are inherited).`,
+                    fix: "Scope the DisplayFormat with DataTypes (e.g. ['number']) or ColumnTypes (AG Grid `colDef.type`, copied onto pivot result columns), or list the generated pivot result column ids.",
+                });
+            }
+        });
+        return issues;
+    },
+});
+//# sourceMappingURL=format-column-pivot-display-format.js.map

package/dist/core/state/rules/format-column-pivot-display-format.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"format-column-pivot-display-format.js","sourceRoot":"","sources":["../../../../src/core/state/rules/format-column-pivot-display-format.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,aAAa,EAAE,KAAK,EAAE,MAAM,mBAAmB,CAAC;AAClE,OAAO,EAAE,UAAU,EAAkB,MAAM,WAAW,CAAC;AAEvD;;;;GAIG;AACH,eAAe,UAAU,CAAC;IACxB,EAAE,EAAE,oCAAoC;IACxC,IAAI,EAAE,2CAA2C;IACjD,KAAK,CAAC,EAAE,KAAK,EAAE;QACb,MAAM,eAAe,GAAG,IAAI,GAAG,EAAkB,CAAC;QAClD,KAAK,MAAM,MAAM,IAAI,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,SAAS,CAAC,EAAE,CAAC;YACrF,IAAI,KAAK,CAAC,MAAM,CAAC,IAAI,MAAM,CAAC,YAAY,KAAK,SAAS,EAAE,CAAC;gBACvD,KAAK,MAAM,IAAI,IAAI,OAAO,CAAC,MAAM,CAAC,uBAAuB,CAAC,EAAE,CAAC;oBAC3D,IAAI,KAAK,CAAC,IAAI,CAAC,IAAI,OAAO,IAAI,CAAC,QAAQ,KAAK,QAAQ,IAAI,CAAC,eAAe,CAAC,GAAG,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAE,CAAC;wBAC5F,eAAe,CAAC,GAAG,CAAC,IAAI,CAAC,QAAQ,EAAE,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC;oBAC1D,CAAC;gBACH,CAAC;YACH,CAAC;QACH,CAAC;QACD,IAAI,CAAC,eAAe,CAAC,IAAI,EAAE,CAAC;YAC1B,OAAO,EAAE,CAAC;QACZ,CAAC;QACD,MAAM,MAAM,GAAgB,EAAE,CAAC;QAC/B,aAAa,CAAC,KAAK,EAAE,cAAc,EAAE,eAAe,EAAE,CAAC,YAAY,EAAE,IAAI,EAAE,EAAE;YAC3E,IAAI,YAAY,CAAC,aAAa,KAAK,SAAS,IAAI,CAAC,KAAK,CAAC,YAAY,CAAC,KAAK,CAAC,EAAE,CAAC;gBAC3E,OAAO;YACT,CAAC;YACD,MAAM,GAAG,GAAG,OAAO,CAAC,YAAY,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC,IAAI,CAAC,CAAC,EAAE,EAAgB,EAAE,CAAC,OAAO,EAAE,KAAK,QAAQ,IAAI,eAAe,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC,CAAC;YAChI,IAAI,GAAG,EAAE,CAAC;gBACR,MAAM,CAAC,IAAI,CAAC;oBACV,IAAI,EAAE,GAAG,IAAI,QAAQ;oBACrB,QAAQ,EAAE,SAAS;oBACnB,OAAO,EAAE,4BAA4B,GAAG,yDAAyD,eAAe,CAAC,GAAG,CAAC,GAAG,CAAC,wCAAwC;oBACjK,GAAG,EAAE,mLAAmL;iBACzL,CAAC,CAAC;YACL,CAAC;QACH,CAAC,CAAC,CAAC;QACH,OAAO,MAAM,CAAC;IAChB,CAAC;CACF,CAAC,CAAC"}

package/dist/core/state/rules/helpers.js

@@ -0,0 +1,39 @@
+import { levenshtein } from '../did-you-mean.js';
+import { asArray, isObj } from '../expressions.js';
+/** Every object inside an array property of a State section: `(section, list, item, path, index)` */
+export function eachListItem(state, fn, options = {}) {
+    for (const [section, value] of Object.entries(state)) {
+        if (!isObj(value) || options.exclude?.includes(section) || (options.sections && !options.sections.includes(section))) {
+            continue;
+        }
+        for (const [list, items] of Object.entries(value)) {
+            if (!Array.isArray(items)) {
+                continue;
+            }
+            items.forEach((item, index) => {
+                if (isObj(item)) {
+                    fn(section, list, item, `${section}.${list}[${index}]`, index);
+                }
+            });
+        }
+    }
+}
+export const strings = (value) => asArray(value).filter((v) => typeof v === 'string');
+/** The closest known name (distance ≤ 2, or a case-only difference), for did-you-mean */
+export function closest(name, known) {
+    const lower = name.toLowerCase();
+    const cased = known.find((k) => k !== name && k.toLowerCase() === lower);
+    if (cased) {
+        return cased;
+    }
+    let best;
+    for (const candidate of known) {
+        const distance = levenshtein(lower, candidate.toLowerCase());
+        if (distance <= 2 && (!best || distance < best.distance)) {
+            best = { name: candidate, distance };
+        }
+    }
+    return best?.name;
+}
+export const quote = (names) => names.map((n) => `"${n}"`).join(', ');
+//# sourceMappingURL=helpers.js.map

package/dist/core/state/rules/helpers.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"helpers.js","sourceRoot":"","sources":["../../../../src/core/state/rules/helpers.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,oBAAoB,CAAC;AACjD,OAAO,EAAE,OAAO,EAAE,KAAK,EAAY,MAAM,mBAAmB,CAAC;AAE7D,qGAAqG;AACrG,MAAM,UAAU,YAAY,CAC1B,KAAU,EACV,EAAmF,EACnF,UAAyE,EAAE;IAE3E,KAAK,MAAM,CAAC,OAAO,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;QACrD,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,IAAI,OAAO,CAAC,OAAO,EAAE,QAAQ,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,QAAQ,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,EAAE,CAAC;YACrH,SAAS;QACX,CAAC;QACD,KAAK,MAAM,CAAC,IAAI,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;YAClD,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;gBAC1B,SAAS;YACX,CAAC;YACD,KAAK,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,KAAK,EAAE,EAAE;gBAC5B,IAAI,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC;oBAChB,EAAE,CAAC,OAAO,EAAE,IAAI,EAAE,IAAI,EAAE,GAAG,OAAO,IAAI,IAAI,IAAI,KAAK,GAAG,EAAE,KAAK,CAAC,CAAC;gBACjE,CAAC;YACH,CAAC,CAAC,CAAC;QACL,CAAC;IACH,CAAC;AACH,CAAC;AAED,MAAM,CAAC,MAAM,OAAO,GAAG,CAAC,KAAc,EAAY,EAAE,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAe,EAAE,CAAC,OAAO,CAAC,KAAK,QAAQ,CAAC,CAAC;AAEtH,yFAAyF;AACzF,MAAM,UAAU,OAAO,CAAC,IAAY,EAAE,KAAwB;IAC5D,MAAM,KAAK,GAAG,IAAI,CAAC,WAAW,EAAE,CAAC;IACjC,MAAM,KAAK,GAAG,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,KAAK,IAAI,IAAI,CAAC,CAAC,WAAW,EAAE,KAAK,KAAK,CAAC,CAAC;IACzE,IAAI,KAAK,EAAE,CAAC;QACV,OAAO,KAAK,CAAC;IACf,CAAC;IACD,IAAI,IAAoD,CAAC;IACzD,KAAK,MAAM,SAAS,IAAI,KAAK,EAAE,CAAC;QAC9B,MAAM,QAAQ,GAAG,WAAW,CAAC,KAAK,EAAE,SAAS,CAAC,WAAW,EAAE,CAAC,CAAC;QAC7D,IAAI,QAAQ,IAAI,CAAC,IAAI,CAAC,CAAC,IAAI,IAAI,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC,EAAE,CAAC;YACzD,IAAI,GAAG,EAAE,IAAI,EAAE,SAAS,EAAE,QAAQ,EAAE,CAAC;QACvC,CAAC;IACH,CAAC;IACD,OAAO,IAAI,EAAE,IAAI,CAAC;AACpB,CAAC;AAED,MAAM,CAAC,MAAM,KAAK,GAAG,CAAC,KAAwB,EAAU,EAAE,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC"}

package/dist/core/state/rules/index.js

@@ -0,0 +1,80 @@
+import aqlLegacyShape from './aql-legacy-shape.js';
+import aqlMissing from './aql-missing.js';
+import aqlSyntax from './aql-syntax.js';
+import calculatedSettings from './calculated-settings.js';
+import columnIdExists from './column-id-exists.js';
+import dashboardModuleNames from './dashboard-module-names.js';
+import dashboardToolbarNames from './dashboard-toolbar-names.js';
+import formatColumnPivotDisplayFormat from './format-column-pivot-display-format.js';
+import layoutColumnRefs from './layout-column-refs.js';
+import layoutCurrentExists from './layout-current-exists.js';
+import layoutNonEmpty from './layout-non-empty.js';
+import scopeColumnRefs from './scope-column-refs.js';
+import scopeShape from './scope-shape.js';
+import stateUniqueName from './state-unique-name.js';
+import stateUnknownSection from './state-unknown-section.js';
+import typeDiscriminator from './type-discriminator.js';
+export const ALL_RULES = [
+    stateUnknownSection,
+    stateUniqueName,
+    layoutNonEmpty,
+    layoutCurrentExists,
+    typeDiscriminator,
+    layoutColumnRefs,
+    scopeShape,
+    scopeColumnRefs,
+    columnIdExists,
+    dashboardToolbarNames,
+    dashboardModuleNames,
+    calculatedSettings,
+    aqlLegacyShape,
+    aqlMissing,
+    aqlSyntax,
+    formatColumnPivotDisplayFormat,
+];
+export const RULE_IDS = ALL_RULES.map((rule) => rule.id);
+/** Runs every applicable rule; positions come from the extractor's line map when present */
+export function runRules(ctx, lineMap) {
+    const issues = [];
+    const applied = [];
+    const skipped = [];
+    for (const rule of ALL_RULES) {
+        if (rule.appliesTo && !rule.appliesTo(ctx)) {
+            skipped.push(rule.id);
+            continue;
+        }
+        applied.push(rule.id);
+        for (const found of rule.check(ctx)) {
+            const issue = { code: rule.id, severity: found.severity, path: found.path, message: found.message, docs: rule.docs };
+            if (found.fix) {
+                issue.fix = found.fix;
+            }
+            const entry = lineMap?.[found.path];
+            const position = (found.at === 'key' ? entry?.key : undefined) ?? entry?.value ?? nearestPosition(lineMap, found.path);
+            if (position) {
+                issue.file = position.file;
+                issue.line = position.line;
+                issue.column = position.column;
+            }
+            issues.push(issue);
+        }
+    }
+    return { issues, applied, skipped };
+}
+/** A rule may point at a path the value does not have (a missing property): fall back to the nearest ancestor */
+function nearestPosition(lineMap, path) {
+    if (!lineMap) {
+        return undefined;
+    }
+    let current = path;
+    while (current) {
+        const entry = lineMap[current];
+        if (entry) {
+            return entry.value;
+        }
+        const cut = Math.max(current.lastIndexOf('.'), current.lastIndexOf('['));
+        current = cut > 0 ? current.slice(0, cut) : '';
+    }
+    return lineMap['']?.value;
+}
+//# sourceMappingURL=index.js.map

package/dist/core/state/rules/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/core/state/rules/index.ts"],"names":[],"mappings":"AAKA,OAAO,cAAc,MAAM,uBAAuB,CAAC;AACnD,OAAO,UAAU,MAAM,kBAAkB,CAAC;AAC1C,OAAO,SAAS,MAAM,iBAAiB,CAAC;AACxC,OAAO,kBAAkB,MAAM,0BAA0B,CAAC;AAC1D,OAAO,cAAc,MAAM,uBAAuB,CAAC;AACnD,OAAO,oBAAoB,MAAM,6BAA6B,CAAC;AAC/D,OAAO,qBAAqB,MAAM,8BAA8B,CAAC;AACjE,OAAO,8BAA8B,MAAM,yCAAyC,CAAC;AACrF,OAAO,gBAAgB,MAAM,yBAAyB,CAAC;AACvD,OAAO,mBAAmB,MAAM,4BAA4B,CAAC;AAC7D,OAAO,cAAc,MAAM,uBAAuB,CAAC;AACnD,OAAO,eAAe,MAAM,wBAAwB,CAAC;AACrD,OAAO,UAAU,MAAM,kBAAkB,CAAC;AAC1C,OAAO,eAAe,MAAM,wBAAwB,CAAC;AACrD,OAAO,mBAAmB,MAAM,4BAA4B,CAAC;AAC7D,OAAO,iBAAiB,MAAM,yBAAyB,CAAC;AAKxD,MAAM,CAAC,MAAM,SAAS,GAAoB;IACxC,mBAAmB;IACnB,eAAe;IACf,cAAc;IACd,mBAAmB;IACnB,iBAAiB;IACjB,gBAAgB;IAChB,UAAU;IACV,eAAe;IACf,cAAc;IACd,qBAAqB;IACrB,oBAAoB;IACpB,kBAAkB;IAClB,cAAc;IACd,UAAU;IACV,SAAS;IACT,8BAA8B;CAC/B,CAAC;AAEF,MAAM,CAAC,MAAM,QAAQ,GAAsB,SAAS,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;AAE5E,4FAA4F;AAC5F,MAAM,UAAU,QAAQ,CAAC,GAAgB,EAAE,OAAiB;IAC1D,MAAM,MAAM,GAAY,EAAE,CAAC;IAC3B,MAAM,OAAO,GAAa,EAAE,CAAC;IAC7B,MAAM,OAAO,GAAa,EAAE,CAAC;IAC7B,KAAK,MAAM,IAAI,IAAI,SAAS,EAAE,CAAC;QAC7B,IAAI,IAAI,CAAC,SAAS,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,EAAE,CAAC;YAC3C,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;YACtB,SAAS;QACX,CAAC;QACD,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QACtB,KAAK,MAAM,KAAK,IAAI,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,EAAE,CAAC;YACpC,MAAM,KAAK,GAAU,EAAE,IAAI,EAAE,IAAI,CAAC,EAAE,EAAE,QAAQ,EAAE,KAAK,CAAC,QAAQ,EAAE,IAAI,EAAE,KAAK,CAAC,IAAI,EAAE,OAAO,EAAE,KAAK,CAAC,OAAO,EAAE,IAAI,EAAE,IAAI,CAAC,IAAI,EAAE,CAAC;YAC5H,IAAI,KAAK,CAAC,GAAG,EAAE,CAAC;gBACd,KAAK,CAAC,GAAG,GAAG,KAAK,CAAC,GAAG,CAAC;YACxB,CAAC;YACD,MAAM,KAAK,GAAG,OAAO,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;YACpC,MAAM,QAAQ,GAAG,CAAC,KAAK,CAAC,EAAE,KAAK,KAAK,CAAC,CAAC,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC,CAAC,SAAS,CAAC,IAAI,KAAK,EAAE,KAAK,IAAI,eAAe,CAAC,OAAO,EAAE,KAAK,CAAC,IAAI,CAAC,CAAC;YACvH,IAAI,QAAQ,EAAE,CAAC;gBACb,KAAK,CAAC,IAAI,GAAG,QAAQ,CAAC,IAAI,CAAC;gBAC3B,KAAK,CAAC,IAAI,GAAG,QAAQ,CAAC,IAAI,CAAC;gBAC3B,KAAK,CAAC,MAAM,GAAG,QAAQ,CAAC,MAAM,CAAC;YACjC,CAAC;YACD,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QACrB,CAAC;IACH,CAAC;IACD,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,OAAO,EAAE,CAAC;AACtC,CAAC;AAED,iHAAiH;AACjH,SAAS,eAAe,CAAC,OAA4B,EAAE,IAAY;IACjE,IAAI,CAAC,OAAO,EAAE,CAAC;QACb,OAAO,SAAS,CAAC;IACnB,CAAC;IACD,IAAI,OAAO,GAAG,IAAI,CAAC;IACnB,OAAO,OAAO,EAAE,CAAC;QACf,MAAM,KAAK,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC;QAC/B,IAAI,KAAK,EAAE,CAAC;YACV,OAAO,KAAK,CAAC,KAAK,CAAC;QACrB,CAAC;QACD,MAAM,GAAG,GAAG,IAAI,CAAC,GAAG,CAAC,OAAO,CAAC,WAAW,CAAC,GAAG,CAAC,EAAE,OAAO,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC,CAAC;QACzE,OAAO,GAAG,GAAG,GAAG,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;IACjD,CAAC;IACD,OAAO,OAAO,CAAC,EAAE,CAAC,EAAE,KAAK,CAAC;AAC5B,CAAC"}

package/dist/core/state/rules/layout-column-refs.js

@@ -0,0 +1,60 @@
+import { caseMatch, knownColumn } from '../columns.js';
+import { asArray, isObj } from '../expressions.js';
+import { defineRule } from './rule.js';
+function layoutColumnRefs(layout) {
+    const refs = [];
+    for (const key of ['TableColumns', 'PivotColumns', 'RowGroupedColumns', 'PivotGroupedColumns']) {
+        for (const id of asArray(layout[key])) {
+            if (typeof id === 'string') {
+                refs.push({ key, columnId: id });
+            }
+        }
+    }
+    for (const key of ['ColumnSorts', 'ColumnFilters', 'TableAggregationColumns', 'PivotAggregationColumns']) {
+        for (const item of asArray(layout[key])) {
+            if (isObj(item) && typeof item.ColumnId === 'string') {
+                refs.push({ key, columnId: item.ColumnId });
+            }
+        }
+    }
+    for (const key of ['ColumnSizing', 'ColumnPinning', 'ColumnVisibility', 'ColumnHeaders']) {
+        if (isObj(layout[key])) {
+            for (const id of Object.keys(layout[key])) {
+                refs.push({ key, columnId: id });
+            }
+        }
+    }
+    return refs;
+}
+/** Every column a Layout names exists in the effective column universe */
+export default defineRule({
+    id: 'layout/column-refs',
+    docs: 'handbook-layouts',
+    appliesTo: ({ columns }) => !!columns,
+    check({ state, columns }) {
+        const issues = [];
+        asArray(isObj(state.Layout) ? state.Layout.Layouts : undefined).forEach((layout, i) => {
+            if (!isObj(layout)) {
+                return;
+            }
+            const reported = new Set();
+            for (const { key, columnId } of layoutColumnRefs(layout)) {
+                if (knownColumn(columns, columnId) || reported.has(columnId)) {
+                    continue;
+                }
+                reported.add(columnId);
+                const cased = caseMatch(columns, columnId);
+                issues.push({
+                    path: `Layout.Layouts[${i}].${key}`,
+                    severity: 'error',
+                    message: `Column "${columnId}" is not in the grid's columns (${columns.source}).`,
+                    fix: cased
+                        ? `Use "${cased}" — column ids are case-sensitive.`
+                        : 'Use a column id from columnDefs (`colId`, else `field`), a Calculated / FreeText Column id, or an Action Column id; add the column if it should exist.',
+                });
+            }
+        });
+        return issues;
+    },
+});
+//# sourceMappingURL=layout-column-refs.js.map

package/dist/core/state/rules/layout-column-refs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"layout-column-refs.js","sourceRoot":"","sources":["../../../../src/core/state/rules/layout-column-refs.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AACvD,OAAO,EAAE,OAAO,EAAE,KAAK,EAAY,MAAM,mBAAmB,CAAC;AAC7D,OAAO,EAAE,UAAU,EAAkB,MAAM,WAAW,CAAC;AAEvD,SAAS,gBAAgB,CAAC,MAAW;IACnC,MAAM,IAAI,GAAwC,EAAE,CAAC;IACrD,KAAK,MAAM,GAAG,IAAI,CAAC,cAAc,EAAE,cAAc,EAAE,mBAAmB,EAAE,qBAAqB,CAAC,EAAE,CAAC;QAC/F,KAAK,MAAM,EAAE,IAAI,OAAO,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,EAAE,CAAC;YACtC,IAAI,OAAO,EAAE,KAAK,QAAQ,EAAE,CAAC;gBAC3B,IAAI,CAAC,IAAI,CAAC,EAAE,GAAG,EAAE,QAAQ,EAAE,EAAE,EAAE,CAAC,CAAC;YACnC,CAAC;QACH,CAAC;IACH,CAAC;IACD,KAAK,MAAM,GAAG,IAAI,CAAC,aAAa,EAAE,eAAe,EAAE,yBAAyB,EAAE,yBAAyB,CAAC,EAAE,CAAC;QACzG,KAAK,MAAM,IAAI,IAAI,OAAO,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,EAAE,CAAC;YACxC,IAAI,KAAK,CAAC,IAAI,CAAC,IAAI,OAAO,IAAI,CAAC,QAAQ,KAAK,QAAQ,EAAE,CAAC;gBACrD,IAAI,CAAC,IAAI,CAAC,EAAE,GAAG,EAAE,QAAQ,EAAE,IAAI,CAAC,QAAQ,EAAE,CAAC,CAAC;YAC9C,CAAC;QACH,CAAC;IACH,CAAC;IACD,KAAK,MAAM,GAAG,IAAI,CAAC,cAAc,EAAE,eAAe,EAAE,kBAAkB,EAAE,eAAe,CAAC,EAAE,CAAC;QACzF,IAAI,KAAK,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,EAAE,CAAC;YACvB,KAAK,MAAM,EAAE,IAAI,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,GAAG,CAAQ,CAAC,EAAE,CAAC;gBACjD,IAAI,CAAC,IAAI,CAAC,EAAE,GAAG,EAAE,QAAQ,EAAE,EAAE,EAAE,CAAC,CAAC;YACnC,CAAC;QACH,CAAC;IACH,CAAC;IACD,OAAO,IAAI,CAAC;AACd,CAAC;AAED,0EAA0E;AAC1E,eAAe,UAAU,CAAC;IACxB,EAAE,EAAE,oBAAoB;IACxB,IAAI,EAAE,kBAAkB;IACxB,SAAS,EAAE,CAAC,EAAE,OAAO,EAAE,EAAE,EAAE,CAAC,CAAC,CAAC,OAAO;IACrC,KAAK,CAAC,EAAE,KAAK,EAAE,OAAO,EAAE;QACtB,MAAM,MAAM,GAAgB,EAAE,CAAC;QAC/B,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,OAAO,CAAC,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE;YACpF,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,EAAE,CAAC;gBACnB,OAAO;YACT,CAAC;YACD,MAAM,QAAQ,GAAG,IAAI,GAAG,EAAU,CAAC;YACnC,KAAK,MAAM,EAAE,GAAG,EAAE,QAAQ,EAAE,IAAI,gBAAgB,CAAC,MAAM,CAAC,EAAE,CAAC;gBACzD,IAAI,WAAW,CAAC,OAAQ,EAAE,QAAQ,CAAC,IAAI,QAAQ,CAAC,GAAG,CAAC,QAAQ,CAAC,EAAE,CAAC;oBAC9D,SAAS;gBACX,CAAC;gBACD,QAAQ,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;gBACvB,MAAM,KAAK,GAAG,SAAS,CAAC,OAAQ,EAAE,QAAQ,CAAC,CAAC;gBAC5C,MAAM,CAAC,IAAI,CAAC;oBACV,IAAI,EAAE,kBAAkB,CAAC,KAAK,GAAG,EAAE;oBACnC,QAAQ,EAAE,OAAO;oBACjB,OAAO,EAAE,WAAW,QAAQ,mCAAmC,OAAQ,CAAC,MAAM,IAAI;oBAClF,GAAG,EAAE,KAAK;wBACR,CAAC,CAAC,QAAQ,KAAK,oCAAoC;wBACnD,CAAC,CAAC,wJAAwJ;iBAC7J,CAAC,CAAC;YACL,CAAC;QACH,CAAC,CAAC,CAAC;QACH,OAAO,MAAM,CAAC;IAChB,CAAC;CACF,CAAC,CAAC"}

package/dist/core/state/rules/layout-current-exists.js

@@ -0,0 +1,27 @@
+import { asArray, isObj } from '../expressions.js';
+import { quote } from './helpers.js';
+import { defineRule } from './rule.js';
+/** `Layout.CurrentLayout` names one of the Layouts */
+export default defineRule({
+    id: 'layout/current-exists',
+    docs: 'handbook-layouts',
+    check({ state }) {
+        const layoutState = isObj(state.Layout) ? state.Layout : undefined;
+        const current = layoutState?.CurrentLayout;
+        const names = asArray(layoutState?.Layouts)
+            .map((layout) => (isObj(layout) && typeof layout.Name === 'string' ? layout.Name : undefined))
+            .filter((name) => !!name);
+        if (typeof current !== 'string' || !names.length || names.includes(current)) {
+            return [];
+        }
+        return [
+            {
+                path: 'Layout.CurrentLayout',
+                severity: 'error',
+                message: `CurrentLayout "${current}" does not match any Layout Name (${quote(names)}).`,
+                fix: `Set \`CurrentLayout\` to one of ${quote(names)}, or rename that Layout to "${current}".`,
+            },
+        ];
+    },
+});
+//# sourceMappingURL=layout-current-exists.js.map

package/dist/core/state/rules/layout-current-exists.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"layout-current-exists.js","sourceRoot":"","sources":["../../../../src/core/state/rules/layout-current-exists.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,KAAK,EAAE,MAAM,mBAAmB,CAAC;AACnD,OAAO,EAAE,KAAK,EAAE,MAAM,cAAc,CAAC;AACrC,OAAO,EAAE,UAAU,EAAE,MAAM,WAAW,CAAC;AAEvC,sDAAsD;AACtD,eAAe,UAAU,CAAC;IACxB,EAAE,EAAE,uBAAuB;IAC3B,IAAI,EAAE,kBAAkB;IACxB,KAAK,CAAC,EAAE,KAAK,EAAE;QACb,MAAM,WAAW,GAAG,KAAK,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,SAAS,CAAC;QACnE,MAAM,OAAO,GAAG,WAAW,EAAE,aAAa,CAAC;QAC3C,MAAM,KAAK,GAAG,OAAO,CAAC,WAAW,EAAE,OAAO,CAAC;aACxC,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,KAAK,CAAC,MAAM,CAAC,IAAI,OAAO,MAAM,CAAC,IAAI,KAAK,QAAQ,CAAC,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC;aAC7F,MAAM,CAAC,CAAC,IAAI,EAAkB,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;QAC5C,IAAI,OAAO,OAAO,KAAK,QAAQ,IAAI,CAAC,KAAK,CAAC,MAAM,IAAI,KAAK,CAAC,QAAQ,CAAC,OAAO,CAAC,EAAE,CAAC;YAC5E,OAAO,EAAE,CAAC;QACZ,CAAC;QACD,OAAO;YACL;gBACE,IAAI,EAAE,sBAAsB;gBAC5B,QAAQ,EAAE,OAAO;gBACjB,OAAO,EAAE,kBAAkB,OAAO,qCAAqC,KAAK,CAAC,KAAK,CAAC,IAAI;gBACvF,GAAG,EAAE,mCAAmC,KAAK,CAAC,KAAK,CAAC,+BAA+B,OAAO,IAAI;aAC/F;SACF,CAAC;IACJ,CAAC;CACF,CAAC,CAAC"}

package/dist/core/state/rules/layout-non-empty.js

@@ -0,0 +1,32 @@
+import { asArray, isObj } from '../expressions.js';
+import { defineRule } from './rule.js';
+/**
+ * Initial State must include a Layout unless `layoutOptions.autoCreateLayout` creates
+ * one: an error when the Options literal is visible and does not set it, a warning
+ * naming the option when no Options literal is visible (plan §8.4).
+ */
+export default defineRule({
+    id: 'layout/non-empty',
+    docs: 'handbook-layouts',
+    check({ state, options }) {
+        const layouts = asArray(isObj(state.Layout) ? state.Layout.Layouts : undefined);
+        if (layouts.length) {
+            return [];
+        }
+        const layoutOptions = options && isObj(options.layoutOptions) ? options.layoutOptions : undefined;
+        if (options && layoutOptions?.autoCreateLayout) {
+            return [];
+        }
+        return [
+            {
+                path: 'Layout.Layouts',
+                severity: options ? 'error' : 'warning',
+                message: options
+                    ? 'No Layouts, and `layoutOptions.autoCreateLayout` is not set in the Adaptable Options: the grid would start without a Layout.'
+                    : 'No Layouts: Initial State must include at least one Layout unless `layoutOptions.autoCreateLayout` is set (the Adaptable Options were not visible to this check).',
+                fix: 'Add `Layout: { Layouts: [{ Name: "Default", TableColumns: [/* column ids */] }] }`, or set `layoutOptions: { autoCreateLayout: true }` in the Adaptable Options.',
+            },
+        ];
+    },
+});
+//# sourceMappingURL=layout-non-empty.js.map

package/dist/core/state/rules/layout-non-empty.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"layout-non-empty.js","sourceRoot":"","sources":["../../../../src/core/state/rules/layout-non-empty.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,KAAK,EAAE,MAAM,mBAAmB,CAAC;AACnD,OAAO,EAAE,UAAU,EAAE,MAAM,WAAW,CAAC;AAEvC;;;;GAIG;AACH,eAAe,UAAU,CAAC;IACxB,EAAE,EAAE,kBAAkB;IACtB,IAAI,EAAE,kBAAkB;IACxB,KAAK,CAAC,EAAE,KAAK,EAAE,OAAO,EAAE;QACtB,MAAM,OAAO,GAAG,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC;QAChF,IAAI,OAAO,CAAC,MAAM,EAAE,CAAC;YACnB,OAAO,EAAE,CAAC;QACZ,CAAC;QACD,MAAM,aAAa,GAAG,OAAO,IAAI,KAAK,CAAC,OAAO,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,aAAa,CAAC,CAAC,CAAC,SAAS,CAAC;QAClG,IAAI,OAAO,IAAI,aAAa,EAAE,gBAAgB,EAAE,CAAC;YAC/C,OAAO,EAAE,CAAC;QACZ,CAAC;QACD,OAAO;YACL;gBACE,IAAI,EAAE,gBAAgB;gBACtB,QAAQ,EAAE,OAAO,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,SAAS;gBACvC,OAAO,EAAE,OAAO;oBACd,CAAC,CAAC,8HAA8H;oBAChI,CAAC,CAAC,mKAAmK;gBACvK,GAAG,EAAE,kKAAkK;aACxK;SACF,CAAC;IACJ,CAAC;CACF,CAAC,CAAC"}

package/dist/core/state/rules/rule.js

@@ -0,0 +1,2 @@
+export const defineRule = (rule) => rule;
+//# sourceMappingURL=rule.js.map

package/dist/core/state/rules/rule.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"rule.js","sourceRoot":"","sources":["../../../../src/core/state/rules/rule.ts"],"names":[],"mappings":"AAsDA,MAAM,CAAC,MAAM,UAAU,GAAG,CAAC,IAAU,EAAQ,EAAE,CAAC,IAAI,CAAC"}

package/dist/core/state/rules/scope-column-refs.js

@@ -0,0 +1,32 @@
+import { caseMatch, knownColumn } from '../columns.js';
+import { isObj } from '../expressions.js';
+import { eachListItem, strings } from './helpers.js';
+import { defineRule } from './rule.js';
+/** Every `Scope.ColumnIds` entry exists in the effective column universe, with the exact fix for a case mismatch */
+export default defineRule({
+    id: 'scope/column-refs',
+    docs: 'dev-guide-columns-scope',
+    appliesTo: ({ columns }) => !!columns,
+    check({ state, columns }) {
+        const issues = [];
+        eachListItem(state, (_section, _list, item, path) => {
+            if (!isObj(item.Scope)) {
+                return;
+            }
+            strings(item.Scope.ColumnIds).forEach((columnId, i) => {
+                if (knownColumn(columns, columnId)) {
+                    return;
+                }
+                const cased = caseMatch(columns, columnId);
+                issues.push({
+                    path: `${path}.Scope.ColumnIds[${i}]`,
+                    severity: 'error',
+                    message: `Column "${columnId}" is not in the grid's columns (${columns.source}).`,
+                    fix: cased ? `Use "${cased}" — column ids are case-sensitive.` : 'Use a column id from columnDefs (`colId`, else `field`) or a column the State defines.',
+                });
+            });
+        });
+        return issues;
+    },
+});
+//# sourceMappingURL=scope-column-refs.js.map

package/dist/core/state/rules/scope-column-refs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"scope-column-refs.js","sourceRoot":"","sources":["../../../../src/core/state/rules/scope-column-refs.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AACvD,OAAO,EAAE,KAAK,EAAE,MAAM,mBAAmB,CAAC;AAC1C,OAAO,EAAE,YAAY,EAAE,OAAO,EAAE,MAAM,cAAc,CAAC;AACrD,OAAO,EAAE,UAAU,EAAkB,MAAM,WAAW,CAAC;AAEvD,oHAAoH;AACpH,eAAe,UAAU,CAAC;IACxB,EAAE,EAAE,mBAAmB;IACvB,IAAI,EAAE,yBAAyB;IAC/B,SAAS,EAAE,CAAC,EAAE,OAAO,EAAE,EAAE,EAAE,CAAC,CAAC,CAAC,OAAO;IACrC,KAAK,CAAC,EAAE,KAAK,EAAE,OAAO,EAAE;QACtB,MAAM,MAAM,GAAgB,EAAE,CAAC;QAC/B,YAAY,CAAC,KAAK,EAAE,CAAC,QAAQ,EAAE,KAAK,EAAE,IAAI,EAAE,IAAI,EAAE,EAAE;YAClD,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC;gBACvB,OAAO;YACT,CAAC;YACD,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC,OAAO,CAAC,CAAC,QAAQ,EAAE,CAAC,EAAE,EAAE;gBACpD,IAAI,WAAW,CAAC,OAAQ,EAAE,QAAQ,CAAC,EAAE,CAAC;oBACpC,OAAO;gBACT,CAAC;gBACD,MAAM,KAAK,GAAG,SAAS,CAAC,OAAQ,EAAE,QAAQ,CAAC,CAAC;gBAC5C,MAAM,CAAC,IAAI,CAAC;oBACV,IAAI,EAAE,GAAG,IAAI,oBAAoB,CAAC,GAAG;oBACrC,QAAQ,EAAE,OAAO;oBACjB,OAAO,EAAE,WAAW,QAAQ,mCAAmC,OAAQ,CAAC,MAAM,IAAI;oBAClF,GAAG,EAAE,KAAK,CAAC,CAAC,CAAC,QAAQ,KAAK,oCAAoC,CAAC,CAAC,CAAC,wFAAwF;iBAC1J,CAAC,CAAC;YACL,CAAC,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;QACH,OAAO,MAAM,CAAC;IAChB,CAAC;CACF,CAAC,CAAC"}

package/dist/core/state/rules/scope-shape.js

@@ -0,0 +1,61 @@
+import { isObj } from '../expressions.js';
+import { eachListItem, quote } from './helpers.js';
+import { defineRule } from './rule.js';
+const SCOPE_KEYS = ['All', 'ColumnIds', 'DataTypes', 'ColumnTypes'];
+/** A `Scope` is exactly one of `{ All: true }`, `{ ColumnIds }`, `{ DataTypes }`, `{ ColumnTypes }`, with a non-empty list */
+export default defineRule({
+    id: 'scope/shape',
+    docs: 'dev-guide-columns-scope',
+    check({ state }) {
+        const issues = [];
+        eachListItem(state, (_section, _list, item, path) => {
+            if (!isObj(item.Scope)) {
+                return;
+            }
+            const scope = item.Scope;
+            const scopePath = `${path}.Scope`;
+            // a mis-cased key (`columnIds`) is the common slip: report it at the key with the exact fix
+            let miscased = false;
+            for (const key of Object.keys(scope)) {
+                const proper = SCOPE_KEYS.find((k) => k !== key && k.toLowerCase() === key.toLowerCase());
+                if (proper) {
+                    miscased = true;
+                    issues.push({
+                        path: `${scopePath}.${key}`,
+                        severity: 'error',
+                        at: 'key',
+                        message: `Scope key \`${key}\` is not recognised; Scope keys are case-sensitive.`,
+                        fix: `Rename \`${key}\` to \`${proper}\`.`,
+                    });
+                }
+            }
+            if (miscased) {
+                return;
+            }
+            const present = SCOPE_KEYS.filter((key) => scope[key] !== undefined);
+            if (present.length !== 1) {
+                issues.push({
+                    path: scopePath,
+                    severity: 'error',
+                    message: present.length
+                        ? `Scope has ${quote(present)}; it must be exactly one of ${quote(SCOPE_KEYS)}.`
+                        : `Scope is empty; it must be one of \`{ All: true }\`, \`{ ColumnIds: [...] }\`, \`{ DataTypes: [...] }\` or \`{ ColumnTypes: [...] }\`.`,
+                });
+                return;
+            }
+            const [key] = present;
+            if (key === 'All' && scope.All !== true) {
+                issues.push({ path: `${scopePath}.All`, severity: 'error', message: '`Scope.All` must be `true`.' });
+            }
+            else if (key !== 'All' && (!Array.isArray(scope[key]) || !scope[key].length)) {
+                issues.push({
+                    path: `${scopePath}.${key}`,
+                    severity: 'error',
+                    message: `\`Scope.${key}\` must be a non-empty array${key === 'DataTypes' ? " of 'text' | 'number' | 'boolean' | 'date' | 'textArray' | 'numberArray'" : ''}.`,
+                });
+            }
+        });
+        return issues;
+    },
+});
+//# sourceMappingURL=scope-shape.js.map

package/dist/core/state/rules/scope-shape.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"scope-shape.js","sourceRoot":"","sources":["../../../../src/core/state/rules/scope-shape.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,mBAAmB,CAAC;AAC1C,OAAO,EAAE,YAAY,EAAE,KAAK,EAAE,MAAM,cAAc,CAAC;AACnD,OAAO,EAAE,UAAU,EAAkB,MAAM,WAAW,CAAC;AAEvD,MAAM,UAAU,GAAG,CAAC,KAAK,EAAE,WAAW,EAAE,WAAW,EAAE,aAAa,CAAC,CAAC;AAEpE,8HAA8H;AAC9H,eAAe,UAAU,CAAC;IACxB,EAAE,EAAE,aAAa;IACjB,IAAI,EAAE,yBAAyB;IAC/B,KAAK,CAAC,EAAE,KAAK,EAAE;QACb,MAAM,MAAM,GAAgB,EAAE,CAAC;QAC/B,YAAY,CAAC,KAAK,EAAE,CAAC,QAAQ,EAAE,KAAK,EAAE,IAAI,EAAE,IAAI,EAAE,EAAE;YAClD,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC;gBACvB,OAAO;YACT,CAAC;YACD,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC;YACzB,MAAM,SAAS,GAAG,GAAG,IAAI,QAAQ,CAAC;YAClC,4FAA4F;YAC5F,IAAI,QAAQ,GAAG,KAAK,CAAC;YACrB,KAAK,MAAM,GAAG,IAAI,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC;gBACrC,MAAM,MAAM,GAAG,UAAU,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,KAAK,GAAG,IAAI,CAAC,CAAC,WAAW,EAAE,KAAK,GAAG,CAAC,WAAW,EAAE,CAAC,CAAC;gBAC1F,IAAI,MAAM,EAAE,CAAC;oBACX,QAAQ,GAAG,IAAI,CAAC;oBAChB,MAAM,CAAC,IAAI,CAAC;wBACV,IAAI,EAAE,GAAG,SAAS,IAAI,GAAG,EAAE;wBAC3B,QAAQ,EAAE,OAAO;wBACjB,EAAE,EAAE,KAAK;wBACT,OAAO,EAAE,eAAe,GAAG,sDAAsD;wBACjF,GAAG,EAAE,YAAY,GAAG,WAAW,MAAM,KAAK;qBAC3C,CAAC,CAAC;gBACL,CAAC;YACH,CAAC;YACD,IAAI,QAAQ,EAAE,CAAC;gBACb,OAAO;YACT,CAAC;YACD,MAAM,OAAO,GAAG,UAAU,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,KAAK,CAAC,GAAG,CAAC,KAAK,SAAS,CAAC,CAAC;YACrE,IAAI,OAAO,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;gBACzB,MAAM,CAAC,IAAI,CAAC;oBACV,IAAI,EAAE,SAAS;oBACf,QAAQ,EAAE,OAAO;oBACjB,OAAO,EAAE,OAAO,CAAC,MAAM;wBACrB,CAAC,CAAC,aAAa,KAAK,CAAC,OAAO,CAAC,+BAA+B,KAAK,CAAC,UAAU,CAAC,GAAG;wBAChF,CAAC,CAAC,wIAAwI;iBAC7I,CAAC,CAAC;gBACH,OAAO;YACT,CAAC;YACD,MAAM,CAAC,GAAG,CAAC,GAAG,OAAO,CAAC;YACtB,IAAI,GAAG,KAAK,KAAK,IAAI,KAAK,CAAC,GAAG,KAAK,IAAI,EAAE,CAAC;gBACxC,MAAM,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,GAAG,SAAS,MAAM,EAAE,QAAQ,EAAE,OAAO,EAAE,OAAO,EAAE,6BAA6B,EAAE,CAAC,CAAC;YACvG,CAAC;iBAAM,IAAI,GAAG,KAAK,KAAK,IAAI,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,CAAE,KAAK,CAAC,GAAG,CAAe,CAAC,MAAM,CAAC,EAAE,CAAC;gBAC9F,MAAM,CAAC,IAAI,CAAC;oBACV,IAAI,EAAE,GAAG,SAAS,IAAI,GAAG,EAAE;oBAC3B,QAAQ,EAAE,OAAO;oBACjB,OAAO,EAAE,WAAW,GAAG,+BAA+B,GAAG,KAAK,WAAW,CAAC,CAAC,CAAC,0EAA0E,CAAC,CAAC,CAAC,EAAE,GAAG;iBAC/J,CAAC,CAAC;YACL,CAAC;QACH,CAAC,CAAC,CAAC;QACH,OAAO,MAAM,CAAC;IAChB,CAAC;CACF,CAAC,CAAC"}

package/dist/core/state/rules/state-unique-name.js

@@ -0,0 +1,40 @@
+import { eachListItem } from './helpers.js';
+import { defineRule } from './rule.js';
+/** Lists whose `Name` is an identifier (referenced elsewhere, or the key the UI selects by) */
+const NAMED_LISTS = new Set(['Layout.Layouts', 'NamedQuery.NamedQueries', 'Export.Reports', 'Dashboard.Tabs', 'Theme.UserThemes']);
+/** Lists whose `ColumnId` defines a column */
+const COLUMN_LISTS = new Set(['CalculatedColumn.CalculatedColumns', 'FreeTextColumn.FreeTextColumns']);
+/** Identifying names are unique within their list: Layouts, Named Queries, Reports, Dashboard Tabs, Themes; Calculated / FreeText Column ids */
+export default defineRule({
+    id: 'state/unique-name',
+    docs: 'dev-guide-adaptable-state-initial-state',
+    check({ state }) {
+        const issues = [];
+        const seen = new Map();
+        eachListItem(state, (section, list, item, path, index) => {
+            const id = `${section}.${list}`;
+            const key = COLUMN_LISTS.has(id) ? 'ColumnId' : NAMED_LISTS.has(id) ? 'Name' : undefined;
+            if (!key) {
+                return;
+            }
+            const value = item[key];
+            if (typeof value !== 'string' || !value) {
+                return;
+            }
+            const seenKey = `${id}:${value}`;
+            const first = seen.get(seenKey);
+            if (first !== undefined) {
+                issues.push({
+                    path: `${path}.${key}`,
+                    severity: 'error',
+                    message: `Duplicate ${key} "${value}" (also ${section}.${list}[${first}]); ${key}s must be unique within ${list}.`,
+                });
+            }
+            else {
+                seen.set(seenKey, index);
+            }
+        });
+        return issues;
+    },
+});
+//# sourceMappingURL=state-unique-name.js.map

package/dist/core/state/rules/state-unique-name.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"state-unique-name.js","sourceRoot":"","sources":["../../../../src/core/state/rules/state-unique-name.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,cAAc,CAAC;AAC5C,OAAO,EAAE,UAAU,EAAkB,MAAM,WAAW,CAAC;AAEvD,+FAA+F;AAC/F,MAAM,WAAW,GAAG,IAAI,GAAG,CAAC,CAAC,gBAAgB,EAAE,yBAAyB,EAAE,gBAAgB,EAAE,gBAAgB,EAAE,kBAAkB,CAAC,CAAC,CAAC;AACnI,8CAA8C;AAC9C,MAAM,YAAY,GAAG,IAAI,GAAG,CAAC,CAAC,oCAAoC,EAAE,gCAAgC,CAAC,CAAC,CAAC;AAEvG,gJAAgJ;AAChJ,eAAe,UAAU,CAAC;IACxB,EAAE,EAAE,mBAAmB;IACvB,IAAI,EAAE,yCAAyC;IAC/C,KAAK,CAAC,EAAE,KAAK,EAAE;QACb,MAAM,MAAM,GAAgB,EAAE,CAAC;QAC/B,MAAM,IAAI,GAAG,IAAI,GAAG,EAAkB,CAAC;QACvC,YAAY,CAAC,KAAK,EAAE,CAAC,OAAO,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,KAAK,EAAE,EAAE;YACvD,MAAM,EAAE,GAAG,GAAG,OAAO,IAAI,IAAI,EAAE,CAAC;YAChC,MAAM,GAAG,GAAG,YAAY,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,WAAW,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,SAAS,CAAC;YACzF,IAAI,CAAC,GAAG,EAAE,CAAC;gBACT,OAAO;YACT,CAAC;YACD,MAAM,KAAK,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC;YACxB,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,CAAC,KAAK,EAAE,CAAC;gBACxC,OAAO;YACT,CAAC;YACD,MAAM,OAAO,GAAG,GAAG,EAAE,IAAI,KAAK,EAAE,CAAC;YACjC,MAAM,KAAK,GAAG,IAAI,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;YAChC,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;gBACxB,MAAM,CAAC,IAAI,CAAC;oBACV,IAAI,EAAE,GAAG,IAAI,IAAI,GAAG,EAAE;oBACtB,QAAQ,EAAE,OAAO;oBACjB,OAAO,EAAE,aAAa,GAAG,KAAK,KAAK,WAAW,OAAO,IAAI,IAAI,IAAI,KAAK,OAAO,GAAG,2BAA2B,IAAI,GAAG;iBACnH,CAAC,CAAC;YACL,CAAC;iBAAM,CAAC;gBACN,IAAI,CAAC,GAAG,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC;YAC3B,CAAC;QACH,CAAC,CAAC,CAAC;QACH,OAAO,MAAM,CAAC;IAChB,CAAC;CACF,CAAC,CAAC"}

package/dist/core/state/rules/state-unknown-section.js

@@ -0,0 +1,30 @@
+import { defineRule } from './rule.js';
+/**
+ * Root keys that are not State sections of the checked major; `PredefinedConfig` is the
+ * common pre-24 mistake. A persisted State is judged against `AdaptablePersistentState`,
+ * which has sections the runtime alone writes (`TeamSharing`).
+ */
+export default defineRule({
+    id: 'state/unknown-section',
+    docs: 'dev-guide-adaptable-state-initial-state',
+    check({ state, kind, names }) {
+        const known = new Set(kind === 'persistent' ? names.persistentStateKeys : names.initialStateKeys);
+        return Object.keys(state)
+            .filter((key) => !known.has(key))
+            .map((key) => key === 'PredefinedConfig'
+            ? {
+                path: key,
+                severity: 'error',
+                at: 'key',
+                message: '`PredefinedConfig` is not part of Adaptable State: put its contents directly in `initialState`.',
+                fix: 'Move the sections inside `PredefinedConfig` up one level and remove the wrapper.',
+            }
+            : {
+                path: key,
+                severity: 'warning',
+                at: 'key',
+                message: `\`${key}\` is not ${kind === 'persistent' ? 'a persisted' : 'an Initial'} State section; AdapTable ignores it. It may be an Adaptable Option.`,
+            });
+    },
+});
+//# sourceMappingURL=state-unknown-section.js.map

package/dist/core/state/rules/state-unknown-section.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"state-unknown-section.js","sourceRoot":"","sources":["../../../../src/core/state/rules/state-unknown-section.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,WAAW,CAAC;AAEvC;;;;GAIG;AACH,eAAe,UAAU,CAAC;IACxB,EAAE,EAAE,uBAAuB;IAC3B,IAAI,EAAE,yCAAyC;IAC/C,KAAK,CAAC,EAAE,KAAK,EAAE,IAAI,EAAE,KAAK,EAAE;QAC1B,MAAM,KAAK,GAAG,IAAI,GAAG,CAAC,IAAI,KAAK,YAAY,CAAC,CAAC,CAAC,KAAK,CAAC,mBAAmB,CAAC,CAAC,CAAC,KAAK,CAAC,gBAAgB,CAAC,CAAC;QAClG,OAAO,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC;aACtB,MAAM,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;aAChC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CACX,GAAG,KAAK,kBAAkB;YACxB,CAAC,CAAC;gBACE,IAAI,EAAE,GAAG;gBACT,QAAQ,EAAE,OAAgB;gBAC1B,EAAE,EAAE,KAAc;gBAClB,OAAO,EAAE,iGAAiG;gBAC1G,GAAG,EAAE,kFAAkF;aACxF;YACH,CAAC,CAAC;gBACE,IAAI,EAAE,GAAG;gBACT,QAAQ,EAAE,SAAkB;gBAC5B,EAAE,EAAE,KAAc;gBAClB,OAAO,EAAE,KAAK,GAAG,aAAa,IAAI,KAAK,YAAY,CAAC,CAAC,CAAC,aAAa,CAAC,CAAC,CAAC,YAAY,sEAAsE;aACzJ,CACN,CAAC;IACN,CAAC;CACF,CAAC,CAAC"}