Skip to content

fix(export): prefix Relationship IDs with rId for valid xsd:ID #1855

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

Merged
harbournick merged 1 commit into from
Jan 27, 2026
Merged

fix(export): prefix Relationship IDs with rId for valid xsd:ID #1855

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
2 changes: 1 addition & 1 deletion ...tor/src/core/super-converter/field-references/fld-preprocessors/hyperlink-preprocessor.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ export function preProcessHyperlinkInstruction(nodesToCombine, instruction, docx
const rels = docx['word/_rels/document.xml.rels'];
const relationships = rels?.elements.find((el) => el.name === 'Relationships');
if (relationships) {
const rId = generateDocxRandomId();
const rId = 'rId' + generateDocxRandomId();
relationships.elements.push({
type: 'element',
name: 'Relationship',
Expand Down
31 changes: 27 additions & 4 deletions ...rc/core/super-converter/field-references/fld-preprocessors/hyperlink-preprocessor.test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ vi.mock('@helpers/generateDocxRandomId.js', () => ({
describe('preProcessHyperlinkInstruction', () => {
beforeEach(() => {
vi.clearAllMocks();
generateDocxRandomId.mockReturnValue('rId123');
generateDocxRandomId.mockReturnValue('abc12345');
});

const mockNodesToCombine = [
Expand All @@ -36,7 +36,7 @@ describe('preProcessHyperlinkInstruction', () => {
{
name: 'w:hyperlink',
type: 'element',
attributes: { 'r:id': 'rId123' },
attributes: { 'r:id': 'rIdabc12345' },
elements: [{ name: 'w:r', elements: [{ name: 'w:t', elements: [{ type: 'text', text: 'link text' }] }] }],
},
]);
Expand All @@ -45,7 +45,7 @@ describe('preProcessHyperlinkInstruction', () => {
type: 'element',
name: 'Relationship',
attributes: {
Id: 'rId123',
Id: 'rIdabc12345',
Type: 'http://schemas.openxmlformats.org/officeDocument/2006/relationships/hyperlink',
Target: 'http://example.com',
TargetMode: 'External',
Expand Down Expand Up @@ -77,7 +77,7 @@ describe('preProcessHyperlinkInstruction', () => {
{
type: 'link',
attrs: {
rId: 'rId123',
rId: 'rIdabc12345',
href: 'http://example.com',
},
},
Expand Down Expand Up @@ -132,6 +132,29 @@ describe('preProcessHyperlinkInstruction', () => {
]);
});

it('should prefix relationship IDs with rId to ensure valid xsd:ID (SD-1661)', () => {
// When generateDocxRandomId returns a hex starting with a digit,
// the ID must still be prefixed with 'rId' to comply with xsd:ID/NCName requirements
generateDocxRandomId.mockReturnValue('0c7b8f2a');

const instruction = 'HYPERLINK "http://example.com"';
const mockDocx = {
'word/_rels/document.xml.rels': {
elements: [{ name: 'Relationships', elements: [] }],
},
};

const result = preProcessHyperlinkInstruction(mockNodesToCombine, instruction, mockDocx);

// The Relationship Id should start with 'rId', not with a digit
const relationshipId = mockDocx['word/_rels/document.xml.rels'].elements[0].elements[0].attributes.Id;
expect(relationshipId).toBe('rId0c7b8f2a');
expect(relationshipId).toMatch(/^[a-zA-Z_]/); // Must start with letter or underscore (NCName rule)

// The hyperlink r:id should match
expect(result[0].attributes['r:id']).toBe('rId0c7b8f2a');
});

it('should handle missing relationships gracefully for URL hyperlinks', () => {
const instruction = 'HYPERLINK "http://example.com"';
const mockDocx = {
Expand Down
6 changes: 3 additions & 3 deletions .../super-editor/src/core/super-converter/field-references/preProcessNodesForFldChar.test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ vi.mock('@helpers/generateDocxRandomId.js', () => ({
describe('preProcessNodesForFldChar', () => {
beforeEach(() => {
vi.clearAllMocks();
generateDocxRandomId.mockReturnValue('rId123');
generateDocxRandomId.mockReturnValue('abc12345');
});

const mockDocx = {
Expand All @@ -35,7 +35,7 @@ describe('preProcessNodesForFldChar', () => {
{
name: 'w:hyperlink',
type: 'element',
attributes: { 'r:id': 'rId123' },
attributes: { 'r:id': 'rIdabc12345' },
elements: [{ name: 'w:r', elements: [{ name: 'w:t', elements: [{ type: 'text', text: 'link text' }] }] }],
},
]);
Expand All @@ -44,7 +44,7 @@ describe('preProcessNodesForFldChar', () => {
type: 'element',
name: 'Relationship',
attributes: {
Id: 'rId123',
Id: 'rIdabc12345',
Type: 'http://schemas.openxmlformats.org/officeDocument/2006/relationships/hyperlink',
Target: 'http://example.com',
TargetMode: 'External',
Expand Down
Loading