Skip to content

SD-2508 - fix: toc not being displayed inside w:sdt #2850

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
chittolinag wants to merge 3 commits into
base: main
Choose a base branch
from
Open

SD-2508 - fix: toc not being displayed inside w:sdt #2850

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
9422167
fix: toc not being displayed inside w:sdt
chittolina Apr 16, 2026
9dd9eab
Merge branch 'main' into gabriel/sd-2508-bug-docpartobj-sdt-handler-d…
chittolinag Apr 16, 2026
ad510e0
refactor: simplified code
chittolina Apr 16, 2026
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
28 changes: 28 additions & 0 deletions packages/layout-engine/pm-adapter/src/sdt/document-part-object.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -438,6 +438,34 @@ describe('document-part-object', () => {
});
});

// ==================== Table Children Tests ====================
describe('Table children', () => {
it('should process tableOfContents children for non-"Table of Contents" gallery types (e.g. "Custom Table of Contents")', () => {
const tocNode: PMNode = {
type: 'tableOfContents',
content: [{ type: 'paragraph', content: [] }],
attrs: { instruction: 'TOC \\o "1-3"' },
};
const node: PMNode = {
type: 'documentPartObject',
content: [tocNode],
attrs: { docPartGallery: 'Custom Table of Contents' },
};

vi.mocked(metadataModule.getDocPartGallery).mockReturnValue('Custom Table of Contents');
vi.mocked(metadataModule.getDocPartObjectId).mockReturnValue('toc-1');
vi.mocked(metadataModule.getNodeInstruction).mockReturnValue(undefined);
vi.mocked(metadataModule.resolveNodeSdtMetadata).mockReturnValue(undefined as never);

handleDocumentPartObjectNode(node, mockContext);

expect(tocModule.processTocChildren).toHaveBeenCalledOnce();
const callArgs = vi.mocked(tocModule.processTocChildren).mock.calls[0];
expect(callArgs[0]).toEqual(tocNode.content);
expect(callArgs[1]).toMatchObject({ docPartGallery: 'Custom Table of Contents' });
});
});

// ==================== Edge Cases ====================
describe('Edge cases', () => {
it('should handle docPartGallery with different case sensitivity', () => {
Expand Down
18 changes: 18 additions & 0 deletions packages/layout-engine/pm-adapter/src/sdt/document-part-object.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -75,6 +75,24 @@ export function handleDocumentPartObjectNode(node: PMNode, context: NodeHandlerC
blocks.push(block);
recordBlockKind?.(block.kind);
}
} else if (child.type === 'tableOfContents' && Array.isArray(child.content)) {
// A nested tableOfContents node (e.g. from a "Custom Table of Contents" SDT where
// the TOC field codes were preprocessed into an sd:tableOfContents element)
processTocChildren(
child.content,
{ docPartGallery: docPartGallery ?? '', docPartObjectId, tocInstruction, sdtMetadata: docPartSdtMetadata },
Comment on lines +82 to +83
Copy link
Copy Markdown

@chatgpt-codex-connector chatgpt-codex-connector bot Apr 16, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2 Badge Preserve nested TOC instruction when forwarding child nodes

The new non-"Table of Contents" branch calls processTocChildren with child.content instead of the tableOfContents node itself, which drops the nested node context where processTocChildren reads getNodeInstruction(child) (toc.ts). In documents where a custom gallery stores the TOC field code on the nested tableOfContents node (the case this patch targets), tocInstruction now stays undefined and paragraph TOC metadata is incomplete, so downstream TOC behavior can differ from the standard gallery path.

Useful? React with 👍 / 👎.

{
nextBlockId,
positions,
bookmarks,
hyperlinkConfig,
enableComments,
trackedChangesConfig,
converters,
converterContext,
},
{ blocks, recordBlockKind },
);
}
}
}
Expand Down
Loading