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
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@coseeing/see-mark",
"version": "1.3.0",
"version": "1.3.1",
"description": "A markdown parser for a11y",
"main": "./lib/see-mark.cjs",
"files": [
Expand Down
235 changes: 235 additions & 0 deletions src/markdown-processor/markdown-processor-position.test.js
Original file line number Diff line number Diff line change
Expand Up @@ -929,3 +929,238 @@ describe('markdownProcessor - edge cases', () => {
expect(extracted).toBe(markdownContent);
});
});

describe('markdownProcessor - position tracking for all component types', () => {
const options = {
latexDelimiter: 'bracket',
documentFormat: 'inline',
imageFiles: { 'img-id': 'path/to/image.png' },
};

/**
* Helper to verify position for a component
*/
const verifyPosition = (container, componentType) => {
const element = getElementByType(container, componentType);
expect(element).not.toBeNull();

const payload = JSON.parse(
element.getAttribute(SEE_MARK_PAYLOAD_DATA_ATTRIBUTES)
);

expect(payload.position).toBeDefined();
expect(payload.position.start).toBeGreaterThanOrEqual(0);
expect(payload.position.end).toBeGreaterThan(payload.position.start);

return payload;
};

// Link types
it('should include position info in internal link with title payload', () => {
const markdownContent = `[Display][[Title]]<target>`;
const result = markdownProcessor(markdownContent, options);
const container = createDOMFromHTML(result);

const payload = verifyPosition(
container,
SUPPORTED_COMPONENT_TYPES.INTERNAL_LINK_TITLE,
markdownContent
);

const extracted = markdownContent.substring(
payload.position.start,
payload.position.end
);
expect(extracted).toBe('[Display][[Title]]<target>');
});

it('should include position info in external link tab payload', () => {
const markdownContent = `@[Display](https://example.com)`;
const result = markdownProcessor(markdownContent, options);
const container = createDOMFromHTML(result);

const payload = verifyPosition(
container,
SUPPORTED_COMPONENT_TYPES.EXTERNAL_LINK_TAB,
markdownContent
);

const extracted = markdownContent.substring(
payload.position.start,
payload.position.end
);
expect(extracted).toBe('@[Display](https://example.com)');
});

it('should include position info in external link tab with title payload', () => {
const markdownContent = `@[Display][[Title]](https://example.com)`;
const result = markdownProcessor(markdownContent, options);
const container = createDOMFromHTML(result);

const payload = verifyPosition(
container,
SUPPORTED_COMPONENT_TYPES.EXTERNAL_LINK_TAB_TITLE,
markdownContent
);

const extracted = markdownContent.substring(
payload.position.start,
payload.position.end
);
expect(extracted).toBe('@[Display][[Title]](https://example.com)');
});

it('should include position info in external link with title payload', () => {
const markdownContent = `[Display][[Title]](https://example.com)`;
const result = markdownProcessor(markdownContent, options);
const container = createDOMFromHTML(result);

const payload = verifyPosition(
container,
SUPPORTED_COMPONENT_TYPES.EXTERNAL_LINK_TITLE,
markdownContent
);

const extracted = markdownContent.substring(
payload.position.start,
payload.position.end
);
expect(extracted).toBe('[Display][[Title]](https://example.com)');
});

// Image types
it('should include position info in image link payload', () => {
const markdownContent = `![alt](img-id)((https://example.com))`;
const result = markdownProcessor(markdownContent, options);
const container = createDOMFromHTML(result);

const payload = verifyPosition(
container,
SUPPORTED_COMPONENT_TYPES.IMAGE_LINK,
markdownContent
);

const extracted = markdownContent.substring(
payload.position.start,
payload.position.end
);
expect(extracted).toBe('![alt](img-id)((https://example.com))');
});

it('should include position info in image display payload', () => {
const markdownContent = `![alt][[caption]](img-id)`;
const result = markdownProcessor(markdownContent, options);
const container = createDOMFromHTML(result);

const payload = verifyPosition(
container,
SUPPORTED_COMPONENT_TYPES.IMAGE_DISPLAY,
markdownContent
);

const extracted = markdownContent.substring(
payload.position.start,
payload.position.end
);
expect(extracted).toBe('![alt][[caption]](img-id)');
});

it('should include position info in image display link payload', () => {
const markdownContent = `![alt][[caption]](img-id)((https://example.com))`;
const result = markdownProcessor(markdownContent, options);
const container = createDOMFromHTML(result);

const payload = verifyPosition(
container,
SUPPORTED_COMPONENT_TYPES.IMAGE_DISPLAY_LINK,
markdownContent
);

const extracted = markdownContent.substring(
payload.position.start,
payload.position.end
);
expect(extracted).toBe('![alt][[caption]](img-id)((https://example.com))');
});

// Embed types
it('should include position info in iframe payload', () => {
const markdownContent = `@![title](https://example.com/embed)`;
const result = markdownProcessor(markdownContent, options);
const container = createDOMFromHTML(result);

const payload = verifyPosition(
container,
SUPPORTED_COMPONENT_TYPES.IFRAME,
markdownContent
);

const extracted = markdownContent.substring(
payload.position.start,
payload.position.end
);
expect(extracted).toBe('@![title](https://example.com/embed)');
});

it('should include position info in youtube payload', () => {
const markdownContent = `@![video title](https://www.youtube.com/embed/abc123)`;
const result = markdownProcessor(markdownContent, options);
const container = createDOMFromHTML(result);

const payload = verifyPosition(
container,
SUPPORTED_COMPONENT_TYPES.YOUTUBE,
markdownContent
);

const extracted = markdownContent.substring(
payload.position.start,
payload.position.end
);
expect(extracted).toBe(
'@![video title](https://www.youtube.com/embed/abc123)'
);
});

it('should include position info in codepen payload', () => {
const markdownContent = `@![pen title](https://codepen.io/user/embed/abc123)`;
const result = markdownProcessor(markdownContent, options);
const container = createDOMFromHTML(result);

const payload = verifyPosition(
container,
SUPPORTED_COMPONENT_TYPES.CODEPEN,
markdownContent
);

const extracted = markdownContent.substring(
payload.position.start,
payload.position.end
);
expect(extracted).toBe(
'@![pen title](https://codepen.io/user/embed/abc123)'
);
});

// Heading
it('should include position info in heading payload', () => {
const markdownContent = `# Heading text`;
const result = markdownProcessor(markdownContent, {
...options,
documentFormat: 'block',
});
const container = createDOMFromHTML(result);

const payload = verifyPosition(
container,
SUPPORTED_COMPONENT_TYPES.HEADING,
markdownContent
);

const extracted = markdownContent.substring(
payload.position.start,
payload.position.end
);
expect(extracted).toBe('# Heading text');
});
});
Original file line number Diff line number Diff line change
Expand Up @@ -20,4 +20,5 @@ Alert.propTypes = {
internalLinkId: PropTypes.string,
variant: PropTypes.string,
title: PropTypes.string,
position: PropTypes.shape({ start: PropTypes.number, end: PropTypes.number }),
};
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@ const CodePen = ({ title, source }) => {
CodePen.propTypes = {
title: PropTypes.string,
source: PropTypes.string,
position: PropTypes.shape({ start: PropTypes.number, end: PropTypes.number }),
};

export default CodePen;
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ ExternalLinkTabTitle.propTypes = {
display: PropTypes.string,
title: PropTypes.string,
target: PropTypes.string.isRequired,
position: PropTypes.shape({ start: PropTypes.number, end: PropTypes.number }),
};

export default ExternalLinkTabTitle;
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ const ExternalLinkTab = ({ display = '', target = '' }) => {
ExternalLinkTab.propTypes = {
display: PropTypes.string,
target: PropTypes.string.isRequired,
position: PropTypes.shape({ start: PropTypes.number, end: PropTypes.number }),
};

export default ExternalLinkTab;
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ ExternalLinkTitle.propTypes = {
display: PropTypes.string,
title: PropTypes.string,
target: PropTypes.string.isRequired,
position: PropTypes.shape({ start: PropTypes.number, end: PropTypes.number }),
};

export default ExternalLinkTitle;
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ const Iframe = ({ title, source }) => {
Iframe.propTypes = {
title: PropTypes.string,
source: PropTypes.string,
position: PropTypes.shape({ start: PropTypes.number, end: PropTypes.number }),
};

export default Iframe;
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@ ImageDisplayLink.propTypes = {
imageId: PropTypes.string,
src: PropTypes.string,
target: PropTypes.string.isRequired,
position: PropTypes.shape({ start: PropTypes.number, end: PropTypes.number }),
};

export default ImageDisplayLink;
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ ImageDisplay.propTypes = {
display: PropTypes.string,
imageId: PropTypes.string,
src: PropTypes.string,
position: PropTypes.shape({ start: PropTypes.number, end: PropTypes.number }),
};

export default ImageDisplay;
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ ImageLink.propTypes = {
imageId: PropTypes.string,
src: PropTypes.string,
target: PropTypes.string.isRequired,
position: PropTypes.shape({ start: PropTypes.number, end: PropTypes.number }),
};

export default ImageLink;
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ Image.propTypes = {
alt: PropTypes.string,
imageId: PropTypes.string,
src: PropTypes.string,
position: PropTypes.shape({ start: PropTypes.number, end: PropTypes.number }),
};

export default Image;
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@ InternalLinkTitle.propTypes = {
display: PropTypes.string,
title: PropTypes.string,
target: PropTypes.string.isRequired,
position: PropTypes.shape({ start: PropTypes.number, end: PropTypes.number }),
};

export default InternalLinkTitle;
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ const InternalLink = ({ display = '', target = '' }) => {
InternalLink.propTypes = {
display: PropTypes.string,
target: PropTypes.string.isRequired,
position: PropTypes.shape({ start: PropTypes.number, end: PropTypes.number }),
};

export default InternalLink;
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@ const YouTube = ({ title, source }) => {
YouTube.propTypes = {
title: PropTypes.string,
source: PropTypes.string,
position: PropTypes.shape({ start: PropTypes.number, end: PropTypes.number }),
};

export default YouTube;