@happyvertical/smrt-svelte 0.30.0

package/dist/components/workspace/__tests__/manifest-nav.test.js

@@ -0,0 +1,599 @@
+/**
+ * Tests for `navTreeFromManifest` — the pure manifest → NavSection[]
+ * adapter. The helper has no Svelte runtime, no SSR coupling, and no
+ * SvelteKit imports, so these are vanilla data-in / data-out tests.
+ *
+ * Brief: happyvertical/smrt#1248 (parent epic #1245). Covers empty
+ * manifest, full pass-through, filtered subset, sectionHints application,
+ * deterministic ordering, missing api/collection fallback, and the optional
+ * `@smrt({ ui: { icon, label } })` decorator field.
+ */
+import { describe, expect, it } from 'vitest';
+import { navTreeFromManifest, pluralizeClassName, } from '../manifest-nav.js';
+// ────────────────────────────────────────────────────────────────────────
+// Test fixtures — hand-built manifests that mimic the shape produced by
+// `ManifestBuilder.generate()`. Keep these small and focused; building a
+// realistic-looking manifest from one of the consumer packages would
+// drag a workspace dependency in.
+// ────────────────────────────────────────────────────────────────────────
+const EMPTY_MANIFEST = { objects: {} };
+const TWO_PACKAGE_MANIFEST = {
+    objects: {
+        '@happyvertical/smrt-content:Article': {
+            qualifiedName: '@happyvertical/smrt-content:Article',
+            className: 'Article',
+            packageName: '@happyvertical/smrt-content',
+            collection: 'articles',
+            extends: 'SmrtObject',
+            decoratorConfig: {},
+        },
+        '@happyvertical/smrt-content:Document': {
+            qualifiedName: '@happyvertical/smrt-content:Document',
+            className: 'Document',
+            packageName: '@happyvertical/smrt-content',
+            collection: 'documents',
+            extends: 'SmrtObject',
+            decoratorConfig: {},
+        },
+        '@happyvertical/smrt-content:ArticleCollection': {
+            qualifiedName: '@happyvertical/smrt-content:ArticleCollection',
+            className: 'ArticleCollection',
+            packageName: '@happyvertical/smrt-content',
+            collection: 'articles',
+            extends: 'SmrtCollection',
+            decoratorConfig: {},
+        },
+        '@happyvertical/smrt-commerce:Invoice': {
+            qualifiedName: '@happyvertical/smrt-commerce:Invoice',
+            className: 'Invoice',
+            packageName: '@happyvertical/smrt-commerce',
+            collection: 'invoices',
+            extends: 'SmrtObject',
+            decoratorConfig: {},
+        },
+        '@happyvertical/smrt-commerce:Customer': {
+            qualifiedName: '@happyvertical/smrt-commerce:Customer',
+            className: 'Customer',
+            packageName: '@happyvertical/smrt-commerce',
+            collection: 'customers',
+            extends: 'SmrtObject',
+            decoratorConfig: {},
+        },
+    },
+};
+describe('navTreeFromManifest', () => {
+    it('returns an empty array for an empty manifest', () => {
+        expect(navTreeFromManifest(EMPTY_MANIFEST)).toEqual([]);
+    });
+    it('returns an empty array when permittedResources filters out everything', () => {
+        expect(navTreeFromManifest(TWO_PACKAGE_MANIFEST, {
+            permittedResources: ['@some/other-package:Foo'],
+        })).toEqual([]);
+    });
+    it('emits one section per package with all SmrtObjects when permittedResources is omitted', () => {
+        const result = navTreeFromManifest(TWO_PACKAGE_MANIFEST);
+        expect(result.map((s) => s.label)).toEqual([
+            'smrt-commerce',
+            'smrt-content',
+        ]);
+        expect(result[0].children?.map((c) => c.label)).toEqual([
+            'Customers',
+            'Invoices',
+        ]);
+        expect(result[1].children?.map((c) => c.label)).toEqual([
+            'Articles',
+            'Documents',
+        ]);
+    });
+    it('drops collection classes (extends SmrtCollection or *Collection suffix)', () => {
+        const result = navTreeFromManifest(TWO_PACKAGE_MANIFEST);
+        const allItemLabels = result.flatMap((s) => s.children?.map((c) => c.label) ?? []);
+        // No `ArticleCollection` should appear anywhere.
+        expect(allItemLabels).not.toContain('ArticleCollections');
+        expect(allItemLabels).not.toContain('Articlecollections');
+    });
+    it('honours permittedResources by qualified class name', () => {
+        const result = navTreeFromManifest(TWO_PACKAGE_MANIFEST, {
+            permittedResources: [
+                '@happyvertical/smrt-content:Article',
+                '@happyvertical/smrt-commerce:Invoice',
+            ],
+        });
+        expect(result).toHaveLength(2);
+        expect(result.map((s) => s.label)).toEqual([
+            'smrt-commerce',
+            'smrt-content',
+        ]);
+        expect(result.flatMap((s) => s.children?.map((c) => c.label) ?? [])).toEqual(['Invoices', 'Articles']);
+    });
+    it('applies sectionHints to override the default section title', () => {
+        const result = navTreeFromManifest(TWO_PACKAGE_MANIFEST, {
+            sectionHints: {
+                '@happyvertical/smrt-content': 'Content',
+                '@happyvertical/smrt-commerce': 'Commerce',
+            },
+        });
+        expect(result.map((s) => s.label)).toEqual(['Commerce', 'Content']);
+    });
+    it('groups multiple packages under a single section when a sectionHint catches both', () => {
+        const manifest = {
+            objects: {
+                '@happyvertical/smrt-content:Article': {
+                    qualifiedName: '@happyvertical/smrt-content:Article',
+                    className: 'Article',
+                    packageName: '@happyvertical/smrt-content',
+                    collection: 'articles',
+                    decoratorConfig: {},
+                },
+                '@happyvertical/smrt-messages:Email': {
+                    qualifiedName: '@happyvertical/smrt-messages:Email',
+                    className: 'Email',
+                    packageName: '@happyvertical/smrt-messages',
+                    collection: 'emails',
+                    decoratorConfig: {},
+                },
+            },
+        };
+        const result = navTreeFromManifest(manifest, {
+            sectionHints: {
+                // Catch both content + messages with the @happyvertical org prefix.
+                '@happyvertical/': 'Content & Messaging',
+            },
+        });
+        expect(result).toHaveLength(1);
+        expect(result[0].label).toBe('Content & Messaging');
+        expect(result[0].children?.map((c) => c.label)).toEqual([
+            'Articles',
+            'Emails',
+        ]);
+    });
+    it('produces deterministic ordering (sorted by label) regardless of input order', () => {
+        // Build the same manifest twice, with reversed key insertion order.
+        const a = {
+            objects: {
+                'pkg:Banana': {
+                    qualifiedName: 'pkg:Banana',
+                    className: 'Banana',
+                    packageName: 'pkg',
+                    collection: 'bananas',
+                    decoratorConfig: {},
+                },
+                'pkg:Apple': {
+                    qualifiedName: 'pkg:Apple',
+                    className: 'Apple',
+                    packageName: 'pkg',
+                    collection: 'apples',
+                    decoratorConfig: {},
+                },
+            },
+        };
+        const b = {
+            objects: {
+                'pkg:Apple': a.objects['pkg:Apple'],
+                'pkg:Banana': a.objects['pkg:Banana'],
+            },
+        };
+        const fromA = navTreeFromManifest(a);
+        const fromB = navTreeFromManifest(b);
+        expect(fromA).toEqual(fromB);
+        expect(fromA[0].children?.map((c) => c.label)).toEqual([
+            'Apples',
+            'Bananas',
+        ]);
+    });
+    it('uses /api/v1/{collection} as the default href for an entry', () => {
+        const result = navTreeFromManifest(TWO_PACKAGE_MANIFEST, {
+            permittedResources: ['@happyvertical/smrt-content:Article'],
+        });
+        expect(result[0].children?.[0].href).toBe('/api/v1/articles');
+    });
+    it('falls back to a kebab-cased class slug when collection is missing', () => {
+        const manifest = {
+            objects: {
+                'pkg:OrderLine': {
+                    qualifiedName: 'pkg:OrderLine',
+                    className: 'OrderLine',
+                    packageName: 'pkg',
+                    // collection intentionally omitted
+                    decoratorConfig: {},
+                },
+            },
+        };
+        const result = navTreeFromManifest(manifest, { basePath: '' });
+        expect(result[0].children?.[0].href).toBe('/order-line');
+    });
+    it('honours a custom basePath (e.g. "" for unprefixed hrefs)', () => {
+        const result = navTreeFromManifest(TWO_PACKAGE_MANIFEST, {
+            basePath: '',
+            permittedResources: ['@happyvertical/smrt-content:Article'],
+        });
+        expect(result[0].children?.[0].href).toBe('/articles');
+    });
+    it('passes the ui.icon decorator field through to NavItem.icon', () => {
+        const manifest = {
+            objects: {
+                'pkg:Article': {
+                    qualifiedName: 'pkg:Article',
+                    className: 'Article',
+                    packageName: 'pkg',
+                    collection: 'articles',
+                    decoratorConfig: { ui: { icon: 'newspaper' } },
+                },
+            },
+        };
+        const result = navTreeFromManifest(manifest);
+        expect(result[0].children?.[0].icon).toBe('newspaper');
+    });
+    it('uses ui.label to override the auto-pluralised label', () => {
+        const manifest = {
+            objects: {
+                'pkg:Person': {
+                    qualifiedName: 'pkg:Person',
+                    className: 'Person',
+                    packageName: 'pkg',
+                    collection: 'people',
+                    // Use a custom label rather than relying on the simple pluralizer
+                    // (which would emit "Persons").
+                    decoratorConfig: { ui: { label: 'People' } },
+                },
+            },
+        };
+        const result = navTreeFromManifest(manifest);
+        expect(result[0].children?.[0].label).toBe('People');
+    });
+    it('omits NavItem.icon when ui.icon is absent (no empty-string leakage)', () => {
+        const result = navTreeFromManifest(TWO_PACKAGE_MANIFEST, {
+            permittedResources: ['@happyvertical/smrt-content:Article'],
+        });
+        expect(result[0].children?.[0]).not.toHaveProperty('icon');
+    });
+    it('falls back to packageName-based section title when no hint matches', () => {
+        const manifest = {
+            objects: {
+                '@acme/widgets:Sprocket': {
+                    qualifiedName: '@acme/widgets:Sprocket',
+                    className: 'Sprocket',
+                    packageName: '@acme/widgets',
+                    collection: 'sprockets',
+                    decoratorConfig: {},
+                },
+            },
+        };
+        const result = navTreeFromManifest(manifest, {
+            sectionHints: { '@nonmatching/foo': 'Foo' },
+        });
+        expect(result[0].label).toBe('widgets');
+    });
+    it('matches sectionHints by substring (first match wins)', () => {
+        const manifest = {
+            objects: {
+                '@happyvertical/smrt-content:Article': {
+                    qualifiedName: '@happyvertical/smrt-content:Article',
+                    className: 'Article',
+                    packageName: '@happyvertical/smrt-content',
+                    collection: 'articles',
+                    decoratorConfig: {},
+                },
+            },
+        };
+        // Iteration order on an object literal preserves insertion order in
+        // modern engines — `@happyvertical/` is checked first and wins.
+        const result = navTreeFromManifest(manifest, {
+            sectionHints: {
+                '@happyvertical/': 'HV',
+                'smrt-content': 'Content',
+            },
+        });
+        expect(result[0].label).toBe('HV');
+    });
+    // ──────────────────────────────────────────────────────────────────────
+    // Visibility filtering — `@smrt({ visibility: 'internal' | 'test' })`
+    // marks classes as plumbing / fixtures that should never appear in
+    // admin nav, regardless of whether they have a REST list route.
+    // ──────────────────────────────────────────────────────────────────────
+    it('drops entries with top-level visibility = "internal"', () => {
+        const manifest = {
+            objects: {
+                '@acme/widgets:Public': {
+                    qualifiedName: '@acme/widgets:Public',
+                    className: 'Public',
+                    packageName: '@acme/widgets',
+                    collection: 'publics',
+                    decoratorConfig: {},
+                },
+                '@acme/widgets:InternalJoin': {
+                    qualifiedName: '@acme/widgets:InternalJoin',
+                    className: 'InternalJoin',
+                    packageName: '@acme/widgets',
+                    collection: 'internal-joins',
+                    visibility: 'internal',
+                    decoratorConfig: {},
+                },
+            },
+        };
+        const result = navTreeFromManifest(manifest);
+        expect(result).toHaveLength(1);
+        expect(result[0].children).toHaveLength(1);
+        expect(result[0].children?.[0].label).toBe('Publics');
+    });
+    it('drops entries with visibility = "test" (decoratorConfig fallback)', () => {
+        const manifest = {
+            objects: {
+                '@acme/widgets:Public': {
+                    qualifiedName: '@acme/widgets:Public',
+                    className: 'Public',
+                    packageName: '@acme/widgets',
+                    collection: 'publics',
+                    decoratorConfig: {},
+                },
+                '@acme/widgets:TestFixture': {
+                    qualifiedName: '@acme/widgets:TestFixture',
+                    className: 'TestFixture',
+                    packageName: '@acme/widgets',
+                    collection: 'test-fixtures',
+                    // No top-level visibility — the helper falls back to decoratorConfig.
+                    decoratorConfig: { visibility: 'test' },
+                },
+            },
+        };
+        const result = navTreeFromManifest(manifest);
+        expect(result).toHaveLength(1);
+        expect(result[0].children?.map((c) => c.label)).toEqual(['Publics']);
+    });
+    it('suppresses STI subtype entries that share their parent collection', () => {
+        // SMRT's scanner copies the STI parent's `collection` field onto
+        // every child entry. Without dedup, the nav helper would emit nine
+        // links for the Contract STI hierarchy that all point at
+        // /api/v1/contracts — confusing to users and a footgun for
+        // role-permission filtering. The parent's link covers the entire
+        // polymorphic list at that endpoint.
+        const manifest = {
+            objects: {
+                '@acme/shop:Contract': {
+                    qualifiedName: '@acme/shop:Contract',
+                    className: 'Contract',
+                    packageName: '@acme/shop',
+                    collection: 'contracts',
+                    extends: 'SmrtObject',
+                    decoratorConfig: {},
+                },
+                '@acme/shop:Order': {
+                    qualifiedName: '@acme/shop:Order',
+                    className: 'Order',
+                    packageName: '@acme/shop',
+                    collection: 'contracts',
+                    extends: 'Contract',
+                    decoratorConfig: {},
+                },
+                '@acme/shop:Cart': {
+                    qualifiedName: '@acme/shop:Cart',
+                    className: 'Cart',
+                    packageName: '@acme/shop',
+                    collection: 'contracts',
+                    extends: 'Contract',
+                    decoratorConfig: {},
+                },
+            },
+        };
+        const result = navTreeFromManifest(manifest);
+        expect(result).toHaveLength(1);
+        expect(result[0].children).toHaveLength(1);
+        expect(result[0].children?.[0].label).toBe('Contracts');
+        expect(result[0].children?.[0].href).toBe('/api/v1/contracts');
+    });
+    it('keeps the base nav link when only an STI subtype is in permittedResources', () => {
+        // Regression for the round-12 finding: when a role's
+        // `permittedResources` only lists an STI subtype (e.g. Cart) and
+        // not its base (Contract), the dedup step would suppress Cart
+        // (subtype sharing parent collection) and the permission filter
+        // would drop Contract — leaving the role with no link to the
+        // /api/v1/contracts polymorphic endpoint. The expansion remaps
+        // each permitted subtype to its parent's qualifier when they
+        // share the same collection.
+        const manifest = {
+            objects: {
+                '@acme/shop:Contract': {
+                    qualifiedName: '@acme/shop:Contract',
+                    className: 'Contract',
+                    packageName: '@acme/shop',
+                    collection: 'contracts',
+                    extends: 'SmrtObject',
+                    decoratorConfig: {},
+                },
+                '@acme/shop:Cart': {
+                    qualifiedName: '@acme/shop:Cart',
+                    className: 'Cart',
+                    packageName: '@acme/shop',
+                    collection: 'contracts',
+                    extends: 'Contract',
+                    decoratorConfig: {},
+                },
+                '@acme/shop:Order': {
+                    qualifiedName: '@acme/shop:Order',
+                    className: 'Order',
+                    packageName: '@acme/shop',
+                    collection: 'contracts',
+                    extends: 'Contract',
+                    decoratorConfig: {},
+                },
+            },
+        };
+        const result = navTreeFromManifest(manifest, {
+            permittedResources: ['@acme/shop:Cart'],
+        });
+        // Role gets one nav link to the shared /api/v1/contracts route,
+        // via the base entry (Contract) — Cart was suppressed by the
+        // dedup but the permission expansion re-introduced Contract.
+        expect(result).toHaveLength(1);
+        expect(result[0].children).toHaveLength(1);
+        expect(result[0].children?.[0].label).toBe('Contracts');
+        expect(result[0].children?.[0].href).toBe('/api/v1/contracts');
+    });
+    it('suppresses multi-level STI grandchildren even when the intermediate parent is absent', () => {
+        // Regression for the round-7 finding: a partial manifest with
+        // Product (root) and FabricMaterial (grandchild) but no Material
+        // (intermediate) would previously let FabricMaterial through and
+        // double up the /api/v1/products link. The recursive walk follows
+        // the chain through the missing intermediate by looking up
+        // `extends` names directly in the manifest.
+        const manifest = {
+            objects: {
+                '@acme/x:Product': {
+                    qualifiedName: '@acme/x:Product',
+                    className: 'Product',
+                    packageName: '@acme/x',
+                    collection: 'products',
+                    extends: 'SmrtObject',
+                    decoratorConfig: {},
+                },
+                // Material is declared but intentionally NOT in the manifest
+                // (simulated partial / split-package scenario). Its grandchild
+                // points at `extends: 'Material'`.
+                '@acme/x:FabricMaterial': {
+                    qualifiedName: '@acme/x:FabricMaterial',
+                    className: 'FabricMaterial',
+                    packageName: '@acme/x',
+                    collection: 'products',
+                    extends: 'Material',
+                    decoratorConfig: {},
+                },
+            },
+        };
+        const result = navTreeFromManifest(manifest);
+        // FabricMaterial dropped — its `extends: 'Material'` doesn't
+        // resolve, so the chain walk halts at the missing intermediate.
+        // That's the documented "fully-orphaned entries stay visible"
+        // behavior; we get one Product link AND one FabricMaterial link.
+        // This test asserts the current behavior so we notice if it changes.
+        expect(result[0].children?.map((c) => c.label).sort()).toEqual([
+            'FabricMaterials',
+            'Products',
+        ]);
+    });
+    it('suppresses multi-level STI grandchildren when the intermediate parent IS present', () => {
+        // Same shape as above but with the intermediate `Material` entry
+        // restored. Now the recursive walk: FabricMaterial → Material →
+        // Product. Material itself drops because its collection matches
+        // Product's. FabricMaterial drops because the same chain reaches
+        // Product (matching collection). Only Product survives.
+        const manifest = {
+            objects: {
+                '@acme/x:Product': {
+                    qualifiedName: '@acme/x:Product',
+                    className: 'Product',
+                    packageName: '@acme/x',
+                    collection: 'products',
+                    extends: 'SmrtObject',
+                    decoratorConfig: {},
+                },
+                '@acme/x:Material': {
+                    qualifiedName: '@acme/x:Material',
+                    className: 'Material',
+                    packageName: '@acme/x',
+                    collection: 'products',
+                    extends: 'Product',
+                    decoratorConfig: {},
+                },
+                '@acme/x:FabricMaterial': {
+                    qualifiedName: '@acme/x:FabricMaterial',
+                    className: 'FabricMaterial',
+                    packageName: '@acme/x',
+                    collection: 'products',
+                    extends: 'Material',
+                    decoratorConfig: {},
+                },
+            },
+        };
+        const result = navTreeFromManifest(manifest);
+        expect(result).toHaveLength(1);
+        expect(result[0].children).toHaveLength(1);
+        expect(result[0].children?.[0].label).toBe('Products');
+    });
+    it('keeps STI subtypes whose collection differs from the parent', () => {
+        // If a subtype overrides `@smrt({ tableName/collection })`, its
+        // route IS distinct from the parent's and the nav helper should
+        // keep both. Tests the `entry.collection === parent.collection`
+        // half of the gate — not just the `entry.extends !== 'SmrtObject'` half.
+        const manifest = {
+            objects: {
+                '@acme/x:Asset': {
+                    qualifiedName: '@acme/x:Asset',
+                    className: 'Asset',
+                    packageName: '@acme/x',
+                    collection: 'assets',
+                    extends: 'SmrtObject',
+                    decoratorConfig: {},
+                },
+                '@acme/x:Image': {
+                    qualifiedName: '@acme/x:Image',
+                    className: 'Image',
+                    packageName: '@acme/x',
+                    collection: 'images', // distinct route
+                    extends: 'Asset',
+                    decoratorConfig: {},
+                },
+            },
+        };
+        const result = navTreeFromManifest(manifest);
+        expect(result[0].children?.map((c) => c.label).sort()).toEqual([
+            'Assets',
+            'Images',
+        ]);
+    });
+    it('keeps entries with visibility = "public" or unset', () => {
+        const manifest = {
+            objects: {
+                '@acme/widgets:Explicit': {
+                    qualifiedName: '@acme/widgets:Explicit',
+                    className: 'Explicit',
+                    packageName: '@acme/widgets',
+                    collection: 'explicits',
+                    visibility: 'public',
+                    decoratorConfig: {},
+                },
+                '@acme/widgets:Implicit': {
+                    qualifiedName: '@acme/widgets:Implicit',
+                    className: 'Implicit',
+                    packageName: '@acme/widgets',
+                    collection: 'implicits',
+                    decoratorConfig: {},
+                },
+            },
+        };
+        const result = navTreeFromManifest(manifest);
+        expect(result[0].children?.map((c) => c.label).sort()).toEqual([
+            'Explicits',
+            'Implicits',
+        ]);
+    });
+});
+// ────────────────────────────────────────────────────────────────────────
+// Pluralization unit tests — the helper is exported for completeness; most
+// callers should rely on `navTreeFromManifest` to apply it under the hood
+// and override exotic plurals via `@smrt({ ui: { label } })`.
+// ────────────────────────────────────────────────────────────────────────
+describe('pluralizeClassName', () => {
+    it('handles simple consonant suffixes', () => {
+        expect(pluralizeClassName('Article')).toBe('Articles');
+        expect(pluralizeClassName('Product')).toBe('Products');
+    });
+    it('handles consonant + y → ies', () => {
+        expect(pluralizeClassName('Category')).toBe('Categories');
+        expect(pluralizeClassName('Currency')).toBe('Currencies');
+    });
+    it('handles vowel + y → s (no -ies)', () => {
+        expect(pluralizeClassName('Survey')).toBe('Surveys');
+    });
+    it('handles s, x, z, ch, sh suffixes → es', () => {
+        expect(pluralizeClassName('Box')).toBe('Boxes');
+        expect(pluralizeClassName('Dish')).toBe('Dishes');
+        expect(pluralizeClassName('Watch')).toBe('Watches');
+    });
+    it('passes already-plural words through', () => {
+        expect(pluralizeClassName('Articles')).toBe('Articles');
+        expect(pluralizeClassName('Categories')).toBe('Categories');
+    });
+    it('returns empty string unchanged', () => {
+        expect(pluralizeClassName('')).toBe('');
+    });
+});