Skip to content

Commit c26a49c

Browse files
K-Kumar-01K-Kumar-01
authored
feat(markdown-docx): add clause transformer - #397 (#432)
Signed-off-by: k-kumar-01 <[email protected]>
1 parent 1c569bf commit c26a49c

File tree

9 files changed

+191
-15
lines changed

9 files changed

+191
-15
lines changed

‎packages/markdown-cli/test/data/acceptance/omitted-acceptance-of-delivery.xml

+10
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,13 @@
4242
xmlns:wps="http://schemas.microsoft.com/office/word/2010/wordprocessingShape" mc:Ignorable="w14 w15 w16se w16cid wp14">
4343
<w:body>
4444

45+
<w:sdt>
46+
<w:sdtPr>
47+
<w:lock w:val="contentLocked" />
48+
<w:alias w:val="Template"/>
49+
</w:sdtPr>
50+
<w:sdtContent>
51+
4552
<w:p>
4653

4754
<w:pPr>
@@ -510,6 +517,9 @@
510517
</w:r>
511518
</w:p>
512519

520+
</w:sdtContent>
521+
</w:sdt>
522+
513523
<w:p/>
514524
</w:body>
515525
</w:document>

‎packages/markdown-docx/src/ToCiceroMarkVisitor.js

+64-12
Original file line numberDiff line numberDiff line change
@@ -83,6 +83,25 @@ class ToCiceroMarkVisitor {
8383
}
8484
}
8585

86+
/**
87+
* Gets the node type based on the color property.
88+
*
89+
* @param {Array} properties the variable elements
90+
* @returns {string} the type of the node
91+
*/
92+
getNodeType(properties) {
93+
let nodeType = TRANSFORMED_NODES.variable;
94+
for (const property of properties) {
95+
if (property.name === 'w15:color') {
96+
// eg. "Shipper1 | org.accordproject.organization.Organization"
97+
if (property.attributes['w:val'] === '99CCFF') {
98+
nodeType = TRANSFORMED_NODES.clause;
99+
}
100+
}
101+
}
102+
return nodeType;
103+
}
104+
86105
/**
87106
* Checks if the node is a thematic break or not
88107
*
@@ -202,9 +221,11 @@ class ToCiceroMarkVisitor {
202221
/**
203222
* Generates all nodes present in a block element( paragraph, heading ).
204223
*
205-
* @param {object} rootNode Block node like paragraph, heading, etc.
224+
* @param {object} rootNode Block node like paragraph, heading, etc.
225+
* @param {boolean} returnConstructedNode return the constructed node if true else appends it to nodes array
226+
* @returns {*} Node if returnConstructedNode else None
206227
*/
207-
generateNodes(rootNode) {
228+
generateNodes(rootNode, returnConstructedNode = false) {
208229
if (this.JSONXML.length > 0) {
209230
let constructedNode;
210231
constructedNode = this.constructCiceroMarkNodeJSON(this.JSONXML[0]);
@@ -250,7 +271,11 @@ class ToCiceroMarkVisitor {
250271
}
251272
}
252273
this.JSONXML = [];
253-
this.nodes = [...this.nodes, rootNode];
274+
if (returnConstructedNode) {
275+
return rootNode;
276+
} else {
277+
this.nodes = [...this.nodes, rootNode];
278+
}
254279
}
255280
}
256281

@@ -313,9 +338,12 @@ class ToCiceroMarkVisitor {
313338
* Traverses the JSON object of XML elements in DFS approach.
314339
*
315340
* @param {object} node Node object to be traversed
316-
* @param {object} parent Parent node name
341+
* @param {string} parent Parent node name
342+
* @returns {*} GeneratedNode if parent is of type clause else none
317343
*/
318344
traverseElements(node, parent = '') {
345+
// Contains node present in a codeblock or blockquote, etc.
346+
let blockNodes = [];
319347
for (const subNode of node) {
320348
if (subNode.name === 'w:p') {
321349
if (!subNode.elements) {
@@ -349,8 +377,12 @@ class ToCiceroMarkVisitor {
349377
const thematicBreakNode = {
350378
$class: TRANSFORMED_NODES.thematicBreak,
351379
};
352-
this.nodes = [...this.nodes, thematicBreakNode];
353-
continue;
380+
if (parent === TRANSFORMED_NODES.clause) {
381+
blockNodes = [...blockNodes, thematicBreakNode];
382+
} else {
383+
this.nodes = [...this.nodes, thematicBreakNode];
384+
continue;
385+
}
354386
}
355387

356388
this.traverseElements(subNode.elements);
@@ -361,13 +393,21 @@ class ToCiceroMarkVisitor {
361393
level,
362394
nodes: [],
363395
};
364-
this.generateNodes(headingNode);
396+
if (parent === TRANSFORMED_NODES.clause) {
397+
blockNodes = [...blockNodes, this.generateNodes(headingNode, true)];
398+
} else {
399+
this.generateNodes(headingNode);
400+
}
365401
} else {
366402
let paragraphNode = {
367403
$class: TRANSFORMED_NODES.paragraph,
368404
nodes: [],
369405
};
370-
this.generateNodes(paragraphNode);
406+
if (parent === TRANSFORMED_NODES.clause) {
407+
blockNodes = [...blockNodes, this.generateNodes(paragraphNode, true)];
408+
} else {
409+
this.generateNodes(paragraphNode);
410+
}
371411
}
372412
} else if (subNode.name === 'w:sdt') {
373413
// denotes the whole template if parent is body
@@ -376,7 +416,6 @@ class ToCiceroMarkVisitor {
376416
} else {
377417
let nodeInformation = {
378418
properties: [],
379-
value: '',
380419
nodeType: TRANSFORMED_NODES.variable,
381420
name: null,
382421
elementType: null,
@@ -385,11 +424,23 @@ class ToCiceroMarkVisitor {
385424
if (variableSubNodes.name === 'w:sdtPr') {
386425
nodeInformation.name = this.getName(variableSubNodes.elements);
387426
nodeInformation.elementType = this.getElementType(variableSubNodes.elements);
427+
nodeInformation.nodeType = this.getNodeType(variableSubNodes.elements);
388428
}
389429
if (variableSubNodes.name === 'w:sdtContent') {
390-
for (const variableContentNodes of variableSubNodes.elements) {
391-
if (variableContentNodes.name === 'w:r') {
392-
this.fetchFormattingProperties(variableContentNodes, nodeInformation);
430+
if (nodeInformation.nodeType === TRANSFORMED_NODES.clause) {
431+
const nodes = this.traverseElements(variableSubNodes.elements, TRANSFORMED_NODES.clause);
432+
const clauseNode = {
433+
$class: TRANSFORMED_NODES.clause,
434+
elementType: nodeInformation.elementType,
435+
name: nodeInformation.name,
436+
nodes,
437+
};
438+
this.nodes = [...this.nodes, clauseNode];
439+
} else {
440+
for (const variableContentNodes of variableSubNodes.elements) {
441+
if (variableContentNodes.name === 'w:r') {
442+
this.fetchFormattingProperties(variableContentNodes, nodeInformation);
443+
}
393444
}
394445
}
395446
}
@@ -400,6 +451,7 @@ class ToCiceroMarkVisitor {
400451
this.fetchFormattingProperties(subNode, nodeInformation);
401452
}
402453
}
454+
return blockNodes;
403455
}
404456

405457
/**

‎packages/markdown-docx/src/ToOOXMLVisitor/helpers.js

+21-2
Original file line numberDiff line numberDiff line change
@@ -35,14 +35,33 @@ function titleGenerator(title, type) {
3535
return `${title} | ${type}`;
3636
}
3737

38+
/**
39+
* Wraps the OOXML in locked w:sdt tags to prevent content editing.
40+
*
41+
* @param {string} ooxml OOXML string to be wrapped
42+
* @returns {string} OOXML wrapped in locked content controls
43+
*/
44+
function wrapAroundLockedContentControls(ooxml) {
45+
return `
46+
<w:sdt>
47+
<w:sdtPr>
48+
<w:lock w:val="contentLocked" />
49+
<w:alias w:val="Template"/>
50+
</w:sdtPr>
51+
<w:sdtContent>
52+
${ooxml}
53+
</w:sdtContent>
54+
</w:sdt>
55+
`;
56+
}
57+
3858
/**
3959
* Wraps OOXML in docx headers.
4060
*
4161
* @param {string} ooxml OOXML to be wrapped
4262
* @returns {string} OOXML wraped in docx headers
4363
*/
4464
function wrapAroundDefaultDocxTags(ooxml) {
45-
4665
const HEADING_STYLE_SPEC = `
4766
<pkg:part pkg:name="/word/styles.xml" pkg:contentType="application/vnd.openxmlformats-officedocument.wordprocessingml.styles+xml">
4867
<pkg:xmlData>
@@ -264,4 +283,4 @@ function wrapAroundDefaultDocxTags(ooxml) {
264283
return ooxml;
265284
}
266285

267-
module.exports = { sanitizeHtmlChars, titleGenerator, wrapAroundDefaultDocxTags };
286+
module.exports = { sanitizeHtmlChars, titleGenerator, wrapAroundDefaultDocxTags, wrapAroundLockedContentControls };

‎packages/markdown-docx/src/ToOOXMLVisitor/index.js

+57-1
Original file line numberDiff line numberDiff line change
@@ -28,8 +28,9 @@ const {
2828
THEMATICBREAK_RULE,
2929
CODEBLOCK_PROPERTIES_RULE,
3030
CODEBLOCK_FONTPROPERTIES_RULE,
31+
CLAUSE_RULE,
3132
} = require('./rules');
32-
const { wrapAroundDefaultDocxTags } = require('./helpers');
33+
const { wrapAroundDefaultDocxTags, wrapAroundLockedContentControls } = require('./helpers');
3334
const { TRANSFORMED_NODES } = require('../constants');
3435

3536
/**
@@ -140,6 +141,60 @@ class ToOOXMLVisitor {
140141
this.tags = [...this.tags, SOFTBREAK_RULE()];
141142
} else if (this.getClass(subNode) === TRANSFORMED_NODES.thematicBreak) {
142143
this.globalOOXML += THEMATICBREAK_RULE();
144+
} else if (this.getClass(subNode) === TRANSFORMED_NODES.clause) {
145+
let clauseOOXML = '';
146+
if (subNode.nodes) {
147+
for (const deepNode of subNode.nodes) {
148+
if (this.getClass(deepNode) === TRANSFORMED_NODES.paragraph) {
149+
this.traverseNodes(deepNode.nodes, properties);
150+
let ooxml = '';
151+
for (let xmlTag of this.tags) {
152+
ooxml += xmlTag;
153+
}
154+
ooxml = PARAGRAPH_RULE(ooxml);
155+
clauseOOXML += ooxml;
156+
157+
// Clear all the tags as all nodes of paragraph have been traversed.
158+
this.tags = [];
159+
} else if (this.getClass(deepNode) === TRANSFORMED_NODES.heading) {
160+
this.traverseNodes(deepNode.nodes, properties);
161+
let ooxml = '';
162+
for (let xmlTag of this.tags) {
163+
let headingPropertiesTag = '';
164+
headingPropertiesTag = HEADING_PROPERTIES_RULE(deepNode.level);
165+
ooxml += headingPropertiesTag;
166+
ooxml += xmlTag;
167+
}
168+
169+
// in DOCX heading is a paragraph with some styling tags present
170+
ooxml = PARAGRAPH_RULE(ooxml);
171+
clauseOOXML += ooxml;
172+
173+
this.tags = [];
174+
} else {
175+
let newProperties = [...properties, deepNode.$class];
176+
this.traverseNodes(deepNode.nodes, newProperties);
177+
}
178+
}
179+
const tag = subNode.name;
180+
const type = subNode.elementType;
181+
if (Object.prototype.hasOwnProperty.call(this.counter, tag)) {
182+
this.counter = {
183+
...this.counter,
184+
[tag]: {
185+
...this.counter[tag],
186+
count: ++this.counter[tag].count,
187+
},
188+
};
189+
} else {
190+
this.counter[tag] = {
191+
count: 1,
192+
type,
193+
};
194+
}
195+
const title = `${tag.toUpperCase()[0]}${tag.substring(1)}${this.counter[tag].count}`;
196+
this.globalOOXML += CLAUSE_RULE(title, tag, type, clauseOOXML);
197+
}
143198
} else {
144199
if (subNode.nodes) {
145200
if (this.getClass(subNode) === TRANSFORMED_NODES.paragraph) {
@@ -186,6 +241,7 @@ class ToOOXMLVisitor {
186241
*/
187242
toOOXML(ciceromark) {
188243
this.traverseNodes(ciceromark, []);
244+
this.globalOOXML = wrapAroundLockedContentControls(this.globalOOXML);
189245
this.globalOOXML = wrapAroundDefaultDocxTags(this.globalOOXML);
190246

191247
return this.globalOOXML;

‎packages/markdown-docx/src/ToOOXMLVisitor/rules.js

+26
Original file line numberDiff line numberDiff line change
@@ -204,6 +204,31 @@ const THEMATICBREAK_RULE = () => {
204204
`;
205205
};
206206

207+
/**
208+
* Inserts a clause object in OOXML syntax
209+
*
210+
* @param {string} title Title of the clause
211+
* @param {string} tag Tag of the clause
212+
* @param {string} type Type of the clause
213+
* @param {string} content Content of the clause
214+
* @returns {string} OOXML for the clause
215+
*/
216+
const CLAUSE_RULE = (title, tag, type, content) => {
217+
return `
218+
<w:sdt>
219+
<w:sdtPr>
220+
<w:lock w:val="contentLocked"/>
221+
<w15:color w:val="99CCFF"/>
222+
<w:alias w:val="${titleGenerator(title, type)}"/>
223+
<w:tag w:val="${tag}"/>
224+
</w:sdtPr>
225+
<w:sdtContent>
226+
${content}
227+
</w:sdtContent>
228+
</w:sdt>
229+
`;
230+
};
231+
207232
module.exports = {
208233
TEXT_RULE,
209234
EMPHASIS_RULE,
@@ -218,4 +243,5 @@ module.exports = {
218243
CODEBLOCK_PROPERTIES_RULE,
219244
CODEBLOCK_FONTPROPERTIES_RULE,
220245
THEMATICBREAK_RULE,
246+
CLAUSE_RULE,
221247
};

‎packages/markdown-docx/src/constants.js

+1
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,7 @@ const TRANSFORMED_NODES = {
3131
text: `${NS_PREFIX_CommonMarkModel}Text`,
3232
thematicBreak: `${NS_PREFIX_CommonMarkModel}ThematicBreak`,
3333
variable: `${NS_PREFIX_CiceroMarkModel}Variable`,
34+
clause:`${NS_PREFIX_CiceroMarkModel}Clause`
3435
};
3536

3637
module.exports = { TRANSFORMED_NODES };

‎packages/markdown-docx/test/data/ciceroMark/clause.json

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
{"$class":"org.accordproject.commonmark.Document","xmlns":"http://commonmark.org/xml/1.0","nodes":[{"$class":"org.accordproject.commonmark.Heading","level":"1","nodes":[{"$class":"org.accordproject.commonmark.Text","text":"Heading"}]},{"$class":"org.accordproject.commonmark.Paragraph","nodes":[{"$class":"org.accordproject.commonmark.Text","text":"And below is a "},{"$class":"org.accordproject.commonmark.Strong","nodes":[{"$class":"org.accordproject.commonmark.Text","text":"clause"}]},{"$class":"org.accordproject.commonmark.Text","text":"."}]},{"$class":"org.accordproject.ciceromark.Clause","name":"deliveryClause","elementType":"org.accordproject.acceptanceofdelivery.AcceptanceOfDeliveryClause","nodes":[{"$class":"org.accordproject.commonmark.Heading","level":"2","nodes":[{"$class":"org.accordproject.commonmark.Text","text":"Acceptance of Delivery."}]},{"$class":"org.accordproject.commonmark.Paragraph","nodes":[{"$class":"org.accordproject.ciceromark.Variable","value":"\"Party A\"","name":"shipper","elementType":"org.accordproject.organization.Organization"},{"$class":"org.accordproject.commonmark.Text","text":" will be deemed to have completed its delivery obligations"},{"$class":"org.accordproject.commonmark.Softbreak"},{"$class":"org.accordproject.commonmark.Text","text":"if in "},{"$class":"org.accordproject.ciceromark.Variable","value":"\"Party B\"","name":"receiver","elementType":"org.accordproject.organization.Organization"},{"$class":"org.accordproject.commonmark.Text","text":"'s opinion, the "},{"$class":"org.accordproject.ciceromark.Variable","value":"\"Widgets\"","name":"deliverable","elementType":"String"},{"$class":"org.accordproject.commonmark.Text","text":" satisfies the"},{"$class":"org.accordproject.commonmark.Softbreak"},{"$class":"org.accordproject.commonmark.Text","text":"Acceptance Criteria, and "},{"$class":"org.accordproject.ciceromark.Variable","value":"\"Party B\"","name":"receiver","elementType":"org.accordproject.organization.Organization"},{"$class":"org.accordproject.commonmark.Text","text":" notifies "},{"$class":"org.accordproject.ciceromark.Variable","value":"\"Party A\"","name":"shipper","elementType":"org.accordproject.organization.Organization"},{"$class":"org.accordproject.commonmark.Text","text":" in writing"},{"$class":"org.accordproject.commonmark.Softbreak"},{"$class":"org.accordproject.commonmark.Text","text":"that it is accepting the "},{"$class":"org.accordproject.ciceromark.Variable","value":"\"Widgets\"","name":"deliverable","elementType":"String"},{"$class":"org.accordproject.commonmark.Text","text":"."}]},{"$class":"org.accordproject.commonmark.Heading","level":"2","nodes":[{"$class":"org.accordproject.commonmark.Text","text":"Inspection and Notice."}]},{"$class":"org.accordproject.commonmark.Paragraph","nodes":[{"$class":"org.accordproject.ciceromark.Variable","value":"\"Party B\"","name":"receiver","elementType":"org.accordproject.organization.Organization"},{"$class":"org.accordproject.commonmark.Text","text":" will have "},{"$class":"org.accordproject.ciceromark.Variable","value":"10","name":"businessDays","elementType":"Long"},{"$class":"org.accordproject.commonmark.Text","text":" Business Days to inspect and"},{"$class":"org.accordproject.commonmark.Softbreak"},{"$class":"org.accordproject.commonmark.Text","text":"evaluate the "},{"$class":"org.accordproject.ciceromark.Variable","value":"\"Widgets\"","name":"deliverable","elementType":"String"},{"$class":"org.accordproject.commonmark.Text","text":" on the delivery date before notifying"},{"$class":"org.accordproject.commonmark.Softbreak"},{"$class":"org.accordproject.ciceromark.Variable","value":"\"Party A\"","name":"shipper","elementType":"org.accordproject.organization.Organization"},{"$class":"org.accordproject.commonmark.Text","text":" that it is either accepting or rejecting the"},{"$class":"org.accordproject.commonmark.Softbreak"},{"$class":"org.accordproject.ciceromark.Variable","value":"\"Widgets\"","name":"deliverable","elementType":"String"},{"$class":"org.accordproject.commonmark.Text","text":"."}]},{"$class":"org.accordproject.commonmark.Heading","level":"2","nodes":[{"$class":"org.accordproject.commonmark.Text","text":"Acceptance Criteria."}]},{"$class":"org.accordproject.commonmark.Paragraph","nodes":[{"$class":"org.accordproject.commonmark.Text","text":"The \"Acceptance Criteria\" are the specifications the "},{"$class":"org.accordproject.ciceromark.Variable","value":"\"Widgets\"","name":"deliverable","elementType":"String"},{"$class":"org.accordproject.commonmark.Softbreak"},{"$class":"org.accordproject.commonmark.Text","text":"must meet for the "},{"$class":"org.accordproject.ciceromark.Variable","value":"\"Party A\"","name":"shipper","elementType":"org.accordproject.organization.Organization"},{"$class":"org.accordproject.commonmark.Text","text":" to comply with its requirements and"},{"$class":"org.accordproject.commonmark.Softbreak"},{"$class":"org.accordproject.commonmark.Text","text":"obligations under this agreement, detailed in "},{"$class":"org.accordproject.ciceromark.Variable","value":"\"Attachment X\"","name":"attachment","elementType":"String"},{"$class":"org.accordproject.commonmark.Text","text":", attached"},{"$class":"org.accordproject.commonmark.Softbreak"},{"$class":"org.accordproject.commonmark.Text","text":"to this agreement."}]}]},{"$class":"org.accordproject.commonmark.Paragraph","nodes":[{"$class":"org.accordproject.commonmark.Text","text":"More text"}]}]}

0 commit comments

Comments
 (0)