Skip to content

Add assistiveSVG as first class output #23

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
ghost wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Add assistiveSVG as first class output #23

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
36 changes: 29 additions & 7 deletions src/render/index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@ const RESPONSE_TYPES = {
mathml: 'application/mathml+xml',
png: 'image/png',
svg: 'image/svg+xml',
json: 'application/json',
};

/**
Expand All @@ -31,9 +32,6 @@ const defaultConfiguration = {
require: require,
load: ['adaptors/liteDOM', 'input/mml', 'input/tex-full', 'output/svg']
},
options: {
enableAssistiveMml: false
}
}
const MJAX_SETTINGS = process.env.MJAX_SETTINGS ? JSON.parse(process.env.MJAX_SETTINGS) : defaultConfiguration;
MathJax = MJAX_SETTINGS;
Expand Down Expand Up @@ -82,12 +80,12 @@ const typeset = async (data) => {
if (data.svg) {
return MathJax.tex2svgPromise(data.math);
}
throw new Error(`Supported output formats for ${data.format} input are: MathML, SVG`);
throw new Error(`Supported output formats for ${data.format} input are: MathML, SVG, AssistiveSVG`);
case 'MathML':
if (data.svg) {
return MathJax.mathml2svgPromise(data.math);
}
throw new Error(`Supported output formats for ${data.format} input are: SVG`);
throw new Error(`Supported output formats for ${data.format} input are: SVG, AssistiveSVG`);
default:
throw new Error(`Unsupported input format: ${data.format}`);
}
Expand All @@ -109,6 +107,21 @@ const typeset = async (data) => {
}
};

/**
* Render math.
*
* @param {Typesetted} Result of a typesetted input.
* @returns {svg: string, assistiveML: string}
*/
const getSvgAndAssistiveML = (typesetted) => {
const svgAndAssistiveML = /(<svg .+<\/svg>)(<mjx-assistive-mml .+)/;
const groups = MathJax.startup.adaptor.innerHTML(typesetted).match(svgAndAssistiveML);
return {
svg: groups[1],
assistiveML: groups[2]
}
}

/**
* Render math.
*
Expand All @@ -135,7 +148,7 @@ exports.render = async (event) => {
{
const res = await typeset({ math, format, svg: true });

const svg = MathJax.startup.adaptor.innerHTML(res);
const { svg } = getSvgAndAssistiveML(res);
const { width, height } = event;
const data = await svg2png(svg, { width, height });

Expand All @@ -146,11 +159,20 @@ exports.render = async (event) => {
{
const res = await typeset({ math, format, svg: true });

const svg = MathJax.startup.adaptor.innerHTML(res);
const { svg } = getSvgAndAssistiveML(res);

return { contentType: RESPONSE_TYPES.svg, data: svg };
}

case 'assistiveSVG':
{
const res = await typeset({ math, format, svg: true });

const { svg, assistiveML } = getSvgAndAssistiveML(res);

return { contentType: RESPONSE_TYPES.json, data: JSON.stringify({svg, assistiveML}) };
}

default:
throw new Error(`Invalid output: ${event.output || ''}`);
}
Expand Down
35 changes: 33 additions & 2 deletions test/app.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -77,7 +77,22 @@ describe('GET /render', function () {
.expect((response) => {
const data = response.body.toString();

expect(data).to.be.a('string').that.contains('</svg>');
expect(data).to.be.a('string').that.match(/<svg .+<\/svg>/);
});
}));

Object.keys(TEST_INPUTS).forEach((alias) => it(`should render ${alias} as AssistiveSVG`, function () {
const search = Object.assign({ output: 'assistiveSVG' }, TEST_INPUTS[alias]);
const url = `/render?${querystring.stringify(search)}`;

return testApp
.get(url)
.expect(200)
.expect('Content-Type', 'application/json; charset=utf-8')
.expect((response) => {
expect(response.body).to.be.an('object').with.keys('svg', 'assistiveML');
expect(response.body.svg).to.be.a('string').that.match(/<svg .+<\/svg>/);
expect(response.body.assistiveML).to.be.a('string').that.match(/<mjx-assistive-mml .+<\/mjx-assistive-mml>/);
});
}));

Expand Down Expand Up @@ -143,7 +158,23 @@ describe('POST /render', function () {
.expect((response) => {
const data = response.body.toString();

expect(data).to.be.a('string').that.contains('</svg>');
expect(data).to.be.a('string').that.match(/<svg .+<\/svg>/);
});
}));

Object.keys(TEST_INPUTS).forEach((alias) => it(`should render ${alias} as SVG`, function () {
const body = Object.assign({ output: 'assistiveSVG' }, TEST_INPUTS[alias]);

return testApp
.post('/render')
.set('Content-Type', 'application/json')
.send(body)
.expect(200)
.expect('Content-Type', 'application/json; charset=utf-8')
.expect((response) => {
expect(response.body).to.be.an('object').with.keys('svg', 'assistiveML');
expect(response.body.svg).to.be.a('string').that.match(/<svg .+<\/svg>/);
expect(response.body.assistiveML).to.be.a('string').that.match(/<mjx-assistive-mml .+<\/mjx-assistive-mml>/);
});
}));

Expand Down
15 changes: 14 additions & 1 deletion test/render/index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,20 @@ describe('index#render', function () {

expect(actual).to.be.an('object').with.keys('contentType', 'data');
expect(actual.contentType).to.be.a('string').that.equals('image/svg+xml');
expect(actual.data).to.be.a('string').that.contains('</svg>');
expect(actual.data).to.be.a('string').that.match(/<svg .+<\/svg>/);
}));

Object.keys(TEST_INPUTS).forEach((alias) => it(`should render ${alias} as AssistiveSVG`, async function () {
const event = Object.assign({ output: 'assistiveSVG' }, TEST_INPUTS[alias]);
const actual = await render(event);

expect(actual).to.be.an('object').with.keys('contentType', 'data');
expect(actual.contentType).to.be.a('string').that.equals('application/json');

const actualData = JSON.parse(actual.data);
expect(actualData).to.be.an('object').with.keys('svg', 'assistiveML');
expect(actualData.svg).to.be.a('string').that.match(/<svg .+<\/svg>/);
expect(actualData.assistiveML).to.be.a('string').that.match(/<mjx-assistive-mml .+<\/mjx-assistive-mml>/);
}));

it('should throw with invalid input type', async function () {
Expand Down