Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 24 additions & 0 deletions .changeset/nav-viewname-resolution.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
---
'@objectstack/lint': minor
---

Resolve an app navigation entry's `viewName` against its object's list views at `validate` and `build`

`AppNavigationItemSchema.viewName` is documented as *"Default list view to open"*, so an
unresolvable name never failed — it **fell back**. A nav entry keeping its authored label and
icon would open a different view, and nothing said so: `os validate --json` reported
`valid: true` and `os build` was green. The decay mode was worse than the typo mode — renaming
a list view silently degraded every nav entry pointing at it, with every gate green and the
diff reading correctly in review.

`lintViewRefs` now walks `app.navigation` (and the `areas[]` container) recursively and reports
`view-ref-nav-view-missing` as an **error** when a `viewName` resolves to no list view on the
object it names. This extends #2554's existing rule to the second, more travelled door into the
same `listViews` namespace rather than adding a new rule class.

Resolution mirrors the runtime matcher (objectui's `resolveViewId`) in all three directions —
exact id, short name retried as `<object>.<name>`, and qualified name with the prefix stripped —
so a name that works at runtime is never reported. The accept set narrows only where the stack
itself declares the object's list views: an entry is skipped when the `viewName` is interpolated,
when `recordId` is set (the schema documents `viewName` as ignored there), when the item carries
`requiresObject`, or when this stack contributed no list view for that object.
1 change: 1 addition & 0 deletions packages/lint/src/index.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -755,6 +755,7 @@ export {
VIEW_KEY_COLLISION,
VIEW_REF_FORM_TARGET_MISSING,
VIEW_REF_FORM_TARGET_KIND,
VIEW_REF_NAV_VIEW_MISSING,
} from './lint-view-refs.js';

export {
Expand Down
232 changes: 232 additions & 0 deletions packages/lint/src/lint-view-refs.test.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -6,7 +6,9 @@ import {
VIEW_KEY_COLLISION,
VIEW_REF_FORM_TARGET_MISSING,
VIEW_REF_FORM_TARGET_KIND,
VIEW_REF_NAV_VIEW_MISSING,
} from './lint-view-refs.js';
import { runAuthoringRules, splitBySeverity } from './authoring-rules.js';

const listView = (object: string) => ({
type: 'grid',
Expand DownExpand Up@@ -174,3 +176,233 @@ describe('lintViewRefs — form action target resolution', () => {
expect(out[0].where).toContain("object 'task'"); // object-nested context retained
});
});

// ─────────────────────────────────────────────────────────────────────────────
// #14108 — app navigation `viewName`, the SECOND door into the same `listViews`
// namespace the #2554 rules above guard.
// ─────────────────────────────────────────────────────────────────────────────

/** Distinct configs so the expander does not dedupe the default `list` into a
* structurally identical `listViews` entry — the fixture needs BOTH so the
* default's real key is observable. */
const navListView = (object: string, label: string, column: string) => ({
type: 'grid',
label,
columns: [column],
data: { provider: 'object', object },
});

const NAV_OBJECT = {
name: 'duly_task',
list: navListView('duly_task', 'All tasks', 'title'),
listViews: {
schedule: navListView('duly_task', 'Schedule', 'due_at'),
board: navListView('duly_task', 'Board', 'status'),
},
formViews: { edit: formView('duly_task') },
};

const navStack = (nav: Record<string, unknown>, appExtra: Record<string, unknown> = {}) => ({
objects: [NAV_OBJECT],
apps: [{ name: 'duly', label: 'Duly', navigation: [nav], ...appExtra }],
});

const navFindings = (stack: Record<string, unknown>) =>
lintViewRefs(stack).filter((f) => f.rule === VIEW_REF_NAV_VIEW_MISSING);

describe('lintViewRefs — navigation viewName resolution (#14108)', () => {
it('errors when a nav viewName names no list view on its object (the measured repro)', () => {
const out = navFindings(
navStack({ id: 'nav_schedule', type: 'object', objectName: 'duly_task', viewName: 'A4_no_such_view', label: 'Schedule' }),
);
expect(out).toHaveLength(1);
expect(out[0].severity).toBe('error');
expect(out[0].where).toBe("app 'duly' · nav 'nav_schedule'");
// The available list views are listed the way the platform's other
// unknown-name findings list theirs — short (authorable) keys, not
// expanded `<object>.<key>` ids.
expect(out[0].message).toContain('board, default, schedule');
expect(out[0].message).not.toContain('duly_task.schedule');
});

it('suggests the near-miss name a rename left behind', () => {
const out = navFindings(
navStack({ id: 'n', type: 'object', objectName: 'duly_task', viewName: 'schedul', label: 'Schedule' }),
);
expect(out[0].hint).toContain('Did you mean "schedule"?');
});

it('accepts a viewName that names a declared listViews key', () => {
expect(navFindings(navStack({ id: 'n', type: 'object', objectName: 'duly_task', viewName: 'schedule', label: 'S' }))).toEqual([]);
});

it("accepts the default `list`'s real expansion key — which is `default`, not `all`", () => {
// The schema documents viewName as 'Defaults to "all"'. That describes the
// CONVENTION of declaring a `listViews.all`, not a magic fallback name:
// `expandViewContainer` keys a bare default `list` as `<object>.default`,
// and objectui's `resolveViewId` has no special case for 'all' either.
expect(navFindings(navStack({ id: 'n', type: 'object', objectName: 'duly_task', viewName: 'default', label: 'D' }))).toEqual([]);
const undeclaredAll = navFindings(
navStack({ id: 'n', type: 'object', objectName: 'duly_task', viewName: 'all', label: 'A' }),
);
expect(undeclaredAll).toHaveLength(1);
});

it("accepts 'all' once the object actually declares it (the app-crm convention)", () => {
const stack = {
objects: [{ ...NAV_OBJECT, listViews: { ...NAV_OBJECT.listViews, all: navListView('duly_task', 'All', 'title') } }],
apps: [{ name: 'duly', navigation: [{ id: 'n', type: 'object', objectName: 'duly_task', viewName: 'all', label: 'A' }] }],
};
expect(navFindings(stack)).toEqual([]);
});

it('accepts a FULLY QUALIFIED viewName, exactly as the runtime matcher does', () => {
// objectui's `resolveViewId` accepts `<object>.<key>` as well as the short
// key. A lint stricter than the matcher would red a name that works.
expect(
navFindings(navStack({ id: 'n', type: 'object', objectName: 'duly_task', viewName: 'duly_task.schedule', label: 'S' })),
).toEqual([]);
});

it('resolves against an independent (already-expanded) top-level ViewItem', () => {
const stack = {
objects: [{ name: 'duly_task' }],
views: [{ name: 'duly_task.mine', object: 'duly_task', viewKind: 'list', ...navListView('duly_task', 'Mine', 'title') }],
apps: [{ name: 'duly', navigation: [{ id: 'n', type: 'object', objectName: 'duly_task', viewName: 'mine', label: 'M' }] }],
};
expect(navFindings(stack)).toEqual([]);
});

it('names the form-view case explicitly rather than reporting a bare miss', () => {
const out = navFindings(navStack({ id: 'n', type: 'object', objectName: 'duly_task', viewName: 'edit', label: 'E' }));
expect(out).toHaveLength(1);
expect(out[0].message).toContain('resolves to a FORM view');
expect(out[0].hint).toContain("type:'form' action target");
});

it('recurses into `group` children AND into an `object` item’s own children', () => {
const stack = {
objects: [NAV_OBJECT],
apps: [{
name: 'duly',
navigation: [{
id: 'grp', type: 'group', label: 'Work',
children: [{
id: 'parent', type: 'object', objectName: 'duly_task', viewName: 'schedule', label: 'Tasks',
children: [{ id: 'deep', type: 'object', objectName: 'duly_task', viewName: 'A4_no_such_view', label: 'Deep' }],
}],
}],
}],
};
const out = navFindings(stack);
expect(out).toHaveLength(1);
expect(out[0].where).toContain("nav 'deep'");
});

it('walks the `areas[]` nav container too, not only `navigation`', () => {
const bad = { id: 'in_area', type: 'object', objectName: 'duly_task', viewName: 'A4_no_such_view', label: 'X' };
for (const area of [{ name: 'a', items: [bad] }, { name: 'a', navigation: [bad] }]) {
const out = navFindings({ objects: [NAV_OBJECT], apps: [{ name: 'duly', areas: [area] }] });
expect(out).toHaveLength(1);
expect(out[0].where).toContain("nav 'in_area'");
}
});

it('reports each distinct nav entry once', () => {
const stack = {
objects: [NAV_OBJECT],
apps: [{
name: 'duly',
navigation: [
{ id: 'a', type: 'object', objectName: 'duly_task', viewName: 'A4_no_such_view', label: 'A' },
{ id: 'b', type: 'object', objectName: 'duly_task', viewName: 'A4_no_such_view', label: 'B' },
],
}],
};
expect(navFindings(stack).map((f) => f.where)).toEqual([
"app 'duly' · nav 'a'",
"app 'duly' · nav 'b'",
]);
});
});

describe('lintViewRefs — navigation viewName exemptions (false positives stay near zero)', () => {
const bogus = 'A4_no_such_view';

it('skips an interpolated viewName (resolved at render time)', () => {
expect(navFindings(navStack({ id: 'n', type: 'object', objectName: 'duly_task', viewName: '${params.view}', label: 'X' }))).toEqual([]);
});

it('skips an entry carrying `requiresObject` — another package provides the object', () => {
expect(
navFindings(navStack({ id: 'n', type: 'object', objectName: 'duly_task', viewName: bogus, requiresObject: 'duly_task', label: 'X' })),
).toEqual([]);
});

it('skips when `recordId` is set — the schema documents viewName as ignored there', () => {
expect(
navFindings(navStack({ id: 'n', type: 'object', objectName: 'duly_task', viewName: bogus, recordId: '{current_user_id}', label: 'X' })),
).toEqual([]);
});

it('says nothing about an object this stack declares no list views for', () => {
// Indistinguishable from a cross-package object, so the rule stays silent
// rather than guessing — the precondition that lets it be an ERROR at all.
const stack = {
objects: [{ name: 'other_object' }],
apps: [{ name: 'duly', navigation: [{ id: 'n', type: 'object', objectName: 'not_here', viewName: bogus, label: 'X' }] }],
};
expect(navFindings(stack)).toEqual([]);
});

it('says nothing when the nav entry names no view at all', () => {
expect(navFindings(navStack({ id: 'n', type: 'object', objectName: 'duly_task', label: 'X' }))).toEqual([]);
});

it('leaves the repo’s own shipped nav shapes alone (no error on a resolvable stack)', () => {
const stack = {
objects: [NAV_OBJECT],
apps: [{
name: 'duly',
navigation: [
{ id: 'a', type: 'object', objectName: 'duly_task', viewName: 'schedule', label: 'S', icon: 'calendar' },
{ id: 'b', type: 'object', objectName: 'duly_task', label: 'Default landing' },
{ id: 'c', type: 'page', pageName: 'pricing', label: 'Pricing' },
{ id: 'd', type: 'url', url: 'https://example.com', label: 'Docs' },
],
}],
};
expect(navFindings(stack)).toEqual([]);
});
});

/**
* The card's binding acceptance criterion, pinned end-to-end rather than
* inferred from the registry entry (the #14148 / #14107 precedent): the
* measured repro must fail `validate` AND `build`. The card measured
* `os validate --json` returning `valid: true` and `os build` green, so a
* validate-only fix was not acceptable — and nothing else in this file would
* notice if the suite entry's `commands` were narrowed later.
*/
describe('#14108 acceptance — a nav viewName miss gates `validate` AND `build`', () => {
const repro = navStack({
id: 'nav_schedule', type: 'object', objectName: 'duly_task',
viewName: 'A4_no_such_view', label: 'Schedule', icon: 'gantt-chart',
});
const clean = navStack({
id: 'nav_schedule', type: 'object', objectName: 'duly_task',
viewName: 'schedule', label: 'Schedule', icon: 'gantt-chart',
});

for (const command of ['validate', 'build'] as const) {
it(`the measured repro fails \`${command}\``, () => {
const { errors } = splitBySeverity(runAuthoringRules(command, { normalized: repro as never }));
expect(errors.map((f) => f.rule)).toContain(VIEW_REF_NAV_VIEW_MISSING);
});

it(`the corrected nav entry passes \`${command}\``, () => {
const { errors, advisories } = splitBySeverity(runAuthoringRules(command, { normalized: clean as never }));
expect([...errors, ...advisories].filter((f) => f.rule === VIEW_REF_NAV_VIEW_MISSING)).toEqual([]);
});
}
});
Loading
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 24 additions & 0 deletions .changeset/nav-viewname-resolution.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
---
'@objectstack/lint': minor
---

Resolve an app navigation entry's `viewName` against its object's list views at `validate` and `build`

`AppNavigationItemSchema.viewName` is documented as *"Default list view to open"*, so an
unresolvable name never failed — it **fell back**. A nav entry keeping its authored label and
icon would open a different view, and nothing said so: `os validate --json` reported
`valid: true` and `os build` was green. The decay mode was worse than the typo mode — renaming
a list view silently degraded every nav entry pointing at it, with every gate green and the
diff reading correctly in review.

`lintViewRefs` now walks `app.navigation` (and the `areas[]` container) recursively and reports
`view-ref-nav-view-missing` as an **error** when a `viewName` resolves to no list view on the
object it names. This extends #2554's existing rule to the second, more travelled door into the
same `listViews` namespace rather than adding a new rule class.

Resolution mirrors the runtime matcher (objectui's `resolveViewId`) in all three directions —
exact id, short name retried as `<object>.<name>`, and qualified name with the prefix stripped —
so a name that works at runtime is never reported. The accept set narrows only where the stack
itself declares the object's list views: an entry is skipped when the `viewName` is interpolated,
when `recordId` is set (the schema documents `viewName` as ignored there), when the item carries
`requiresObject`, or when this stack contributed no list view for that object.
1 change: 1 addition & 0 deletions packages/lint/src/index.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -755,6 +755,7 @@ export {
VIEW_KEY_COLLISION,
VIEW_REF_FORM_TARGET_MISSING,
VIEW_REF_FORM_TARGET_KIND,
VIEW_REF_NAV_VIEW_MISSING,
} from './lint-view-refs.js';

export {
Expand Down
232 changes: 232 additions & 0 deletions packages/lint/src/lint-view-refs.test.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -6,7 +6,9 @@ import {
VIEW_KEY_COLLISION,
VIEW_REF_FORM_TARGET_MISSING,
VIEW_REF_FORM_TARGET_KIND,
VIEW_REF_NAV_VIEW_MISSING,
} from './lint-view-refs.js';
import { runAuthoringRules, splitBySeverity } from './authoring-rules.js';

const listView = (object: string) => ({
type: 'grid',
Expand DownExpand Up@@ -174,3 +176,233 @@ describe('lintViewRefs — form action target resolution', () => {
expect(out[0].where).toContain("object 'task'"); // object-nested context retained
});
});

// ─────────────────────────────────────────────────────────────────────────────
// #14108 — app navigation `viewName`, the SECOND door into the same `listViews`
// namespace the #2554 rules above guard.
// ─────────────────────────────────────────────────────────────────────────────

/** Distinct configs so the expander does not dedupe the default `list` into a
* structurally identical `listViews` entry — the fixture needs BOTH so the
* default's real key is observable. */
const navListView = (object: string, label: string, column: string) => ({
type: 'grid',
label,
columns: [column],
data: { provider: 'object', object },
});

const NAV_OBJECT = {
name: 'duly_task',
list: navListView('duly_task', 'All tasks', 'title'),
listViews: {
schedule: navListView('duly_task', 'Schedule', 'due_at'),
board: navListView('duly_task', 'Board', 'status'),
},
formViews: { edit: formView('duly_task') },
};

const navStack = (nav: Record<string, unknown>, appExtra: Record<string, unknown> = {}) => ({
objects: [NAV_OBJECT],
apps: [{ name: 'duly', label: 'Duly', navigation: [nav], ...appExtra }],
});

const navFindings = (stack: Record<string, unknown>) =>
lintViewRefs(stack).filter((f) => f.rule === VIEW_REF_NAV_VIEW_MISSING);

describe('lintViewRefs — navigation viewName resolution (#14108)', () => {
it('errors when a nav viewName names no list view on its object (the measured repro)', () => {
const out = navFindings(
navStack({ id: 'nav_schedule', type: 'object', objectName: 'duly_task', viewName: 'A4_no_such_view', label: 'Schedule' }),
);
expect(out).toHaveLength(1);
expect(out[0].severity).toBe('error');
expect(out[0].where).toBe("app 'duly' · nav 'nav_schedule'");
// The available list views are listed the way the platform's other
// unknown-name findings list theirs — short (authorable) keys, not
// expanded `<object>.<key>` ids.
expect(out[0].message).toContain('board, default, schedule');
expect(out[0].message).not.toContain('duly_task.schedule');
});

it('suggests the near-miss name a rename left behind', () => {
const out = navFindings(
navStack({ id: 'n', type: 'object', objectName: 'duly_task', viewName: 'schedul', label: 'Schedule' }),
);
expect(out[0].hint).toContain('Did you mean "schedule"?');
});

it('accepts a viewName that names a declared listViews key', () => {
expect(navFindings(navStack({ id: 'n', type: 'object', objectName: 'duly_task', viewName: 'schedule', label: 'S' }))).toEqual([]);
});

it("accepts the default `list`'s real expansion key — which is `default`, not `all`", () => {
// The schema documents viewName as 'Defaults to "all"'. That describes the
// CONVENTION of declaring a `listViews.all`, not a magic fallback name:
// `expandViewContainer` keys a bare default `list` as `<object>.default`,
// and objectui's `resolveViewId` has no special case for 'all' either.
expect(navFindings(navStack({ id: 'n', type: 'object', objectName: 'duly_task', viewName: 'default', label: 'D' }))).toEqual([]);
const undeclaredAll = navFindings(
navStack({ id: 'n', type: 'object', objectName: 'duly_task', viewName: 'all', label: 'A' }),
);
expect(undeclaredAll).toHaveLength(1);
});

it("accepts 'all' once the object actually declares it (the app-crm convention)", () => {
const stack = {
objects: [{ ...NAV_OBJECT, listViews: { ...NAV_OBJECT.listViews, all: navListView('duly_task', 'All', 'title') } }],
apps: [{ name: 'duly', navigation: [{ id: 'n', type: 'object', objectName: 'duly_task', viewName: 'all', label: 'A' }] }],
};
expect(navFindings(stack)).toEqual([]);
});

it('accepts a FULLY QUALIFIED viewName, exactly as the runtime matcher does', () => {
// objectui's `resolveViewId` accepts `<object>.<key>` as well as the short
// key. A lint stricter than the matcher would red a name that works.
expect(
navFindings(navStack({ id: 'n', type: 'object', objectName: 'duly_task', viewName: 'duly_task.schedule', label: 'S' })),
).toEqual([]);
});

it('resolves against an independent (already-expanded) top-level ViewItem', () => {
const stack = {
objects: [{ name: 'duly_task' }],
views: [{ name: 'duly_task.mine', object: 'duly_task', viewKind: 'list', ...navListView('duly_task', 'Mine', 'title') }],
apps: [{ name: 'duly', navigation: [{ id: 'n', type: 'object', objectName: 'duly_task', viewName: 'mine', label: 'M' }] }],
};
expect(navFindings(stack)).toEqual([]);
});

it('names the form-view case explicitly rather than reporting a bare miss', () => {
const out = navFindings(navStack({ id: 'n', type: 'object', objectName: 'duly_task', viewName: 'edit', label: 'E' }));
expect(out).toHaveLength(1);
expect(out[0].message).toContain('resolves to a FORM view');
expect(out[0].hint).toContain("type:'form' action target");
});

it('recurses into `group` children AND into an `object` item’s own children', () => {
const stack = {
objects: [NAV_OBJECT],
apps: [{
name: 'duly',
navigation: [{
id: 'grp', type: 'group', label: 'Work',
children: [{
id: 'parent', type: 'object', objectName: 'duly_task', viewName: 'schedule', label: 'Tasks',
children: [{ id: 'deep', type: 'object', objectName: 'duly_task', viewName: 'A4_no_such_view', label: 'Deep' }],
}],
}],
}],
};
const out = navFindings(stack);
expect(out).toHaveLength(1);
expect(out[0].where).toContain("nav 'deep'");
});

it('walks the `areas[]` nav container too, not only `navigation`', () => {
const bad = { id: 'in_area', type: 'object', objectName: 'duly_task', viewName: 'A4_no_such_view', label: 'X' };
for (const area of [{ name: 'a', items: [bad] }, { name: 'a', navigation: [bad] }]) {
const out = navFindings({ objects: [NAV_OBJECT], apps: [{ name: 'duly', areas: [area] }] });
expect(out).toHaveLength(1);
expect(out[0].where).toContain("nav 'in_area'");
}
});

it('reports each distinct nav entry once', () => {
const stack = {
objects: [NAV_OBJECT],
apps: [{
name: 'duly',
navigation: [
{ id: 'a', type: 'object', objectName: 'duly_task', viewName: 'A4_no_such_view', label: 'A' },
{ id: 'b', type: 'object', objectName: 'duly_task', viewName: 'A4_no_such_view', label: 'B' },
],
}],
};
expect(navFindings(stack).map((f) => f.where)).toEqual([
"app 'duly' · nav 'a'",
"app 'duly' · nav 'b'",
]);
});
});

describe('lintViewRefs — navigation viewName exemptions (false positives stay near zero)', () => {
const bogus = 'A4_no_such_view';

it('skips an interpolated viewName (resolved at render time)', () => {
expect(navFindings(navStack({ id: 'n', type: 'object', objectName: 'duly_task', viewName: '${params.view}', label: 'X' }))).toEqual([]);
});

it('skips an entry carrying `requiresObject` — another package provides the object', () => {
expect(
navFindings(navStack({ id: 'n', type: 'object', objectName: 'duly_task', viewName: bogus, requiresObject: 'duly_task', label: 'X' })),
).toEqual([]);
});

it('skips when `recordId` is set — the schema documents viewName as ignored there', () => {
expect(
navFindings(navStack({ id: 'n', type: 'object', objectName: 'duly_task', viewName: bogus, recordId: '{current_user_id}', label: 'X' })),
).toEqual([]);
});

it('says nothing about an object this stack declares no list views for', () => {
// Indistinguishable from a cross-package object, so the rule stays silent
// rather than guessing — the precondition that lets it be an ERROR at all.
const stack = {
objects: [{ name: 'other_object' }],
apps: [{ name: 'duly', navigation: [{ id: 'n', type: 'object', objectName: 'not_here', viewName: bogus, label: 'X' }] }],
};
expect(navFindings(stack)).toEqual([]);
});

it('says nothing when the nav entry names no view at all', () => {
expect(navFindings(navStack({ id: 'n', type: 'object', objectName: 'duly_task', label: 'X' }))).toEqual([]);
});

it('leaves the repo’s own shipped nav shapes alone (no error on a resolvable stack)', () => {
const stack = {
objects: [NAV_OBJECT],
apps: [{
name: 'duly',
navigation: [
{ id: 'a', type: 'object', objectName: 'duly_task', viewName: 'schedule', label: 'S', icon: 'calendar' },
{ id: 'b', type: 'object', objectName: 'duly_task', label: 'Default landing' },
{ id: 'c', type: 'page', pageName: 'pricing', label: 'Pricing' },
{ id: 'd', type: 'url', url: 'https://example.com', label: 'Docs' },
],
}],
};
expect(navFindings(stack)).toEqual([]);
});
});

/**
* The card's binding acceptance criterion, pinned end-to-end rather than
* inferred from the registry entry (the #14148 / #14107 precedent): the
* measured repro must fail `validate` AND `build`. The card measured
* `os validate --json` returning `valid: true` and `os build` green, so a
* validate-only fix was not acceptable — and nothing else in this file would
* notice if the suite entry's `commands` were narrowed later.
*/
describe('#14108 acceptance — a nav viewName miss gates `validate` AND `build`', () => {
const repro = navStack({
id: 'nav_schedule', type: 'object', objectName: 'duly_task',
viewName: 'A4_no_such_view', label: 'Schedule', icon: 'gantt-chart',
});
const clean = navStack({
id: 'nav_schedule', type: 'object', objectName: 'duly_task',
viewName: 'schedule', label: 'Schedule', icon: 'gantt-chart',
});

for (const command of ['validate', 'build'] as const) {
it(`the measured repro fails \`${command}\``, () => {
const { errors } = splitBySeverity(runAuthoringRules(command, { normalized: repro as never }));
expect(errors.map((f) => f.rule)).toContain(VIEW_REF_NAV_VIEW_MISSING);
});

it(`the corrected nav entry passes \`${command}\``, () => {
const { errors, advisories } = splitBySeverity(runAuthoringRules(command, { normalized: clean as never }));
expect([...errors, ...advisories].filter((f) => f.rule === VIEW_REF_NAV_VIEW_MISSING)).toEqual([]);
});
}
});
Loading
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix"); } } catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 24 additions & 0 deletions .changeset/nav-viewname-resolution.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
---
'@objectstack/lint': minor
---

Resolve an app navigation entry's `viewName` against its object's list views at `validate` and `build`

`AppNavigationItemSchema.viewName` is documented as *"Default list view to open"*, so an
unresolvable name never failed — it **fell back**. A nav entry keeping its authored label and
icon would open a different view, and nothing said so: `os validate --json` reported
`valid: true` and `os build` was green. The decay mode was worse than the typo mode — renaming
a list view silently degraded every nav entry pointing at it, with every gate green and the
diff reading correctly in review.

`lintViewRefs` now walks `app.navigation` (and the `areas[]` container) recursively and reports
`view-ref-nav-view-missing` as an **error** when a `viewName` resolves to no list view on the
object it names. This extends #2554's existing rule to the second, more travelled door into the
same `listViews` namespace rather than adding a new rule class.

Resolution mirrors the runtime matcher (objectui's `resolveViewId`) in all three directions —
exact id, short name retried as `<object>.<name>`, and qualified name with the prefix stripped —
so a name that works at runtime is never reported. The accept set narrows only where the stack
itself declares the object's list views: an entry is skipped when the `viewName` is interpolated,
when `recordId` is set (the schema documents `viewName` as ignored there), when the item carries
`requiresObject`, or when this stack contributed no list view for that object.
1 change: 1 addition & 0 deletions packages/lint/src/index.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -755,6 +755,7 @@ export {
VIEW_KEY_COLLISION,
VIEW_REF_FORM_TARGET_MISSING,
VIEW_REF_FORM_TARGET_KIND,
VIEW_REF_NAV_VIEW_MISSING,
} from './lint-view-refs.js';

export {
Expand Down
232 changes: 232 additions & 0 deletions packages/lint/src/lint-view-refs.test.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -6,7 +6,9 @@ import {
VIEW_KEY_COLLISION,
VIEW_REF_FORM_TARGET_MISSING,
VIEW_REF_FORM_TARGET_KIND,
VIEW_REF_NAV_VIEW_MISSING,
} from './lint-view-refs.js';
import { runAuthoringRules, splitBySeverity } from './authoring-rules.js';

const listView = (object: string) => ({
type: 'grid',
Expand DownExpand Up@@ -174,3 +176,233 @@ describe('lintViewRefs — form action target resolution', () => {
expect(out[0].where).toContain("object 'task'"); // object-nested context retained
});
});

// ─────────────────────────────────────────────────────────────────────────────
// #14108 — app navigation `viewName`, the SECOND door into the same `listViews`
// namespace the #2554 rules above guard.
// ─────────────────────────────────────────────────────────────────────────────

/** Distinct configs so the expander does not dedupe the default `list` into a
* structurally identical `listViews` entry — the fixture needs BOTH so the
* default's real key is observable. */
const navListView = (object: string, label: string, column: string) => ({
type: 'grid',
label,
columns: [column],
data: { provider: 'object', object },
});

const NAV_OBJECT = {
name: 'duly_task',
list: navListView('duly_task', 'All tasks', 'title'),
listViews: {
schedule: navListView('duly_task', 'Schedule', 'due_at'),
board: navListView('duly_task', 'Board', 'status'),
},
formViews: { edit: formView('duly_task') },
};

const navStack = (nav: Record<string, unknown>, appExtra: Record<string, unknown> = {}) => ({
objects: [NAV_OBJECT],
apps: [{ name: 'duly', label: 'Duly', navigation: [nav], ...appExtra }],
});

const navFindings = (stack: Record<string, unknown>) =>
lintViewRefs(stack).filter((f) => f.rule === VIEW_REF_NAV_VIEW_MISSING);

describe('lintViewRefs — navigation viewName resolution (#14108)', () => {
it('errors when a nav viewName names no list view on its object (the measured repro)', () => {
const out = navFindings(
navStack({ id: 'nav_schedule', type: 'object', objectName: 'duly_task', viewName: 'A4_no_such_view', label: 'Schedule' }),
);
expect(out).toHaveLength(1);
expect(out[0].severity).toBe('error');
expect(out[0].where).toBe("app 'duly' · nav 'nav_schedule'");
// The available list views are listed the way the platform's other
// unknown-name findings list theirs — short (authorable) keys, not
// expanded `<object>.<key>` ids.
expect(out[0].message).toContain('board, default, schedule');
expect(out[0].message).not.toContain('duly_task.schedule');
});

it('suggests the near-miss name a rename left behind', () => {
const out = navFindings(
navStack({ id: 'n', type: 'object', objectName: 'duly_task', viewName: 'schedul', label: 'Schedule' }),
);
expect(out[0].hint).toContain('Did you mean "schedule"?');
});

it('accepts a viewName that names a declared listViews key', () => {
expect(navFindings(navStack({ id: 'n', type: 'object', objectName: 'duly_task', viewName: 'schedule', label: 'S' }))).toEqual([]);
});

it("accepts the default `list`'s real expansion key — which is `default`, not `all`", () => {
// The schema documents viewName as 'Defaults to "all"'. That describes the
// CONVENTION of declaring a `listViews.all`, not a magic fallback name:
// `expandViewContainer` keys a bare default `list` as `<object>.default`,
// and objectui's `resolveViewId` has no special case for 'all' either.
expect(navFindings(navStack({ id: 'n', type: 'object', objectName: 'duly_task', viewName: 'default', label: 'D' }))).toEqual([]);
const undeclaredAll = navFindings(
navStack({ id: 'n', type: 'object', objectName: 'duly_task', viewName: 'all', label: 'A' }),
);
expect(undeclaredAll).toHaveLength(1);
});

it("accepts 'all' once the object actually declares it (the app-crm convention)", () => {
const stack = {
objects: [{ ...NAV_OBJECT, listViews: { ...NAV_OBJECT.listViews, all: navListView('duly_task', 'All', 'title') } }],
apps: [{ name: 'duly', navigation: [{ id: 'n', type: 'object', objectName: 'duly_task', viewName: 'all', label: 'A' }] }],
};
expect(navFindings(stack)).toEqual([]);
});

it('accepts a FULLY QUALIFIED viewName, exactly as the runtime matcher does', () => {
// objectui's `resolveViewId` accepts `<object>.<key>` as well as the short
// key. A lint stricter than the matcher would red a name that works.
expect(
navFindings(navStack({ id: 'n', type: 'object', objectName: 'duly_task', viewName: 'duly_task.schedule', label: 'S' })),
).toEqual([]);
});

it('resolves against an independent (already-expanded) top-level ViewItem', () => {
const stack = {
objects: [{ name: 'duly_task' }],
views: [{ name: 'duly_task.mine', object: 'duly_task', viewKind: 'list', ...navListView('duly_task', 'Mine', 'title') }],
apps: [{ name: 'duly', navigation: [{ id: 'n', type: 'object', objectName: 'duly_task', viewName: 'mine', label: 'M' }] }],
};
expect(navFindings(stack)).toEqual([]);
});

it('names the form-view case explicitly rather than reporting a bare miss', () => {
const out = navFindings(navStack({ id: 'n', type: 'object', objectName: 'duly_task', viewName: 'edit', label: 'E' }));
expect(out).toHaveLength(1);
expect(out[0].message).toContain('resolves to a FORM view');
expect(out[0].hint).toContain("type:'form' action target");
});

it('recurses into `group` children AND into an `object` item’s own children', () => {
const stack = {
objects: [NAV_OBJECT],
apps: [{
name: 'duly',
navigation: [{
id: 'grp', type: 'group', label: 'Work',
children: [{
id: 'parent', type: 'object', objectName: 'duly_task', viewName: 'schedule', label: 'Tasks',
children: [{ id: 'deep', type: 'object', objectName: 'duly_task', viewName: 'A4_no_such_view', label: 'Deep' }],
}],
}],
}],
};
const out = navFindings(stack);
expect(out).toHaveLength(1);
expect(out[0].where).toContain("nav 'deep'");
});

it('walks the `areas[]` nav container too, not only `navigation`', () => {
const bad = { id: 'in_area', type: 'object', objectName: 'duly_task', viewName: 'A4_no_such_view', label: 'X' };
for (const area of [{ name: 'a', items: [bad] }, { name: 'a', navigation: [bad] }]) {
const out = navFindings({ objects: [NAV_OBJECT], apps: [{ name: 'duly', areas: [area] }] });
expect(out).toHaveLength(1);
expect(out[0].where).toContain("nav 'in_area'");
}
});

it('reports each distinct nav entry once', () => {
const stack = {
objects: [NAV_OBJECT],
apps: [{
name: 'duly',
navigation: [
{ id: 'a', type: 'object', objectName: 'duly_task', viewName: 'A4_no_such_view', label: 'A' },
{ id: 'b', type: 'object', objectName: 'duly_task', viewName: 'A4_no_such_view', label: 'B' },
],
}],
};
expect(navFindings(stack).map((f) => f.where)).toEqual([
"app 'duly' · nav 'a'",
"app 'duly' · nav 'b'",
]);
});
});

describe('lintViewRefs — navigation viewName exemptions (false positives stay near zero)', () => {
const bogus = 'A4_no_such_view';

it('skips an interpolated viewName (resolved at render time)', () => {
expect(navFindings(navStack({ id: 'n', type: 'object', objectName: 'duly_task', viewName: '${params.view}', label: 'X' }))).toEqual([]);
});

it('skips an entry carrying `requiresObject` — another package provides the object', () => {
expect(
navFindings(navStack({ id: 'n', type: 'object', objectName: 'duly_task', viewName: bogus, requiresObject: 'duly_task', label: 'X' })),
).toEqual([]);
});

it('skips when `recordId` is set — the schema documents viewName as ignored there', () => {
expect(
navFindings(navStack({ id: 'n', type: 'object', objectName: 'duly_task', viewName: bogus, recordId: '{current_user_id}', label: 'X' })),
).toEqual([]);
});

it('says nothing about an object this stack declares no list views for', () => {
// Indistinguishable from a cross-package object, so the rule stays silent
// rather than guessing — the precondition that lets it be an ERROR at all.
const stack = {
objects: [{ name: 'other_object' }],
apps: [{ name: 'duly', navigation: [{ id: 'n', type: 'object', objectName: 'not_here', viewName: bogus, label: 'X' }] }],
};
expect(navFindings(stack)).toEqual([]);
});

it('says nothing when the nav entry names no view at all', () => {
expect(navFindings(navStack({ id: 'n', type: 'object', objectName: 'duly_task', label: 'X' }))).toEqual([]);
});

it('leaves the repo’s own shipped nav shapes alone (no error on a resolvable stack)', () => {
const stack = {
objects: [NAV_OBJECT],
apps: [{
name: 'duly',
navigation: [
{ id: 'a', type: 'object', objectName: 'duly_task', viewName: 'schedule', label: 'S', icon: 'calendar' },
{ id: 'b', type: 'object', objectName: 'duly_task', label: 'Default landing' },
{ id: 'c', type: 'page', pageName: 'pricing', label: 'Pricing' },
{ id: 'd', type: 'url', url: 'https://example.com', label: 'Docs' },
],
}],
};
expect(navFindings(stack)).toEqual([]);
});
});

/**
* The card's binding acceptance criterion, pinned end-to-end rather than
* inferred from the registry entry (the #14148 / #14107 precedent): the
* measured repro must fail `validate` AND `build`. The card measured
* `os validate --json` returning `valid: true` and `os build` green, so a
* validate-only fix was not acceptable — and nothing else in this file would
* notice if the suite entry's `commands` were narrowed later.
*/
describe('#14108 acceptance — a nav viewName miss gates `validate` AND `build`', () => {
const repro = navStack({
id: 'nav_schedule', type: 'object', objectName: 'duly_task',
viewName: 'A4_no_such_view', label: 'Schedule', icon: 'gantt-chart',
});
const clean = navStack({
id: 'nav_schedule', type: 'object', objectName: 'duly_task',
viewName: 'schedule', label: 'Schedule', icon: 'gantt-chart',
});

for (const command of ['validate', 'build'] as const) {
it(`the measured repro fails \`${command}\``, () => {
const { errors } = splitBySeverity(runAuthoringRules(command, { normalized: repro as never }));
expect(errors.map((f) => f.rule)).toContain(VIEW_REF_NAV_VIEW_MISSING);
});

it(`the corrected nav entry passes \`${command}\``, () => {
const { errors, advisories } = splitBySeverity(runAuthoringRules(command, { normalized: clean as never }));
expect([...errors, ...advisories].filter((f) => f.rule === VIEW_REF_NAV_VIEW_MISSING)).toEqual([]);
});
}
});
Loading
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Highlight search terms from Google/DuckDuckGo/Bing referrer\n(function() {\n var ref = document.referrer;\n var terms = [];\n \n if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {\n var url = new URL(ref);\n var q = url.searchParams.get('q') || url.searchParams.get('p');\n if (q) {\n terms = q.split(/\\s+/).filter(function(t) { return t.length > 2; });\n }\n }\n \n if (terms.length === 0) return;\n \n var style = document.createElement('style');\n style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';\n document.head.appendChild(style);\n \n function highlight(node) {\n if (node.nodeType === 3) { // text node\n var text = node.textContent;\n var found = false;\n terms.forEach(function(term) {\n var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\\]\\\\]/g, '\\\\') + ')', 'gi');\n if (regex.test(text)) {\n found = true;\n var frag = document.createDocumentFragment();\n var parts = text.split(regex);\n parts.forEach(function(part, i) {\n if (i % 2 === 0) {\n frag.appendChild(document.createTextNode(part));\n } else {\n var span = document.createElement('span');\n span.className = 'userscript-highlight';\n span.textContent = part;\n frag.appendChild(span);\n }\n });\n node.parentNode.replaceChild(frag, node);\n }\n });\n } else if (node.nodeType === 1 && node.childNodes) { // element\n var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];\n if (!skipTags.includes(node.tagName)) {\n Array.from(node.childNodes).forEach(highlight);\n }\n }\n }\n \n highlight(document.body);\n \n // Re-highlight on dynamic content\n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1 || node.nodeType === 3) highlight(node);\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Highlight Search Terms"); } } catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 24 additions & 0 deletions .changeset/nav-viewname-resolution.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
---
'@objectstack/lint': minor
---

Resolve an app navigation entry's `viewName` against its object's list views at `validate` and `build`

`AppNavigationItemSchema.viewName` is documented as *"Default list view to open"*, so an
unresolvable name never failed — it **fell back**. A nav entry keeping its authored label and
icon would open a different view, and nothing said so: `os validate --json` reported
`valid: true` and `os build` was green. The decay mode was worse than the typo mode — renaming
a list view silently degraded every nav entry pointing at it, with every gate green and the
diff reading correctly in review.

`lintViewRefs` now walks `app.navigation` (and the `areas[]` container) recursively and reports
`view-ref-nav-view-missing` as an **error** when a `viewName` resolves to no list view on the
object it names. This extends #2554's existing rule to the second, more travelled door into the
same `listViews` namespace rather than adding a new rule class.

Resolution mirrors the runtime matcher (objectui's `resolveViewId`) in all three directions —
exact id, short name retried as `<object>.<name>`, and qualified name with the prefix stripped —
so a name that works at runtime is never reported. The accept set narrows only where the stack
itself declares the object's list views: an entry is skipped when the `viewName` is interpolated,
when `recordId` is set (the schema documents `viewName` as ignored there), when the item carries
`requiresObject`, or when this stack contributed no list view for that object.
1 change: 1 addition & 0 deletions packages/lint/src/index.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -755,6 +755,7 @@ export {
VIEW_KEY_COLLISION,
VIEW_REF_FORM_TARGET_MISSING,
VIEW_REF_FORM_TARGET_KIND,
VIEW_REF_NAV_VIEW_MISSING,
} from './lint-view-refs.js';

export {
Expand Down
232 changes: 232 additions & 0 deletions packages/lint/src/lint-view-refs.test.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -6,7 +6,9 @@ import {
VIEW_KEY_COLLISION,
VIEW_REF_FORM_TARGET_MISSING,
VIEW_REF_FORM_TARGET_KIND,
VIEW_REF_NAV_VIEW_MISSING,
} from './lint-view-refs.js';
import { runAuthoringRules, splitBySeverity } from './authoring-rules.js';

const listView = (object: string) => ({
type: 'grid',
Expand DownExpand Up@@ -174,3 +176,233 @@ describe('lintViewRefs — form action target resolution', () => {
expect(out[0].where).toContain("object 'task'"); // object-nested context retained
});
});

// ─────────────────────────────────────────────────────────────────────────────
// #14108 — app navigation `viewName`, the SECOND door into the same `listViews`
// namespace the #2554 rules above guard.
// ─────────────────────────────────────────────────────────────────────────────

/** Distinct configs so the expander does not dedupe the default `list` into a
* structurally identical `listViews` entry — the fixture needs BOTH so the
* default's real key is observable. */
const navListView = (object: string, label: string, column: string) => ({
type: 'grid',
label,
columns: [column],
data: { provider: 'object', object },
});

const NAV_OBJECT = {
name: 'duly_task',
list: navListView('duly_task', 'All tasks', 'title'),
listViews: {
schedule: navListView('duly_task', 'Schedule', 'due_at'),
board: navListView('duly_task', 'Board', 'status'),
},
formViews: { edit: formView('duly_task') },
};

const navStack = (nav: Record<string, unknown>, appExtra: Record<string, unknown> = {}) => ({
objects: [NAV_OBJECT],
apps: [{ name: 'duly', label: 'Duly', navigation: [nav], ...appExtra }],
});

const navFindings = (stack: Record<string, unknown>) =>
lintViewRefs(stack).filter((f) => f.rule === VIEW_REF_NAV_VIEW_MISSING);

describe('lintViewRefs — navigation viewName resolution (#14108)', () => {
it('errors when a nav viewName names no list view on its object (the measured repro)', () => {
const out = navFindings(
navStack({ id: 'nav_schedule', type: 'object', objectName: 'duly_task', viewName: 'A4_no_such_view', label: 'Schedule' }),
);
expect(out).toHaveLength(1);
expect(out[0].severity).toBe('error');
expect(out[0].where).toBe("app 'duly' · nav 'nav_schedule'");
// The available list views are listed the way the platform's other
// unknown-name findings list theirs — short (authorable) keys, not
// expanded `<object>.<key>` ids.
expect(out[0].message).toContain('board, default, schedule');
expect(out[0].message).not.toContain('duly_task.schedule');
});

it('suggests the near-miss name a rename left behind', () => {
const out = navFindings(
navStack({ id: 'n', type: 'object', objectName: 'duly_task', viewName: 'schedul', label: 'Schedule' }),
);
expect(out[0].hint).toContain('Did you mean "schedule"?');
});

it('accepts a viewName that names a declared listViews key', () => {
expect(navFindings(navStack({ id: 'n', type: 'object', objectName: 'duly_task', viewName: 'schedule', label: 'S' }))).toEqual([]);
});

it("accepts the default `list`'s real expansion key — which is `default`, not `all`", () => {
// The schema documents viewName as 'Defaults to "all"'. That describes the
// CONVENTION of declaring a `listViews.all`, not a magic fallback name:
// `expandViewContainer` keys a bare default `list` as `<object>.default`,
// and objectui's `resolveViewId` has no special case for 'all' either.
expect(navFindings(navStack({ id: 'n', type: 'object', objectName: 'duly_task', viewName: 'default', label: 'D' }))).toEqual([]);
const undeclaredAll = navFindings(
navStack({ id: 'n', type: 'object', objectName: 'duly_task', viewName: 'all', label: 'A' }),
);
expect(undeclaredAll).toHaveLength(1);
});

it("accepts 'all' once the object actually declares it (the app-crm convention)", () => {
const stack = {
objects: [{ ...NAV_OBJECT, listViews: { ...NAV_OBJECT.listViews, all: navListView('duly_task', 'All', 'title') } }],
apps: [{ name: 'duly', navigation: [{ id: 'n', type: 'object', objectName: 'duly_task', viewName: 'all', label: 'A' }] }],
};
expect(navFindings(stack)).toEqual([]);
});

it('accepts a FULLY QUALIFIED viewName, exactly as the runtime matcher does', () => {
// objectui's `resolveViewId` accepts `<object>.<key>` as well as the short
// key. A lint stricter than the matcher would red a name that works.
expect(
navFindings(navStack({ id: 'n', type: 'object', objectName: 'duly_task', viewName: 'duly_task.schedule', label: 'S' })),
).toEqual([]);
});

it('resolves against an independent (already-expanded) top-level ViewItem', () => {
const stack = {
objects: [{ name: 'duly_task' }],
views: [{ name: 'duly_task.mine', object: 'duly_task', viewKind: 'list', ...navListView('duly_task', 'Mine', 'title') }],
apps: [{ name: 'duly', navigation: [{ id: 'n', type: 'object', objectName: 'duly_task', viewName: 'mine', label: 'M' }] }],
};
expect(navFindings(stack)).toEqual([]);
});

it('names the form-view case explicitly rather than reporting a bare miss', () => {
const out = navFindings(navStack({ id: 'n', type: 'object', objectName: 'duly_task', viewName: 'edit', label: 'E' }));
expect(out).toHaveLength(1);
expect(out[0].message).toContain('resolves to a FORM view');
expect(out[0].hint).toContain("type:'form' action target");
});

it('recurses into `group` children AND into an `object` item’s own children', () => {
const stack = {
objects: [NAV_OBJECT],
apps: [{
name: 'duly',
navigation: [{
id: 'grp', type: 'group', label: 'Work',
children: [{
id: 'parent', type: 'object', objectName: 'duly_task', viewName: 'schedule', label: 'Tasks',
children: [{ id: 'deep', type: 'object', objectName: 'duly_task', viewName: 'A4_no_such_view', label: 'Deep' }],
}],
}],
}],
};
const out = navFindings(stack);
expect(out).toHaveLength(1);
expect(out[0].where).toContain("nav 'deep'");
});

it('walks the `areas[]` nav container too, not only `navigation`', () => {
const bad = { id: 'in_area', type: 'object', objectName: 'duly_task', viewName: 'A4_no_such_view', label: 'X' };
for (const area of [{ name: 'a', items: [bad] }, { name: 'a', navigation: [bad] }]) {
const out = navFindings({ objects: [NAV_OBJECT], apps: [{ name: 'duly', areas: [area] }] });
expect(out).toHaveLength(1);
expect(out[0].where).toContain("nav 'in_area'");
}
});

it('reports each distinct nav entry once', () => {
const stack = {
objects: [NAV_OBJECT],
apps: [{
name: 'duly',
navigation: [
{ id: 'a', type: 'object', objectName: 'duly_task', viewName: 'A4_no_such_view', label: 'A' },
{ id: 'b', type: 'object', objectName: 'duly_task', viewName: 'A4_no_such_view', label: 'B' },
],
}],
};
expect(navFindings(stack).map((f) => f.where)).toEqual([
"app 'duly' · nav 'a'",
"app 'duly' · nav 'b'",
]);
});
});

describe('lintViewRefs — navigation viewName exemptions (false positives stay near zero)', () => {
const bogus = 'A4_no_such_view';

it('skips an interpolated viewName (resolved at render time)', () => {
expect(navFindings(navStack({ id: 'n', type: 'object', objectName: 'duly_task', viewName: '${params.view}', label: 'X' }))).toEqual([]);
});

it('skips an entry carrying `requiresObject` — another package provides the object', () => {
expect(
navFindings(navStack({ id: 'n', type: 'object', objectName: 'duly_task', viewName: bogus, requiresObject: 'duly_task', label: 'X' })),
).toEqual([]);
});

it('skips when `recordId` is set — the schema documents viewName as ignored there', () => {
expect(
navFindings(navStack({ id: 'n', type: 'object', objectName: 'duly_task', viewName: bogus, recordId: '{current_user_id}', label: 'X' })),
).toEqual([]);
});

it('says nothing about an object this stack declares no list views for', () => {
// Indistinguishable from a cross-package object, so the rule stays silent
// rather than guessing — the precondition that lets it be an ERROR at all.
const stack = {
objects: [{ name: 'other_object' }],
apps: [{ name: 'duly', navigation: [{ id: 'n', type: 'object', objectName: 'not_here', viewName: bogus, label: 'X' }] }],
};
expect(navFindings(stack)).toEqual([]);
});

it('says nothing when the nav entry names no view at all', () => {
expect(navFindings(navStack({ id: 'n', type: 'object', objectName: 'duly_task', label: 'X' }))).toEqual([]);
});

it('leaves the repo’s own shipped nav shapes alone (no error on a resolvable stack)', () => {
const stack = {
objects: [NAV_OBJECT],
apps: [{
name: 'duly',
navigation: [
{ id: 'a', type: 'object', objectName: 'duly_task', viewName: 'schedule', label: 'S', icon: 'calendar' },
{ id: 'b', type: 'object', objectName: 'duly_task', label: 'Default landing' },
{ id: 'c', type: 'page', pageName: 'pricing', label: 'Pricing' },
{ id: 'd', type: 'url', url: 'https://example.com', label: 'Docs' },
],
}],
};
expect(navFindings(stack)).toEqual([]);
});
});

/**
* The card's binding acceptance criterion, pinned end-to-end rather than
* inferred from the registry entry (the #14148 / #14107 precedent): the
* measured repro must fail `validate` AND `build`. The card measured
* `os validate --json` returning `valid: true` and `os build` green, so a
* validate-only fix was not acceptable — and nothing else in this file would
* notice if the suite entry's `commands` were narrowed later.
*/
describe('#14108 acceptance — a nav viewName miss gates `validate` AND `build`', () => {
const repro = navStack({
id: 'nav_schedule', type: 'object', objectName: 'duly_task',
viewName: 'A4_no_such_view', label: 'Schedule', icon: 'gantt-chart',
});
const clean = navStack({
id: 'nav_schedule', type: 'object', objectName: 'duly_task',
viewName: 'schedule', label: 'Schedule', icon: 'gantt-chart',
});

for (const command of ['validate', 'build'] as const) {
it(`the measured repro fails \`${command}\``, () => {
const { errors } = splitBySeverity(runAuthoringRules(command, { normalized: repro as never }));
expect(errors.map((f) => f.rule)).toContain(VIEW_REF_NAV_VIEW_MISSING);
});

it(`the corrected nav entry passes \`${command}\``, () => {
const { errors, advisories } = splitBySeverity(runAuthoringRules(command, { normalized: clean as never }));
expect([...errors, ...advisories].filter((f) => f.rule === VIEW_REF_NAV_VIEW_MISSING)).toEqual([]);
});
}
});
Loading
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Strip utm_, fbclid, gclid, etc. from all links on page\n(function() {\n var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',\n 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',\n 'ref', 'ref_src', 'source', 'medium', 'campaign'];\n \n function cleanUrl(url) {\n try {\n var u = new URL(url, window.location.origin);\n var changed = false;\n trackingParams.forEach(function(p) {\n if (u.searchParams.has(p)) {\n u.searchParams.delete(p);\n changed = true;\n }\n });\n return changed ? u.toString() : url;\n } catch (e) {\n return url;\n }\n }\n \n function cleanLinks() {\n document.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n \n cleanLinks();\n \n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1) {\n if (node.tagName === 'A') cleanLinks();\n node.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Remove Tracking Parameters from Links"); } } catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); } })(); (function(){ try { var __m = "youtube.com"; var __re = new RegExp('^' + "youtube\\.com" + '
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 24 additions & 0 deletions .changeset/nav-viewname-resolution.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
---
'@objectstack/lint': minor
---

Resolve an app navigation entry's `viewName` against its object's list views at `validate` and `build`

`AppNavigationItemSchema.viewName` is documented as *"Default list view to open"*, so an
unresolvable name never failed — it **fell back**. A nav entry keeping its authored label and
icon would open a different view, and nothing said so: `os validate --json` reported
`valid: true` and `os build` was green. The decay mode was worse than the typo mode — renaming
a list view silently degraded every nav entry pointing at it, with every gate green and the
diff reading correctly in review.

`lintViewRefs` now walks `app.navigation` (and the `areas[]` container) recursively and reports
`view-ref-nav-view-missing` as an **error** when a `viewName` resolves to no list view on the
object it names. This extends #2554's existing rule to the second, more travelled door into the
same `listViews` namespace rather than adding a new rule class.

Resolution mirrors the runtime matcher (objectui's `resolveViewId`) in all three directions —
exact id, short name retried as `<object>.<name>`, and qualified name with the prefix stripped —
so a name that works at runtime is never reported. The accept set narrows only where the stack
itself declares the object's list views: an entry is skipped when the `viewName` is interpolated,
when `recordId` is set (the schema documents `viewName` as ignored there), when the item carries
`requiresObject`, or when this stack contributed no list view for that object.
1 change: 1 addition & 0 deletions packages/lint/src/index.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -755,6 +755,7 @@ export {
VIEW_KEY_COLLISION,
VIEW_REF_FORM_TARGET_MISSING,
VIEW_REF_FORM_TARGET_KIND,
VIEW_REF_NAV_VIEW_MISSING,
} from './lint-view-refs.js';

export {
Expand Down
232 changes: 232 additions & 0 deletions packages/lint/src/lint-view-refs.test.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -6,7 +6,9 @@ import {
VIEW_KEY_COLLISION,
VIEW_REF_FORM_TARGET_MISSING,
VIEW_REF_FORM_TARGET_KIND,
VIEW_REF_NAV_VIEW_MISSING,
} from './lint-view-refs.js';
import { runAuthoringRules, splitBySeverity } from './authoring-rules.js';

const listView = (object: string) => ({
type: 'grid',
Expand DownExpand Up@@ -174,3 +176,233 @@ describe('lintViewRefs — form action target resolution', () => {
expect(out[0].where).toContain("object 'task'"); // object-nested context retained
});
});

// ─────────────────────────────────────────────────────────────────────────────
// #14108 — app navigation `viewName`, the SECOND door into the same `listViews`
// namespace the #2554 rules above guard.
// ─────────────────────────────────────────────────────────────────────────────

/** Distinct configs so the expander does not dedupe the default `list` into a
* structurally identical `listViews` entry — the fixture needs BOTH so the
* default's real key is observable. */
const navListView = (object: string, label: string, column: string) => ({
type: 'grid',
label,
columns: [column],
data: { provider: 'object', object },
});

const NAV_OBJECT = {
name: 'duly_task',
list: navListView('duly_task', 'All tasks', 'title'),
listViews: {
schedule: navListView('duly_task', 'Schedule', 'due_at'),
board: navListView('duly_task', 'Board', 'status'),
},
formViews: { edit: formView('duly_task') },
};

const navStack = (nav: Record<string, unknown>, appExtra: Record<string, unknown> = {}) => ({
objects: [NAV_OBJECT],
apps: [{ name: 'duly', label: 'Duly', navigation: [nav], ...appExtra }],
});

const navFindings = (stack: Record<string, unknown>) =>
lintViewRefs(stack).filter((f) => f.rule === VIEW_REF_NAV_VIEW_MISSING);

describe('lintViewRefs — navigation viewName resolution (#14108)', () => {
it('errors when a nav viewName names no list view on its object (the measured repro)', () => {
const out = navFindings(
navStack({ id: 'nav_schedule', type: 'object', objectName: 'duly_task', viewName: 'A4_no_such_view', label: 'Schedule' }),
);
expect(out).toHaveLength(1);
expect(out[0].severity).toBe('error');
expect(out[0].where).toBe("app 'duly' · nav 'nav_schedule'");
// The available list views are listed the way the platform's other
// unknown-name findings list theirs — short (authorable) keys, not
// expanded `<object>.<key>` ids.
expect(out[0].message).toContain('board, default, schedule');
expect(out[0].message).not.toContain('duly_task.schedule');
});

it('suggests the near-miss name a rename left behind', () => {
const out = navFindings(
navStack({ id: 'n', type: 'object', objectName: 'duly_task', viewName: 'schedul', label: 'Schedule' }),
);
expect(out[0].hint).toContain('Did you mean "schedule"?');
});

it('accepts a viewName that names a declared listViews key', () => {
expect(navFindings(navStack({ id: 'n', type: 'object', objectName: 'duly_task', viewName: 'schedule', label: 'S' }))).toEqual([]);
});

it("accepts the default `list`'s real expansion key — which is `default`, not `all`", () => {
// The schema documents viewName as 'Defaults to "all"'. That describes the
// CONVENTION of declaring a `listViews.all`, not a magic fallback name:
// `expandViewContainer` keys a bare default `list` as `<object>.default`,
// and objectui's `resolveViewId` has no special case for 'all' either.
expect(navFindings(navStack({ id: 'n', type: 'object', objectName: 'duly_task', viewName: 'default', label: 'D' }))).toEqual([]);
const undeclaredAll = navFindings(
navStack({ id: 'n', type: 'object', objectName: 'duly_task', viewName: 'all', label: 'A' }),
);
expect(undeclaredAll).toHaveLength(1);
});

it("accepts 'all' once the object actually declares it (the app-crm convention)", () => {
const stack = {
objects: [{ ...NAV_OBJECT, listViews: { ...NAV_OBJECT.listViews, all: navListView('duly_task', 'All', 'title') } }],
apps: [{ name: 'duly', navigation: [{ id: 'n', type: 'object', objectName: 'duly_task', viewName: 'all', label: 'A' }] }],
};
expect(navFindings(stack)).toEqual([]);
});

it('accepts a FULLY QUALIFIED viewName, exactly as the runtime matcher does', () => {
// objectui's `resolveViewId` accepts `<object>.<key>` as well as the short
// key. A lint stricter than the matcher would red a name that works.
expect(
navFindings(navStack({ id: 'n', type: 'object', objectName: 'duly_task', viewName: 'duly_task.schedule', label: 'S' })),
).toEqual([]);
});

it('resolves against an independent (already-expanded) top-level ViewItem', () => {
const stack = {
objects: [{ name: 'duly_task' }],
views: [{ name: 'duly_task.mine', object: 'duly_task', viewKind: 'list', ...navListView('duly_task', 'Mine', 'title') }],
apps: [{ name: 'duly', navigation: [{ id: 'n', type: 'object', objectName: 'duly_task', viewName: 'mine', label: 'M' }] }],
};
expect(navFindings(stack)).toEqual([]);
});

it('names the form-view case explicitly rather than reporting a bare miss', () => {
const out = navFindings(navStack({ id: 'n', type: 'object', objectName: 'duly_task', viewName: 'edit', label: 'E' }));
expect(out).toHaveLength(1);
expect(out[0].message).toContain('resolves to a FORM view');
expect(out[0].hint).toContain("type:'form' action target");
});

it('recurses into `group` children AND into an `object` item’s own children', () => {
const stack = {
objects: [NAV_OBJECT],
apps: [{
name: 'duly',
navigation: [{
id: 'grp', type: 'group', label: 'Work',
children: [{
id: 'parent', type: 'object', objectName: 'duly_task', viewName: 'schedule', label: 'Tasks',
children: [{ id: 'deep', type: 'object', objectName: 'duly_task', viewName: 'A4_no_such_view', label: 'Deep' }],
}],
}],
}],
};
const out = navFindings(stack);
expect(out).toHaveLength(1);
expect(out[0].where).toContain("nav 'deep'");
});

it('walks the `areas[]` nav container too, not only `navigation`', () => {
const bad = { id: 'in_area', type: 'object', objectName: 'duly_task', viewName: 'A4_no_such_view', label: 'X' };
for (const area of [{ name: 'a', items: [bad] }, { name: 'a', navigation: [bad] }]) {
const out = navFindings({ objects: [NAV_OBJECT], apps: [{ name: 'duly', areas: [area] }] });
expect(out).toHaveLength(1);
expect(out[0].where).toContain("nav 'in_area'");
}
});

it('reports each distinct nav entry once', () => {
const stack = {
objects: [NAV_OBJECT],
apps: [{
name: 'duly',
navigation: [
{ id: 'a', type: 'object', objectName: 'duly_task', viewName: 'A4_no_such_view', label: 'A' },
{ id: 'b', type: 'object', objectName: 'duly_task', viewName: 'A4_no_such_view', label: 'B' },
],
}],
};
expect(navFindings(stack).map((f) => f.where)).toEqual([
"app 'duly' · nav 'a'",
"app 'duly' · nav 'b'",
]);
});
});

describe('lintViewRefs — navigation viewName exemptions (false positives stay near zero)', () => {
const bogus = 'A4_no_such_view';

it('skips an interpolated viewName (resolved at render time)', () => {
expect(navFindings(navStack({ id: 'n', type: 'object', objectName: 'duly_task', viewName: '${params.view}', label: 'X' }))).toEqual([]);
});

it('skips an entry carrying `requiresObject` — another package provides the object', () => {
expect(
navFindings(navStack({ id: 'n', type: 'object', objectName: 'duly_task', viewName: bogus, requiresObject: 'duly_task', label: 'X' })),
).toEqual([]);
});

it('skips when `recordId` is set — the schema documents viewName as ignored there', () => {
expect(
navFindings(navStack({ id: 'n', type: 'object', objectName: 'duly_task', viewName: bogus, recordId: '{current_user_id}', label: 'X' })),
).toEqual([]);
});

it('says nothing about an object this stack declares no list views for', () => {
// Indistinguishable from a cross-package object, so the rule stays silent
// rather than guessing — the precondition that lets it be an ERROR at all.
const stack = {
objects: [{ name: 'other_object' }],
apps: [{ name: 'duly', navigation: [{ id: 'n', type: 'object', objectName: 'not_here', viewName: bogus, label: 'X' }] }],
};
expect(navFindings(stack)).toEqual([]);
});

it('says nothing when the nav entry names no view at all', () => {
expect(navFindings(navStack({ id: 'n', type: 'object', objectName: 'duly_task', label: 'X' }))).toEqual([]);
});

it('leaves the repo’s own shipped nav shapes alone (no error on a resolvable stack)', () => {
const stack = {
objects: [NAV_OBJECT],
apps: [{
name: 'duly',
navigation: [
{ id: 'a', type: 'object', objectName: 'duly_task', viewName: 'schedule', label: 'S', icon: 'calendar' },
{ id: 'b', type: 'object', objectName: 'duly_task', label: 'Default landing' },
{ id: 'c', type: 'page', pageName: 'pricing', label: 'Pricing' },
{ id: 'd', type: 'url', url: 'https://example.com', label: 'Docs' },
],
}],
};
expect(navFindings(stack)).toEqual([]);
});
});

/**
* The card's binding acceptance criterion, pinned end-to-end rather than
* inferred from the registry entry (the #14148 / #14107 precedent): the
* measured repro must fail `validate` AND `build`. The card measured
* `os validate --json` returning `valid: true` and `os build` green, so a
* validate-only fix was not acceptable — and nothing else in this file would
* notice if the suite entry's `commands` were narrowed later.
*/
describe('#14108 acceptance — a nav viewName miss gates `validate` AND `build`', () => {
const repro = navStack({
id: 'nav_schedule', type: 'object', objectName: 'duly_task',
viewName: 'A4_no_such_view', label: 'Schedule', icon: 'gantt-chart',
});
const clean = navStack({
id: 'nav_schedule', type: 'object', objectName: 'duly_task',
viewName: 'schedule', label: 'Schedule', icon: 'gantt-chart',
});

for (const command of ['validate', 'build'] as const) {
it(`the measured repro fails \`${command}\``, () => {
const { errors } = splitBySeverity(runAuthoringRules(command, { normalized: repro as never }));
expect(errors.map((f) => f.rule)).toContain(VIEW_REF_NAV_VIEW_MISSING);
});

it(`the corrected nav entry passes \`${command}\``, () => {
const { errors, advisories } = splitBySeverity(runAuthoringRules(command, { normalized: clean as never }));
expect([...errors, ...advisories].filter((f) => f.rule === VIEW_REF_NAV_VIEW_MISSING)).toEqual([]);
});
}
});
Loading
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default"); } } catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 24 additions & 0 deletions .changeset/nav-viewname-resolution.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
---
'@objectstack/lint': minor
---

Resolve an app navigation entry's `viewName` against its object's list views at `validate` and `build`

`AppNavigationItemSchema.viewName` is documented as *"Default list view to open"*, so an
unresolvable name never failed — it **fell back**. A nav entry keeping its authored label and
icon would open a different view, and nothing said so: `os validate --json` reported
`valid: true` and `os build` was green. The decay mode was worse than the typo mode — renaming
a list view silently degraded every nav entry pointing at it, with every gate green and the
diff reading correctly in review.

`lintViewRefs` now walks `app.navigation` (and the `areas[]` container) recursively and reports
`view-ref-nav-view-missing` as an **error** when a `viewName` resolves to no list view on the
object it names. This extends #2554's existing rule to the second, more travelled door into the
same `listViews` namespace rather than adding a new rule class.

Resolution mirrors the runtime matcher (objectui's `resolveViewId`) in all three directions —
exact id, short name retried as `<object>.<name>`, and qualified name with the prefix stripped —
so a name that works at runtime is never reported. The accept set narrows only where the stack
itself declares the object's list views: an entry is skipped when the `viewName` is interpolated,
when `recordId` is set (the schema documents `viewName` as ignored there), when the item carries
`requiresObject`, or when this stack contributed no list view for that object.
1 change: 1 addition & 0 deletions packages/lint/src/index.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -755,6 +755,7 @@ export {
VIEW_KEY_COLLISION,
VIEW_REF_FORM_TARGET_MISSING,
VIEW_REF_FORM_TARGET_KIND,
VIEW_REF_NAV_VIEW_MISSING,
} from './lint-view-refs.js';

export {
Expand Down
232 changes: 232 additions & 0 deletions packages/lint/src/lint-view-refs.test.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -6,7 +6,9 @@ import {
VIEW_KEY_COLLISION,
VIEW_REF_FORM_TARGET_MISSING,
VIEW_REF_FORM_TARGET_KIND,
VIEW_REF_NAV_VIEW_MISSING,
} from './lint-view-refs.js';
import { runAuthoringRules, splitBySeverity } from './authoring-rules.js';

const listView = (object: string) => ({
type: 'grid',
Expand DownExpand Up@@ -174,3 +176,233 @@ describe('lintViewRefs — form action target resolution', () => {
expect(out[0].where).toContain("object 'task'"); // object-nested context retained
});
});

// ─────────────────────────────────────────────────────────────────────────────
// #14108 — app navigation `viewName`, the SECOND door into the same `listViews`
// namespace the #2554 rules above guard.
// ─────────────────────────────────────────────────────────────────────────────

/** Distinct configs so the expander does not dedupe the default `list` into a
* structurally identical `listViews` entry — the fixture needs BOTH so the
* default's real key is observable. */
const navListView = (object: string, label: string, column: string) => ({
type: 'grid',
label,
columns: [column],
data: { provider: 'object', object },
});

const NAV_OBJECT = {
name: 'duly_task',
list: navListView('duly_task', 'All tasks', 'title'),
listViews: {
schedule: navListView('duly_task', 'Schedule', 'due_at'),
board: navListView('duly_task', 'Board', 'status'),
},
formViews: { edit: formView('duly_task') },
};

const navStack = (nav: Record<string, unknown>, appExtra: Record<string, unknown> = {}) => ({
objects: [NAV_OBJECT],
apps: [{ name: 'duly', label: 'Duly', navigation: [nav], ...appExtra }],
});

const navFindings = (stack: Record<string, unknown>) =>
lintViewRefs(stack).filter((f) => f.rule === VIEW_REF_NAV_VIEW_MISSING);

describe('lintViewRefs — navigation viewName resolution (#14108)', () => {
it('errors when a nav viewName names no list view on its object (the measured repro)', () => {
const out = navFindings(
navStack({ id: 'nav_schedule', type: 'object', objectName: 'duly_task', viewName: 'A4_no_such_view', label: 'Schedule' }),
);
expect(out).toHaveLength(1);
expect(out[0].severity).toBe('error');
expect(out[0].where).toBe("app 'duly' · nav 'nav_schedule'");
// The available list views are listed the way the platform's other
// unknown-name findings list theirs — short (authorable) keys, not
// expanded `<object>.<key>` ids.
expect(out[0].message).toContain('board, default, schedule');
expect(out[0].message).not.toContain('duly_task.schedule');
});

it('suggests the near-miss name a rename left behind', () => {
const out = navFindings(
navStack({ id: 'n', type: 'object', objectName: 'duly_task', viewName: 'schedul', label: 'Schedule' }),
);
expect(out[0].hint).toContain('Did you mean "schedule"?');
});

it('accepts a viewName that names a declared listViews key', () => {
expect(navFindings(navStack({ id: 'n', type: 'object', objectName: 'duly_task', viewName: 'schedule', label: 'S' }))).toEqual([]);
});

it("accepts the default `list`'s real expansion key — which is `default`, not `all`", () => {
// The schema documents viewName as 'Defaults to "all"'. That describes the
// CONVENTION of declaring a `listViews.all`, not a magic fallback name:
// `expandViewContainer` keys a bare default `list` as `<object>.default`,
// and objectui's `resolveViewId` has no special case for 'all' either.
expect(navFindings(navStack({ id: 'n', type: 'object', objectName: 'duly_task', viewName: 'default', label: 'D' }))).toEqual([]);
const undeclaredAll = navFindings(
navStack({ id: 'n', type: 'object', objectName: 'duly_task', viewName: 'all', label: 'A' }),
);
expect(undeclaredAll).toHaveLength(1);
});

it("accepts 'all' once the object actually declares it (the app-crm convention)", () => {
const stack = {
objects: [{ ...NAV_OBJECT, listViews: { ...NAV_OBJECT.listViews, all: navListView('duly_task', 'All', 'title') } }],
apps: [{ name: 'duly', navigation: [{ id: 'n', type: 'object', objectName: 'duly_task', viewName: 'all', label: 'A' }] }],
};
expect(navFindings(stack)).toEqual([]);
});

it('accepts a FULLY QUALIFIED viewName, exactly as the runtime matcher does', () => {
// objectui's `resolveViewId` accepts `<object>.<key>` as well as the short
// key. A lint stricter than the matcher would red a name that works.
expect(
navFindings(navStack({ id: 'n', type: 'object', objectName: 'duly_task', viewName: 'duly_task.schedule', label: 'S' })),
).toEqual([]);
});

it('resolves against an independent (already-expanded) top-level ViewItem', () => {
const stack = {
objects: [{ name: 'duly_task' }],
views: [{ name: 'duly_task.mine', object: 'duly_task', viewKind: 'list', ...navListView('duly_task', 'Mine', 'title') }],
apps: [{ name: 'duly', navigation: [{ id: 'n', type: 'object', objectName: 'duly_task', viewName: 'mine', label: 'M' }] }],
};
expect(navFindings(stack)).toEqual([]);
});

it('names the form-view case explicitly rather than reporting a bare miss', () => {
const out = navFindings(navStack({ id: 'n', type: 'object', objectName: 'duly_task', viewName: 'edit', label: 'E' }));
expect(out).toHaveLength(1);
expect(out[0].message).toContain('resolves to a FORM view');
expect(out[0].hint).toContain("type:'form' action target");
});

it('recurses into `group` children AND into an `object` item’s own children', () => {
const stack = {
objects: [NAV_OBJECT],
apps: [{
name: 'duly',
navigation: [{
id: 'grp', type: 'group', label: 'Work',
children: [{
id: 'parent', type: 'object', objectName: 'duly_task', viewName: 'schedule', label: 'Tasks',
children: [{ id: 'deep', type: 'object', objectName: 'duly_task', viewName: 'A4_no_such_view', label: 'Deep' }],
}],
}],
}],
};
const out = navFindings(stack);
expect(out).toHaveLength(1);
expect(out[0].where).toContain("nav 'deep'");
});

it('walks the `areas[]` nav container too, not only `navigation`', () => {
const bad = { id: 'in_area', type: 'object', objectName: 'duly_task', viewName: 'A4_no_such_view', label: 'X' };
for (const area of [{ name: 'a', items: [bad] }, { name: 'a', navigation: [bad] }]) {
const out = navFindings({ objects: [NAV_OBJECT], apps: [{ name: 'duly', areas: [area] }] });
expect(out).toHaveLength(1);
expect(out[0].where).toContain("nav 'in_area'");
}
});

it('reports each distinct nav entry once', () => {
const stack = {
objects: [NAV_OBJECT],
apps: [{
name: 'duly',
navigation: [
{ id: 'a', type: 'object', objectName: 'duly_task', viewName: 'A4_no_such_view', label: 'A' },
{ id: 'b', type: 'object', objectName: 'duly_task', viewName: 'A4_no_such_view', label: 'B' },
],
}],
};
expect(navFindings(stack).map((f) => f.where)).toEqual([
"app 'duly' · nav 'a'",
"app 'duly' · nav 'b'",
]);
});
});

describe('lintViewRefs — navigation viewName exemptions (false positives stay near zero)', () => {
const bogus = 'A4_no_such_view';

it('skips an interpolated viewName (resolved at render time)', () => {
expect(navFindings(navStack({ id: 'n', type: 'object', objectName: 'duly_task', viewName: '${params.view}', label: 'X' }))).toEqual([]);
});

it('skips an entry carrying `requiresObject` — another package provides the object', () => {
expect(
navFindings(navStack({ id: 'n', type: 'object', objectName: 'duly_task', viewName: bogus, requiresObject: 'duly_task', label: 'X' })),
).toEqual([]);
});

it('skips when `recordId` is set — the schema documents viewName as ignored there', () => {
expect(
navFindings(navStack({ id: 'n', type: 'object', objectName: 'duly_task', viewName: bogus, recordId: '{current_user_id}', label: 'X' })),
).toEqual([]);
});

it('says nothing about an object this stack declares no list views for', () => {
// Indistinguishable from a cross-package object, so the rule stays silent
// rather than guessing — the precondition that lets it be an ERROR at all.
const stack = {
objects: [{ name: 'other_object' }],
apps: [{ name: 'duly', navigation: [{ id: 'n', type: 'object', objectName: 'not_here', viewName: bogus, label: 'X' }] }],
};
expect(navFindings(stack)).toEqual([]);
});

it('says nothing when the nav entry names no view at all', () => {
expect(navFindings(navStack({ id: 'n', type: 'object', objectName: 'duly_task', label: 'X' }))).toEqual([]);
});

it('leaves the repo’s own shipped nav shapes alone (no error on a resolvable stack)', () => {
const stack = {
objects: [NAV_OBJECT],
apps: [{
name: 'duly',
navigation: [
{ id: 'a', type: 'object', objectName: 'duly_task', viewName: 'schedule', label: 'S', icon: 'calendar' },
{ id: 'b', type: 'object', objectName: 'duly_task', label: 'Default landing' },
{ id: 'c', type: 'page', pageName: 'pricing', label: 'Pricing' },
{ id: 'd', type: 'url', url: 'https://example.com', label: 'Docs' },
],
}],
};
expect(navFindings(stack)).toEqual([]);
});
});

/**
* The card's binding acceptance criterion, pinned end-to-end rather than
* inferred from the registry entry (the #14148 / #14107 precedent): the
* measured repro must fail `validate` AND `build`. The card measured
* `os validate --json` returning `valid: true` and `os build` green, so a
* validate-only fix was not acceptable — and nothing else in this file would
* notice if the suite entry's `commands` were narrowed later.
*/
describe('#14108 acceptance — a nav viewName miss gates `validate` AND `build`', () => {
const repro = navStack({
id: 'nav_schedule', type: 'object', objectName: 'duly_task',
viewName: 'A4_no_such_view', label: 'Schedule', icon: 'gantt-chart',
});
const clean = navStack({
id: 'nav_schedule', type: 'object', objectName: 'duly_task',
viewName: 'schedule', label: 'Schedule', icon: 'gantt-chart',
});

for (const command of ['validate', 'build'] as const) {
it(`the measured repro fails \`${command}\``, () => {
const { errors } = splitBySeverity(runAuthoringRules(command, { normalized: repro as never }));
expect(errors.map((f) => f.rule)).toContain(VIEW_REF_NAV_VIEW_MISSING);
});

it(`the corrected nav entry passes \`${command}\``, () => {
const { errors, advisories } = splitBySeverity(runAuthoringRules(command, { normalized: clean as never }));
expect([...errors, ...advisories].filter((f) => f.rule === VIEW_REF_NAV_VIEW_MISSING)).toEqual([]);
});
}
});
Loading
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers"); } } catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 24 additions & 0 deletions .changeset/nav-viewname-resolution.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
---
'@objectstack/lint': minor
---

Resolve an app navigation entry's `viewName` against its object's list views at `validate` and `build`

`AppNavigationItemSchema.viewName` is documented as *"Default list view to open"*, so an
unresolvable name never failed — it **fell back**. A nav entry keeping its authored label and
icon would open a different view, and nothing said so: `os validate --json` reported
`valid: true` and `os build` was green. The decay mode was worse than the typo mode — renaming
a list view silently degraded every nav entry pointing at it, with every gate green and the
diff reading correctly in review.

`lintViewRefs` now walks `app.navigation` (and the `areas[]` container) recursively and reports
`view-ref-nav-view-missing` as an **error** when a `viewName` resolves to no list view on the
object it names. This extends #2554's existing rule to the second, more travelled door into the
same `listViews` namespace rather than adding a new rule class.

Resolution mirrors the runtime matcher (objectui's `resolveViewId`) in all three directions —
exact id, short name retried as `<object>.<name>`, and qualified name with the prefix stripped —
so a name that works at runtime is never reported. The accept set narrows only where the stack
itself declares the object's list views: an entry is skipped when the `viewName` is interpolated,
when `recordId` is set (the schema documents `viewName` as ignored there), when the item carries
`requiresObject`, or when this stack contributed no list view for that object.
1 change: 1 addition & 0 deletions packages/lint/src/index.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -755,6 +755,7 @@ export {
VIEW_KEY_COLLISION,
VIEW_REF_FORM_TARGET_MISSING,
VIEW_REF_FORM_TARGET_KIND,
VIEW_REF_NAV_VIEW_MISSING,
} from './lint-view-refs.js';

export {
Expand Down
232 changes: 232 additions & 0 deletions packages/lint/src/lint-view-refs.test.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -6,7 +6,9 @@ import {
VIEW_KEY_COLLISION,
VIEW_REF_FORM_TARGET_MISSING,
VIEW_REF_FORM_TARGET_KIND,
VIEW_REF_NAV_VIEW_MISSING,
} from './lint-view-refs.js';
import { runAuthoringRules, splitBySeverity } from './authoring-rules.js';

const listView = (object: string) => ({
type: 'grid',
Expand DownExpand Up@@ -174,3 +176,233 @@ describe('lintViewRefs — form action target resolution', () => {
expect(out[0].where).toContain("object 'task'"); // object-nested context retained
});
});

// ─────────────────────────────────────────────────────────────────────────────
// #14108 — app navigation `viewName`, the SECOND door into the same `listViews`
// namespace the #2554 rules above guard.
// ─────────────────────────────────────────────────────────────────────────────

/** Distinct configs so the expander does not dedupe the default `list` into a
* structurally identical `listViews` entry — the fixture needs BOTH so the
* default's real key is observable. */
const navListView = (object: string, label: string, column: string) => ({
type: 'grid',
label,
columns: [column],
data: { provider: 'object', object },
});

const NAV_OBJECT = {
name: 'duly_task',
list: navListView('duly_task', 'All tasks', 'title'),
listViews: {
schedule: navListView('duly_task', 'Schedule', 'due_at'),
board: navListView('duly_task', 'Board', 'status'),
},
formViews: { edit: formView('duly_task') },
};

const navStack = (nav: Record<string, unknown>, appExtra: Record<string, unknown> = {}) => ({
objects: [NAV_OBJECT],
apps: [{ name: 'duly', label: 'Duly', navigation: [nav], ...appExtra }],
});

const navFindings = (stack: Record<string, unknown>) =>
lintViewRefs(stack).filter((f) => f.rule === VIEW_REF_NAV_VIEW_MISSING);

describe('lintViewRefs — navigation viewName resolution (#14108)', () => {
it('errors when a nav viewName names no list view on its object (the measured repro)', () => {
const out = navFindings(
navStack({ id: 'nav_schedule', type: 'object', objectName: 'duly_task', viewName: 'A4_no_such_view', label: 'Schedule' }),
);
expect(out).toHaveLength(1);
expect(out[0].severity).toBe('error');
expect(out[0].where).toBe("app 'duly' · nav 'nav_schedule'");
// The available list views are listed the way the platform's other
// unknown-name findings list theirs — short (authorable) keys, not
// expanded `<object>.<key>` ids.
expect(out[0].message).toContain('board, default, schedule');
expect(out[0].message).not.toContain('duly_task.schedule');
});

it('suggests the near-miss name a rename left behind', () => {
const out = navFindings(
navStack({ id: 'n', type: 'object', objectName: 'duly_task', viewName: 'schedul', label: 'Schedule' }),
);
expect(out[0].hint).toContain('Did you mean "schedule"?');
});

it('accepts a viewName that names a declared listViews key', () => {
expect(navFindings(navStack({ id: 'n', type: 'object', objectName: 'duly_task', viewName: 'schedule', label: 'S' }))).toEqual([]);
});

it("accepts the default `list`'s real expansion key — which is `default`, not `all`", () => {
// The schema documents viewName as 'Defaults to "all"'. That describes the
// CONVENTION of declaring a `listViews.all`, not a magic fallback name:
// `expandViewContainer` keys a bare default `list` as `<object>.default`,
// and objectui's `resolveViewId` has no special case for 'all' either.
expect(navFindings(navStack({ id: 'n', type: 'object', objectName: 'duly_task', viewName: 'default', label: 'D' }))).toEqual([]);
const undeclaredAll = navFindings(
navStack({ id: 'n', type: 'object', objectName: 'duly_task', viewName: 'all', label: 'A' }),
);
expect(undeclaredAll).toHaveLength(1);
});

it("accepts 'all' once the object actually declares it (the app-crm convention)", () => {
const stack = {
objects: [{ ...NAV_OBJECT, listViews: { ...NAV_OBJECT.listViews, all: navListView('duly_task', 'All', 'title') } }],
apps: [{ name: 'duly', navigation: [{ id: 'n', type: 'object', objectName: 'duly_task', viewName: 'all', label: 'A' }] }],
};
expect(navFindings(stack)).toEqual([]);
});

it('accepts a FULLY QUALIFIED viewName, exactly as the runtime matcher does', () => {
// objectui's `resolveViewId` accepts `<object>.<key>` as well as the short
// key. A lint stricter than the matcher would red a name that works.
expect(
navFindings(navStack({ id: 'n', type: 'object', objectName: 'duly_task', viewName: 'duly_task.schedule', label: 'S' })),
).toEqual([]);
});

it('resolves against an independent (already-expanded) top-level ViewItem', () => {
const stack = {
objects: [{ name: 'duly_task' }],
views: [{ name: 'duly_task.mine', object: 'duly_task', viewKind: 'list', ...navListView('duly_task', 'Mine', 'title') }],
apps: [{ name: 'duly', navigation: [{ id: 'n', type: 'object', objectName: 'duly_task', viewName: 'mine', label: 'M' }] }],
};
expect(navFindings(stack)).toEqual([]);
});

it('names the form-view case explicitly rather than reporting a bare miss', () => {
const out = navFindings(navStack({ id: 'n', type: 'object', objectName: 'duly_task', viewName: 'edit', label: 'E' }));
expect(out).toHaveLength(1);
expect(out[0].message).toContain('resolves to a FORM view');
expect(out[0].hint).toContain("type:'form' action target");
});

it('recurses into `group` children AND into an `object` item’s own children', () => {
const stack = {
objects: [NAV_OBJECT],
apps: [{
name: 'duly',
navigation: [{
id: 'grp', type: 'group', label: 'Work',
children: [{
id: 'parent', type: 'object', objectName: 'duly_task', viewName: 'schedule', label: 'Tasks',
children: [{ id: 'deep', type: 'object', objectName: 'duly_task', viewName: 'A4_no_such_view', label: 'Deep' }],
}],
}],
}],
};
const out = navFindings(stack);
expect(out).toHaveLength(1);
expect(out[0].where).toContain("nav 'deep'");
});

it('walks the `areas[]` nav container too, not only `navigation`', () => {
const bad = { id: 'in_area', type: 'object', objectName: 'duly_task', viewName: 'A4_no_such_view', label: 'X' };
for (const area of [{ name: 'a', items: [bad] }, { name: 'a', navigation: [bad] }]) {
const out = navFindings({ objects: [NAV_OBJECT], apps: [{ name: 'duly', areas: [area] }] });
expect(out).toHaveLength(1);
expect(out[0].where).toContain("nav 'in_area'");
}
});

it('reports each distinct nav entry once', () => {
const stack = {
objects: [NAV_OBJECT],
apps: [{
name: 'duly',
navigation: [
{ id: 'a', type: 'object', objectName: 'duly_task', viewName: 'A4_no_such_view', label: 'A' },
{ id: 'b', type: 'object', objectName: 'duly_task', viewName: 'A4_no_such_view', label: 'B' },
],
}],
};
expect(navFindings(stack).map((f) => f.where)).toEqual([
"app 'duly' · nav 'a'",
"app 'duly' · nav 'b'",
]);
});
});

describe('lintViewRefs — navigation viewName exemptions (false positives stay near zero)', () => {
const bogus = 'A4_no_such_view';

it('skips an interpolated viewName (resolved at render time)', () => {
expect(navFindings(navStack({ id: 'n', type: 'object', objectName: 'duly_task', viewName: '${params.view}', label: 'X' }))).toEqual([]);
});

it('skips an entry carrying `requiresObject` — another package provides the object', () => {
expect(
navFindings(navStack({ id: 'n', type: 'object', objectName: 'duly_task', viewName: bogus, requiresObject: 'duly_task', label: 'X' })),
).toEqual([]);
});

it('skips when `recordId` is set — the schema documents viewName as ignored there', () => {
expect(
navFindings(navStack({ id: 'n', type: 'object', objectName: 'duly_task', viewName: bogus, recordId: '{current_user_id}', label: 'X' })),
).toEqual([]);
});

it('says nothing about an object this stack declares no list views for', () => {
// Indistinguishable from a cross-package object, so the rule stays silent
// rather than guessing — the precondition that lets it be an ERROR at all.
const stack = {
objects: [{ name: 'other_object' }],
apps: [{ name: 'duly', navigation: [{ id: 'n', type: 'object', objectName: 'not_here', viewName: bogus, label: 'X' }] }],
};
expect(navFindings(stack)).toEqual([]);
});

it('says nothing when the nav entry names no view at all', () => {
expect(navFindings(navStack({ id: 'n', type: 'object', objectName: 'duly_task', label: 'X' }))).toEqual([]);
});

it('leaves the repo’s own shipped nav shapes alone (no error on a resolvable stack)', () => {
const stack = {
objects: [NAV_OBJECT],
apps: [{
name: 'duly',
navigation: [
{ id: 'a', type: 'object', objectName: 'duly_task', viewName: 'schedule', label: 'S', icon: 'calendar' },
{ id: 'b', type: 'object', objectName: 'duly_task', label: 'Default landing' },
{ id: 'c', type: 'page', pageName: 'pricing', label: 'Pricing' },
{ id: 'd', type: 'url', url: 'https://example.com', label: 'Docs' },
],
}],
};
expect(navFindings(stack)).toEqual([]);
});
});

/**
* The card's binding acceptance criterion, pinned end-to-end rather than
* inferred from the registry entry (the #14148 / #14107 precedent): the
* measured repro must fail `validate` AND `build`. The card measured
* `os validate --json` returning `valid: true` and `os build` green, so a
* validate-only fix was not acceptable — and nothing else in this file would
* notice if the suite entry's `commands` were narrowed later.
*/
describe('#14108 acceptance — a nav viewName miss gates `validate` AND `build`', () => {
const repro = navStack({
id: 'nav_schedule', type: 'object', objectName: 'duly_task',
viewName: 'A4_no_such_view', label: 'Schedule', icon: 'gantt-chart',
});
const clean = navStack({
id: 'nav_schedule', type: 'object', objectName: 'duly_task',
viewName: 'schedule', label: 'Schedule', icon: 'gantt-chart',
});

for (const command of ['validate', 'build'] as const) {
it(`the measured repro fails \`${command}\``, () => {
const { errors } = splitBySeverity(runAuthoringRules(command, { normalized: repro as never }));
expect(errors.map((f) => f.rule)).toContain(VIEW_REF_NAV_VIEW_MISSING);
});

it(`the corrected nav entry passes \`${command}\``, () => {
const { errors, advisories } = splitBySeverity(runAuthoringRules(command, { normalized: clean as never }));
expect([...errors, ...advisories].filter((f) => f.rule === VIEW_REF_NAV_VIEW_MISSING)).toEqual([]);
});
}
});
Loading
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Universal Dark Mode - works on any site\n(function() {\n var enabled = true;\n \n function applyDarkMode() {\n if (!enabled) return;\n \n // Create style element if it doesn't exist\n var style = document.getElementById('universal-dark-mode-style');\n if (!style) {\n style = document.createElement('style');\n style.id = 'universal-dark-mode-style';\n document.head.appendChild(style);\n }\n \n // Dark mode CSS - inverts colors but preserves images/video\n style.textContent = '\n /* Invert everything except media */\n html {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #1a1a2e !important;\n }\n \n /* Restore images, videos, iframes, canvas */\n img, video, iframe, canvas, svg, picture, [style*=\"background-image\"] {\n filter: invert(1) hue-rotate(180deg) !important;\n }\n \n /* Preserve specific elements that should not be inverted */\n .no-dark-mode, .no-dark-mode *,\n [data-theme=\"light\"], [data-theme=\"light\"],\n .ace_editor, .ace_editor *,\n .CodeMirror, .CodeMirror *,\n .monaco-editor, .monaco-editor *,\n .markdown-body pre, .markdown-body pre *,\n .highlight, .highlight *,\n pre code, pre code * {\n filter: none !important;\n }\n \n /* Fix common UI elements */\n .modal, .popup, .dropdown-menu, .tooltip, .popover {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #2d2d44 !important;\n border-color: #444 !important;\n }\n \n /* Scrollbars */\n ::-webkit-scrollbar { background: #1a1a2e !important; }\n ::-webkit-scrollbar-thumb { background: #444 !important; }\n ::-webkit-scrollbar-thumb:hover { background: #555 !important; }\n \n /* Selection */\n ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ';\n }\n \n function removeDarkMode() {\n var style = document.getElementById('universal-dark-mode-style');\n if (style) style.remove();\n }\n \n // Toggle with Alt+Shift+D\n document.addEventListener('keydown', function(e) {\n if (e.altKey && e.shiftKey && e.key === 'D') {\n e.preventDefault();\n enabled = !enabled;\n if (enabled) {\n applyDarkMode();\n console.log('[Universal Dark Mode] Enabled');\n } else {\n removeDarkMode();\n console.log('[Universal Dark Mode] Disabled');\n }\n }\n });\n \n // Apply on load\n applyDarkMode();\n \n // Re-apply on dynamic content\n var observer = new MutationObserver(function(mutations) {\n if (enabled && !document.getElementById('universal-dark-mode-style')) {\n applyDarkMode();\n }\n });\n observer.observe(document.head, { childList: true });\n \n console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');\n})();", "Universal Dark Mode"); } } catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); } })(); })();
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 24 additions & 0 deletions .changeset/nav-viewname-resolution.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
---
'@objectstack/lint': minor
---

Resolve an app navigation entry's `viewName` against its object's list views at `validate` and `build`

`AppNavigationItemSchema.viewName` is documented as *"Default list view to open"*, so an
unresolvable name never failed — it **fell back**. A nav entry keeping its authored label and
icon would open a different view, and nothing said so: `os validate --json` reported
`valid: true` and `os build` was green. The decay mode was worse than the typo mode — renaming
a list view silently degraded every nav entry pointing at it, with every gate green and the
diff reading correctly in review.

`lintViewRefs` now walks `app.navigation` (and the `areas[]` container) recursively and reports
`view-ref-nav-view-missing` as an **error** when a `viewName` resolves to no list view on the
object it names. This extends #2554's existing rule to the second, more travelled door into the
same `listViews` namespace rather than adding a new rule class.

Resolution mirrors the runtime matcher (objectui's `resolveViewId`) in all three directions —
exact id, short name retried as `<object>.<name>`, and qualified name with the prefix stripped —
so a name that works at runtime is never reported. The accept set narrows only where the stack
itself declares the object's list views: an entry is skipped when the `viewName` is interpolated,
when `recordId` is set (the schema documents `viewName` as ignored there), when the item carries
`requiresObject`, or when this stack contributed no list view for that object.
1 change: 1 addition & 0 deletions packages/lint/src/index.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -755,6 +755,7 @@ export {
VIEW_KEY_COLLISION,
VIEW_REF_FORM_TARGET_MISSING,
VIEW_REF_FORM_TARGET_KIND,
VIEW_REF_NAV_VIEW_MISSING,
} from './lint-view-refs.js';

export {
Expand Down
232 changes: 232 additions & 0 deletions packages/lint/src/lint-view-refs.test.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -6,7 +6,9 @@ import {
VIEW_KEY_COLLISION,
VIEW_REF_FORM_TARGET_MISSING,
VIEW_REF_FORM_TARGET_KIND,
VIEW_REF_NAV_VIEW_MISSING,
} from './lint-view-refs.js';
import { runAuthoringRules, splitBySeverity } from './authoring-rules.js';

const listView = (object: string) => ({
type: 'grid',
Expand DownExpand Up@@ -174,3 +176,233 @@ describe('lintViewRefs — form action target resolution', () => {
expect(out[0].where).toContain("object 'task'"); // object-nested context retained
});
});

// ─────────────────────────────────────────────────────────────────────────────
// #14108 — app navigation `viewName`, the SECOND door into the same `listViews`
// namespace the #2554 rules above guard.
// ─────────────────────────────────────────────────────────────────────────────

/** Distinct configs so the expander does not dedupe the default `list` into a
* structurally identical `listViews` entry — the fixture needs BOTH so the
* default's real key is observable. */
const navListView = (object: string, label: string, column: string) => ({
type: 'grid',
label,
columns: [column],
data: { provider: 'object', object },
});

const NAV_OBJECT = {
name: 'duly_task',
list: navListView('duly_task', 'All tasks', 'title'),
listViews: {
schedule: navListView('duly_task', 'Schedule', 'due_at'),
board: navListView('duly_task', 'Board', 'status'),
},
formViews: { edit: formView('duly_task') },
};

const navStack = (nav: Record<string, unknown>, appExtra: Record<string, unknown> = {}) => ({
objects: [NAV_OBJECT],
apps: [{ name: 'duly', label: 'Duly', navigation: [nav], ...appExtra }],
});

const navFindings = (stack: Record<string, unknown>) =>
lintViewRefs(stack).filter((f) => f.rule === VIEW_REF_NAV_VIEW_MISSING);

describe('lintViewRefs — navigation viewName resolution (#14108)', () => {
it('errors when a nav viewName names no list view on its object (the measured repro)', () => {
const out = navFindings(
navStack({ id: 'nav_schedule', type: 'object', objectName: 'duly_task', viewName: 'A4_no_such_view', label: 'Schedule' }),
);
expect(out).toHaveLength(1);
expect(out[0].severity).toBe('error');
expect(out[0].where).toBe("app 'duly' · nav 'nav_schedule'");
// The available list views are listed the way the platform's other
// unknown-name findings list theirs — short (authorable) keys, not
// expanded `<object>.<key>` ids.
expect(out[0].message).toContain('board, default, schedule');
expect(out[0].message).not.toContain('duly_task.schedule');
});

it('suggests the near-miss name a rename left behind', () => {
const out = navFindings(
navStack({ id: 'n', type: 'object', objectName: 'duly_task', viewName: 'schedul', label: 'Schedule' }),
);
expect(out[0].hint).toContain('Did you mean "schedule"?');
});

it('accepts a viewName that names a declared listViews key', () => {
expect(navFindings(navStack({ id: 'n', type: 'object', objectName: 'duly_task', viewName: 'schedule', label: 'S' }))).toEqual([]);
});

it("accepts the default `list`'s real expansion key — which is `default`, not `all`", () => {
// The schema documents viewName as 'Defaults to "all"'. That describes the
// CONVENTION of declaring a `listViews.all`, not a magic fallback name:
// `expandViewContainer` keys a bare default `list` as `<object>.default`,
// and objectui's `resolveViewId` has no special case for 'all' either.
expect(navFindings(navStack({ id: 'n', type: 'object', objectName: 'duly_task', viewName: 'default', label: 'D' }))).toEqual([]);
const undeclaredAll = navFindings(
navStack({ id: 'n', type: 'object', objectName: 'duly_task', viewName: 'all', label: 'A' }),
);
expect(undeclaredAll).toHaveLength(1);
});

it("accepts 'all' once the object actually declares it (the app-crm convention)", () => {
const stack = {
objects: [{ ...NAV_OBJECT, listViews: { ...NAV_OBJECT.listViews, all: navListView('duly_task', 'All', 'title') } }],
apps: [{ name: 'duly', navigation: [{ id: 'n', type: 'object', objectName: 'duly_task', viewName: 'all', label: 'A' }] }],
};
expect(navFindings(stack)).toEqual([]);
});

it('accepts a FULLY QUALIFIED viewName, exactly as the runtime matcher does', () => {
// objectui's `resolveViewId` accepts `<object>.<key>` as well as the short
// key. A lint stricter than the matcher would red a name that works.
expect(
navFindings(navStack({ id: 'n', type: 'object', objectName: 'duly_task', viewName: 'duly_task.schedule', label: 'S' })),
).toEqual([]);
});

it('resolves against an independent (already-expanded) top-level ViewItem', () => {
const stack = {
objects: [{ name: 'duly_task' }],
views: [{ name: 'duly_task.mine', object: 'duly_task', viewKind: 'list', ...navListView('duly_task', 'Mine', 'title') }],
apps: [{ name: 'duly', navigation: [{ id: 'n', type: 'object', objectName: 'duly_task', viewName: 'mine', label: 'M' }] }],
};
expect(navFindings(stack)).toEqual([]);
});

it('names the form-view case explicitly rather than reporting a bare miss', () => {
const out = navFindings(navStack({ id: 'n', type: 'object', objectName: 'duly_task', viewName: 'edit', label: 'E' }));
expect(out).toHaveLength(1);
expect(out[0].message).toContain('resolves to a FORM view');
expect(out[0].hint).toContain("type:'form' action target");
});

it('recurses into `group` children AND into an `object` item’s own children', () => {
const stack = {
objects: [NAV_OBJECT],
apps: [{
name: 'duly',
navigation: [{
id: 'grp', type: 'group', label: 'Work',
children: [{
id: 'parent', type: 'object', objectName: 'duly_task', viewName: 'schedule', label: 'Tasks',
children: [{ id: 'deep', type: 'object', objectName: 'duly_task', viewName: 'A4_no_such_view', label: 'Deep' }],
}],
}],
}],
};
const out = navFindings(stack);
expect(out).toHaveLength(1);
expect(out[0].where).toContain("nav 'deep'");
});

it('walks the `areas[]` nav container too, not only `navigation`', () => {
const bad = { id: 'in_area', type: 'object', objectName: 'duly_task', viewName: 'A4_no_such_view', label: 'X' };
for (const area of [{ name: 'a', items: [bad] }, { name: 'a', navigation: [bad] }]) {
const out = navFindings({ objects: [NAV_OBJECT], apps: [{ name: 'duly', areas: [area] }] });
expect(out).toHaveLength(1);
expect(out[0].where).toContain("nav 'in_area'");
}
});

it('reports each distinct nav entry once', () => {
const stack = {
objects: [NAV_OBJECT],
apps: [{
name: 'duly',
navigation: [
{ id: 'a', type: 'object', objectName: 'duly_task', viewName: 'A4_no_such_view', label: 'A' },
{ id: 'b', type: 'object', objectName: 'duly_task', viewName: 'A4_no_such_view', label: 'B' },
],
}],
};
expect(navFindings(stack).map((f) => f.where)).toEqual([
"app 'duly' · nav 'a'",
"app 'duly' · nav 'b'",
]);
});
});

describe('lintViewRefs — navigation viewName exemptions (false positives stay near zero)', () => {
const bogus = 'A4_no_such_view';

it('skips an interpolated viewName (resolved at render time)', () => {
expect(navFindings(navStack({ id: 'n', type: 'object', objectName: 'duly_task', viewName: '${params.view}', label: 'X' }))).toEqual([]);
});

it('skips an entry carrying `requiresObject` — another package provides the object', () => {
expect(
navFindings(navStack({ id: 'n', type: 'object', objectName: 'duly_task', viewName: bogus, requiresObject: 'duly_task', label: 'X' })),
).toEqual([]);
});

it('skips when `recordId` is set — the schema documents viewName as ignored there', () => {
expect(
navFindings(navStack({ id: 'n', type: 'object', objectName: 'duly_task', viewName: bogus, recordId: '{current_user_id}', label: 'X' })),
).toEqual([]);
});

it('says nothing about an object this stack declares no list views for', () => {
// Indistinguishable from a cross-package object, so the rule stays silent
// rather than guessing — the precondition that lets it be an ERROR at all.
const stack = {
objects: [{ name: 'other_object' }],
apps: [{ name: 'duly', navigation: [{ id: 'n', type: 'object', objectName: 'not_here', viewName: bogus, label: 'X' }] }],
};
expect(navFindings(stack)).toEqual([]);
});

it('says nothing when the nav entry names no view at all', () => {
expect(navFindings(navStack({ id: 'n', type: 'object', objectName: 'duly_task', label: 'X' }))).toEqual([]);
});

it('leaves the repo’s own shipped nav shapes alone (no error on a resolvable stack)', () => {
const stack = {
objects: [NAV_OBJECT],
apps: [{
name: 'duly',
navigation: [
{ id: 'a', type: 'object', objectName: 'duly_task', viewName: 'schedule', label: 'S', icon: 'calendar' },
{ id: 'b', type: 'object', objectName: 'duly_task', label: 'Default landing' },
{ id: 'c', type: 'page', pageName: 'pricing', label: 'Pricing' },
{ id: 'd', type: 'url', url: 'https://example.com', label: 'Docs' },
],
}],
};
expect(navFindings(stack)).toEqual([]);
});
});

/**
* The card's binding acceptance criterion, pinned end-to-end rather than
* inferred from the registry entry (the #14148 / #14107 precedent): the
* measured repro must fail `validate` AND `build`. The card measured
* `os validate --json` returning `valid: true` and `os build` green, so a
* validate-only fix was not acceptable — and nothing else in this file would
* notice if the suite entry's `commands` were narrowed later.
*/
describe('#14108 acceptance — a nav viewName miss gates `validate` AND `build`', () => {
const repro = navStack({
id: 'nav_schedule', type: 'object', objectName: 'duly_task',
viewName: 'A4_no_such_view', label: 'Schedule', icon: 'gantt-chart',
});
const clean = navStack({
id: 'nav_schedule', type: 'object', objectName: 'duly_task',
viewName: 'schedule', label: 'Schedule', icon: 'gantt-chart',
});

for (const command of ['validate', 'build'] as const) {
it(`the measured repro fails \`${command}\``, () => {
const { errors } = splitBySeverity(runAuthoringRules(command, { normalized: repro as never }));
expect(errors.map((f) => f.rule)).toContain(VIEW_REF_NAV_VIEW_MISSING);
});

it(`the corrected nav entry passes \`${command}\``, () => {
const { errors, advisories } = splitBySeverity(runAuthoringRules(command, { normalized: clean as never }));
expect([...errors, ...advisories].filter((f) => f.rule === VIEW_REF_NAV_VIEW_MISSING)).toEqual([]);
});
}
});
Loading
Loading