|
| 1 | +import assert from 'node:assert/strict' |
| 2 | +import { test } from 'node:test' |
| 3 | +import { getDocsBreadcrumbItems } from '../src/utils/docs-breadcrumbs' |
| 4 | +import { getDocsStructuredData } from '../src/utils/docs-structured-data' |
| 5 | + |
| 6 | +test('visible and schema trails share labels, ordering and canonical destinations', () => { |
| 7 | + for (const canonicalHref of [ |
| 8 | + 'https://tanstack.com/query/latest/docs/framework/react/guides/query-keys', |
| 9 | + 'https://tanstack.com/query/v3/docs/overview', |
| 10 | + ]) { |
| 11 | + const input = { |
| 12 | + doc: { title: 'Query keys <script>' }, |
| 13 | + library: { id: 'query', name: 'TanStack Query' }, |
| 14 | + canonicalHref, |
| 15 | + } |
| 16 | + const items = getDocsBreadcrumbItems(input) |
| 17 | + const schema = getDocsStructuredData(input)?.['@graph'].find( |
| 18 | + (node) => node['@type'] === 'BreadcrumbList', |
| 19 | + ) |
| 20 | + assert.ok(items) |
| 21 | + assert.ok(schema && 'itemListElement' in schema) |
| 22 | + assert.equal(items.length, 3) |
| 23 | + assert.equal(items.at(-1)?.label, input.doc.title) |
| 24 | + assert.equal(items.at(-1)?.to, canonicalHref) |
| 25 | + assert.deepEqual( |
| 26 | + schema.itemListElement, |
| 27 | + items.map((item, index) => ({ |
| 28 | + '@type': 'ListItem', |
| 29 | + position: index + 1, |
| 30 | + name: item.label, |
| 31 | + item: new URL(item.to, canonicalHref).href, |
| 32 | + })), |
| 33 | + ) |
| 34 | + } |
| 35 | +}) |
| 36 | + |
| 37 | +test('hidden, missing and untitled documents have no semantic trail', () => { |
| 38 | + const input = { |
| 39 | + library: { id: 'workflow', name: 'Workflow', visible: false }, |
| 40 | + canonicalHref: 'https://tanstack.com/workflow/latest/docs/overview', |
| 41 | + } |
| 42 | + assert.equal( |
| 43 | + getDocsBreadcrumbItems({ ...input, doc: { title: 'Overview' } }), |
| 44 | + undefined, |
| 45 | + ) |
| 46 | + assert.equal( |
| 47 | + getDocsBreadcrumbItems({ |
| 48 | + ...input, |
| 49 | + library: { ...input.library, visible: true }, |
| 50 | + doc: undefined, |
| 51 | + }), |
| 52 | + undefined, |
| 53 | + ) |
| 54 | + assert.equal( |
| 55 | + getDocsBreadcrumbItems({ |
| 56 | + ...input, |
| 57 | + library: { ...input.library, visible: true }, |
| 58 | + doc: { title: '' }, |
| 59 | + }), |
| 60 | + undefined, |
| 61 | + ) |
| 62 | +}) |
0 commit comments