@manuscripts/transform 2.3.38-LEAN-3911.0 → 2.4.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/cjs/__tests__/data/project-dump.json +825 -0
- package/dist/cjs/index.js +6 -6
- package/dist/cjs/jats/importer/index.js +22 -0
- package/dist/cjs/jats/importer/{jats-dom-parser.js → jats-body-dom-parser.js} +34 -273
- package/dist/cjs/jats/importer/jats-body-transformations.js +22 -74
- package/dist/cjs/jats/importer/jats-comments.js +104 -27
- package/dist/cjs/jats/importer/jats-front-parser.js +321 -0
- package/dist/cjs/jats/importer/jats-journal-meta-parser.js +1 -8
- package/dist/cjs/jats/importer/jats-parser-utils.js +5 -43
- package/dist/cjs/jats/importer/jats-reference-parser.js +23 -16
- package/dist/cjs/jats/importer/jats-references.js +18 -18
- package/dist/cjs/jats/importer/parse-jats-article.js +79 -40
- package/dist/cjs/jats/index.js +7 -7
- package/dist/cjs/jats/{exporter/jats-exporter.js → jats-exporter.js} +398 -264
- package/dist/cjs/jats/{exporter/jats-versions.js → jats-versions.js} +3 -1
- package/dist/cjs/lib/utils.js +1 -12
- package/dist/cjs/transformer/__tests__/__helpers__/doc.js +37 -0
- package/dist/cjs/transformer/builders.js +219 -0
- package/dist/cjs/transformer/decode.js +898 -0
- package/dist/cjs/transformer/document-object-types.js +31 -0
- package/dist/cjs/transformer/encode.js +674 -0
- package/dist/cjs/{jats/importer/create-article-node.js → transformer/filename.js} +9 -10
- package/dist/cjs/transformer/footnote-category.js +20 -0
- package/dist/cjs/transformer/footnotes-order.js +60 -0
- package/dist/cjs/transformer/highlight-markers.js +138 -0
- package/dist/cjs/transformer/html.js +400 -0
- package/dist/cjs/transformer/id.js +5 -10
- package/dist/cjs/transformer/index.js +18 -0
- package/dist/cjs/{jats/exporter → transformer}/labels.js +5 -4
- package/dist/cjs/transformer/manuscript-dependencies.js +21 -0
- package/dist/cjs/transformer/model-map.js +26 -0
- package/dist/cjs/{lib/deafults.js → transformer/models.js} +1 -3
- package/dist/cjs/transformer/node-names.js +1 -0
- package/dist/cjs/transformer/object-types.js +57 -0
- package/dist/cjs/transformer/project-bundle.js +94 -0
- package/dist/cjs/transformer/serializer.js +23 -0
- package/dist/cjs/transformer/timestamp.js +20 -0
- package/dist/cjs/transformer/update-identifiers.js +93 -0
- package/dist/cjs/version.js +1 -1
- package/dist/es/__tests__/data/project-dump.json +825 -0
- package/dist/es/index.js +5 -5
- package/dist/{types/jats/importer/create-article-node.d.ts → es/jats/importer/index.js} +2 -3
- package/dist/es/jats/importer/{jats-dom-parser.js → jats-body-dom-parser.js} +35 -274
- package/dist/es/jats/importer/jats-body-transformations.js +22 -74
- package/dist/es/jats/importer/jats-comments.js +101 -26
- package/dist/es/jats/importer/jats-front-parser.js +315 -0
- package/dist/es/jats/importer/jats-journal-meta-parser.js +0 -6
- package/dist/es/jats/importer/jats-parser-utils.js +6 -44
- package/dist/es/jats/importer/jats-reference-parser.js +23 -16
- package/dist/es/jats/importer/jats-references.js +18 -18
- package/dist/es/jats/importer/parse-jats-article.js +78 -41
- package/dist/es/jats/index.js +3 -5
- package/dist/es/jats/{exporter/jats-exporter.js → jats-exporter.js} +392 -258
- package/dist/es/jats/{exporter/jats-versions.js → jats-versions.js} +1 -0
- package/dist/es/lib/utils.js +0 -9
- package/dist/es/transformer/__tests__/__helpers__/doc.js +29 -0
- package/dist/es/transformer/builders.js +186 -0
- package/dist/es/transformer/decode.js +888 -0
- package/dist/es/transformer/document-object-types.js +28 -0
- package/dist/es/transformer/encode.js +664 -0
- package/dist/es/transformer/filename.js +23 -0
- package/dist/es/transformer/footnote-category.js +16 -0
- package/dist/es/transformer/footnotes-order.js +55 -0
- package/dist/es/transformer/highlight-markers.js +132 -0
- package/dist/es/transformer/html.js +393 -0
- package/dist/es/transformer/id.js +3 -8
- package/dist/es/transformer/index.js +16 -0
- package/dist/es/{jats/exporter → transformer}/labels.js +5 -4
- package/dist/es/transformer/manuscript-dependencies.js +17 -0
- package/dist/es/transformer/model-map.js +22 -0
- package/dist/es/{lib/deafults.js → transformer/models.js} +2 -2
- package/dist/es/transformer/node-names.js +1 -0
- package/dist/es/transformer/object-types.js +52 -0
- package/dist/es/transformer/project-bundle.js +85 -0
- package/dist/es/transformer/serializer.js +17 -0
- package/dist/es/transformer/timestamp.js +16 -0
- package/dist/es/transformer/update-identifiers.js +87 -0
- package/dist/es/version.js +1 -1
- package/dist/types/index.d.ts +6 -6
- package/dist/types/jats/importer/index.d.ts +16 -0
- package/dist/types/jats/importer/{jats-dom-parser.d.ts → jats-body-dom-parser.d.ts} +1 -1
- package/dist/types/jats/importer/jats-body-transformations.d.ts +1 -5
- package/dist/types/jats/importer/jats-comments.d.ts +10 -4
- package/dist/types/jats/importer/jats-front-parser.d.ts +84 -0
- package/dist/types/jats/importer/jats-journal-meta-parser.d.ts +0 -10
- package/dist/types/jats/importer/jats-references.d.ts +8 -19
- package/dist/types/jats/importer/parse-jats-article.d.ts +5 -12
- package/dist/types/jats/index.d.ts +3 -5
- package/dist/types/jats/{exporter/jats-exporter.d.ts → jats-exporter.d.ts} +29 -15
- package/dist/types/jats/{exporter/jats-versions.d.ts → jats-versions.d.ts} +1 -0
- package/dist/types/lib/utils.d.ts +0 -2
- package/dist/types/schema/nodes/bibliography_item.d.ts +3 -3
- package/dist/types/schema/nodes/contributor.d.ts +0 -10
- package/dist/types/schema/nodes/keyword_group.d.ts +0 -1
- package/dist/types/schema/nodes/manuscript.d.ts +7 -8
- package/dist/types/schema/nodes/title.d.ts +3 -0
- package/dist/types/transformer/__tests__/__helpers__/doc.d.ts +18 -0
- package/dist/types/transformer/builders.d.ts +61 -0
- package/dist/types/transformer/decode.d.ts +52 -0
- package/dist/types/transformer/document-object-types.d.ts +17 -0
- package/dist/types/transformer/encode.d.ts +29 -0
- package/dist/types/transformer/filename.d.ts +16 -0
- package/dist/types/transformer/footnote-category.d.ts +17 -0
- package/dist/{es/jats/importer/create-article-node.js → types/transformer/footnotes-order.d.ts} +8 -10
- package/dist/types/transformer/highlight-markers.d.ts +31 -0
- package/dist/types/transformer/html.d.ts +36 -0
- package/dist/types/transformer/id.d.ts +2 -5
- package/dist/types/transformer/index.d.ts +16 -0
- package/dist/types/{jats/exporter → transformer}/labels.d.ts +2 -2
- package/dist/types/transformer/manuscript-dependencies.d.ts +4 -0
- package/dist/types/transformer/model-map.d.ts +19 -0
- package/dist/types/transformer/models.d.ts +48 -0
- package/dist/types/transformer/object-types.d.ts +30 -0
- package/dist/types/transformer/project-bundle.d.ts +30 -0
- package/dist/types/transformer/serializer.d.ts +19 -0
- package/dist/types/{lib/deafults.d.ts → transformer/timestamp.d.ts} +2 -2
- package/dist/types/transformer/update-identifiers.d.ts +23 -0
- package/dist/types/types.d.ts +2 -0
- package/dist/types/version.d.ts +1 -1
- package/package.json +1 -2
- package/dist/cjs/jats/importer/jats-front-transformations.js +0 -79
- package/dist/es/jats/importer/jats-front-transformations.js +0 -76
- package/dist/types/jats/importer/jats-front-transformations.d.ts +0 -22
- package/dist/types/jats/types.d.ts +0 -1
- /package/dist/cjs/{jats/types.js → types.js} +0 -0
- /package/dist/es/{jats/types.js → types.js} +0 -0
|
@@ -1,30 +1,30 @@
|
|
|
1
|
-
/*!
|
|
2
|
-
* © 2023 Atypon Systems LLC
|
|
3
|
-
*
|
|
4
|
-
* Licensed under the Apache License, Version 2.0 (the "License");
|
|
5
|
-
* you may not use this file except in compliance with the License.
|
|
6
|
-
* You may obtain a copy of the License at
|
|
7
|
-
*
|
|
8
|
-
* http://www.apache.org/licenses/LICENSE-2.0
|
|
9
|
-
*
|
|
10
|
-
* Unless required by applicable law or agreed to in writing, software
|
|
11
|
-
* distributed under the License is distributed on an "AS IS" BASIS,
|
|
12
|
-
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
13
|
-
* See the License for the specific language governing permissions and
|
|
14
|
-
* limitations under the License.
|
|
15
|
-
*/
|
|
16
1
|
export class References {
|
|
17
2
|
constructor() {
|
|
18
3
|
this.items = new Map();
|
|
19
4
|
this.IDs = new Map();
|
|
5
|
+
this.comments = new Map();
|
|
20
6
|
}
|
|
21
|
-
add(item, id) {
|
|
22
|
-
this.items.set(item.
|
|
7
|
+
add(item, id, comments) {
|
|
8
|
+
this.items.set(item._id, item);
|
|
9
|
+
this.comments.set(item._id, comments);
|
|
23
10
|
if (id) {
|
|
24
|
-
this.IDs.set(id, item.
|
|
11
|
+
this.IDs.set(id, item._id);
|
|
25
12
|
}
|
|
26
13
|
}
|
|
27
14
|
getBibliographyItems() {
|
|
28
15
|
return [...this.items.values()];
|
|
29
16
|
}
|
|
17
|
+
getComments(id) {
|
|
18
|
+
return this.getValue(id, this.comments) || [];
|
|
19
|
+
}
|
|
20
|
+
getValue(id, map) {
|
|
21
|
+
const value = map.get(id);
|
|
22
|
+
if (value) {
|
|
23
|
+
return value;
|
|
24
|
+
}
|
|
25
|
+
const id2 = this.IDs.get(id);
|
|
26
|
+
if (id2) {
|
|
27
|
+
return map.get(id2);
|
|
28
|
+
}
|
|
29
|
+
}
|
|
30
30
|
}
|
|
@@ -14,74 +14,111 @@
|
|
|
14
14
|
* limitations under the License.
|
|
15
15
|
*/
|
|
16
16
|
import { InvalidInput } from '../../errors';
|
|
17
|
+
import { buildBibliographyElement, buildSection, encode, } from '../../transformer';
|
|
18
|
+
import { buildManuscript } from '../../transformer/builders';
|
|
19
|
+
import { generateID } from '../../transformer/id';
|
|
20
|
+
import { findManuscript } from '../../transformer/project-bundle';
|
|
21
|
+
import { jatsBodyDOMParser } from './jats-body-dom-parser';
|
|
17
22
|
import { jatsBodyTransformations } from './jats-body-transformations';
|
|
18
|
-
import { markComments } from './jats-comments';
|
|
19
|
-
import {
|
|
20
|
-
import { jatsFrontTransformations } from './jats-front-transformations';
|
|
21
|
-
import { parseJournal } from './jats-journal-meta-parser';
|
|
23
|
+
import { createComments, createReferenceComments, markComments, } from './jats-comments';
|
|
24
|
+
import { jatsFrontParser } from './jats-front-parser';
|
|
22
25
|
import { updateDocumentIDs } from './jats-parser-utils';
|
|
23
26
|
import { jatsReferenceParser } from './jats-reference-parser';
|
|
24
|
-
const
|
|
27
|
+
export const parseJATSFront = (doc, front) => {
|
|
28
|
+
const createElement = createElementFn(doc);
|
|
29
|
+
const journal = jatsFrontParser.parseJournal(front.querySelector('journal-meta'));
|
|
30
|
+
const titles = jatsFrontParser.parseTitles(front.querySelector('article-meta > title-group'), createElement);
|
|
31
|
+
const DOI = jatsFrontParser.parseDOI(front);
|
|
32
|
+
const { affiliations, affiliationIDs } = jatsFrontParser.parseAffiliations([
|
|
33
|
+
...front.querySelectorAll('article-meta > contrib-group > aff'),
|
|
34
|
+
]);
|
|
35
|
+
const { footnotes, footnoteIDs, authorNotes, authorNotesParagraphs, correspondingIDs, correspondingList, } = jatsFrontParser.parseAuthorNotes(front.querySelector('article-meta > author-notes'));
|
|
36
|
+
const authors = jatsFrontParser.parseContributors([
|
|
37
|
+
...front.querySelectorAll('article-meta > contrib-group > contrib[contrib-type="author"]'),
|
|
38
|
+
], affiliationIDs, footnoteIDs, correspondingIDs);
|
|
39
|
+
const history = jatsFrontParser.parseDates(front.querySelector('article-meta > history'));
|
|
40
|
+
const counts = jatsFrontParser.parseCounts(front.querySelector('article-meta counts'));
|
|
41
|
+
const manuscript = Object.assign(Object.assign(Object.assign(Object.assign({}, buildManuscript()), counts), history), { DOI });
|
|
42
|
+
return generateIDs([
|
|
43
|
+
manuscript,
|
|
44
|
+
titles,
|
|
45
|
+
journal,
|
|
46
|
+
...authorNotesParagraphs,
|
|
47
|
+
...authorNotes,
|
|
48
|
+
...footnotes,
|
|
49
|
+
...authors,
|
|
50
|
+
...affiliations,
|
|
51
|
+
...correspondingList,
|
|
52
|
+
]);
|
|
53
|
+
};
|
|
54
|
+
export const parseJATSBody = (doc, body, references) => {
|
|
25
55
|
const createElement = createElementFn(doc);
|
|
26
56
|
jatsBodyTransformations.ensureSection(body, createElement);
|
|
27
57
|
jatsBodyTransformations.moveCaptionsToEnd(body);
|
|
28
58
|
jatsBodyTransformations.fixTables(body, createElement);
|
|
59
|
+
jatsBodyTransformations.createBoxedElementSection(doc, body, createElement);
|
|
29
60
|
jatsBodyTransformations.createBody(doc, body, createElement);
|
|
30
61
|
jatsBodyTransformations.createAbstracts(doc, body, createElement);
|
|
31
62
|
jatsBodyTransformations.createBackmatter(doc, body, createElement);
|
|
32
63
|
jatsBodyTransformations.createSuppleMaterials(doc, body, createElement);
|
|
33
64
|
jatsBodyTransformations.createKeywords(doc, body, createElement);
|
|
34
65
|
jatsBodyTransformations.orderTableFootnote(doc, body);
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
const createElement = createElementFn(doc);
|
|
39
|
-
jatsFrontTransformations.setArticleAttrs(doc, template);
|
|
40
|
-
const authorNotes = jatsFrontTransformations.createAuthorNotes(doc, createElement);
|
|
41
|
-
if (authorNotes) {
|
|
42
|
-
doc.documentElement.prepend(authorNotes);
|
|
43
|
-
}
|
|
44
|
-
const affiliations = jatsFrontTransformations.createAffiliations(front, createElement);
|
|
45
|
-
if (affiliations) {
|
|
46
|
-
doc.documentElement.prepend(affiliations);
|
|
47
|
-
}
|
|
48
|
-
const contributors = jatsFrontTransformations.createContributors(front, createElement);
|
|
49
|
-
if (contributors) {
|
|
50
|
-
doc.documentElement.prepend(contributors);
|
|
51
|
-
}
|
|
52
|
-
const title = jatsFrontTransformations.createTitle(front, createElement);
|
|
53
|
-
if (title) {
|
|
54
|
-
doc.documentElement.prepend(title);
|
|
66
|
+
const node = jatsBodyDOMParser.parse(body).firstChild;
|
|
67
|
+
if (!node) {
|
|
68
|
+
throw new Error('No content was parsed from the JATS article body');
|
|
55
69
|
}
|
|
70
|
+
const replacements = new Map(references === null || references === void 0 ? void 0 : references.IDs);
|
|
71
|
+
updateDocumentIDs(node, replacements);
|
|
72
|
+
return encode(node).values();
|
|
73
|
+
};
|
|
74
|
+
const createBibliographyModels = (references) => {
|
|
75
|
+
const models = [];
|
|
76
|
+
const bibliographyItems = references.getBibliographyItems();
|
|
77
|
+
const bibliographyElement = buildBibliographyElement(bibliographyItems);
|
|
78
|
+
const bibliographySection = Object.assign(Object.assign({}, buildSection(99)), { category: 'MPSectionCategory:bibliography', elementIDs: [bibliographyElement._id], title: 'References' });
|
|
79
|
+
const comments = createReferenceComments(references);
|
|
80
|
+
models.push(bibliographySection);
|
|
81
|
+
models.push(bibliographyElement);
|
|
82
|
+
models.push(...bibliographyItems);
|
|
83
|
+
models.push(...comments);
|
|
84
|
+
return models;
|
|
56
85
|
};
|
|
57
86
|
const createElementFn = (doc) => (tagName) => doc.createElement(tagName);
|
|
58
|
-
|
|
87
|
+
const generateIDs = (models) => models.map((m) => m._id ? m : Object.assign(Object.assign({}, m), { _id: generateID(m.objectType) }));
|
|
88
|
+
export const parseJATSArticle = (doc) => {
|
|
59
89
|
const article = doc.querySelector('article');
|
|
60
90
|
const front = doc.querySelector('front');
|
|
61
91
|
const body = doc.querySelector('body');
|
|
62
92
|
const back = doc.querySelector('back');
|
|
63
|
-
if (!
|
|
64
|
-
throw new InvalidInput('
|
|
93
|
+
if (!front) {
|
|
94
|
+
throw new InvalidInput('Invalid JATS format! Missing front element');
|
|
95
|
+
}
|
|
96
|
+
if (!article) {
|
|
97
|
+
throw new InvalidInput('Invalid JATS format! Missing article element');
|
|
65
98
|
}
|
|
66
|
-
markComments(doc);
|
|
67
|
-
const journal = parseJournal(front.querySelector('journal-meta'));
|
|
99
|
+
const marks = markComments(doc);
|
|
68
100
|
const createElement = createElementFn(doc);
|
|
101
|
+
const models = [];
|
|
69
102
|
let references;
|
|
70
103
|
if (back) {
|
|
71
104
|
references = jatsReferenceParser.parseReferences([...back.querySelectorAll('ref-list > ref')], createElement);
|
|
72
105
|
}
|
|
73
|
-
|
|
74
|
-
parseJATSFront(doc, front, template);
|
|
106
|
+
models.push(...parseJATSFront(doc, front));
|
|
75
107
|
if (body) {
|
|
76
|
-
parseJATSBody(doc, body, references);
|
|
108
|
+
models.push(...parseJATSBody(doc, body, references));
|
|
77
109
|
}
|
|
78
|
-
const
|
|
79
|
-
|
|
80
|
-
|
|
110
|
+
const modelMap = new Map(models.map((model) => [model._id, model]));
|
|
111
|
+
const manuscript = findManuscript(modelMap);
|
|
112
|
+
if (manuscript) {
|
|
113
|
+
const type = article.getAttribute('article-type');
|
|
114
|
+
manuscript.articleType = type || 'other';
|
|
81
115
|
}
|
|
82
|
-
|
|
83
|
-
|
|
84
|
-
|
|
85
|
-
|
|
86
|
-
|
|
116
|
+
if (references && references.items.size) {
|
|
117
|
+
models.push(...createBibliographyModels(references));
|
|
118
|
+
}
|
|
119
|
+
if (marks.length) {
|
|
120
|
+
const comments = createComments(models, marks);
|
|
121
|
+
models.push(...comments);
|
|
122
|
+
}
|
|
123
|
+
return models;
|
|
87
124
|
};
|
package/dist/es/jats/index.js
CHANGED
|
@@ -13,8 +13,6 @@
|
|
|
13
13
|
* See the License for the specific language governing permissions and
|
|
14
14
|
* limitations under the License.
|
|
15
15
|
*/
|
|
16
|
-
export
|
|
17
|
-
export * from './
|
|
18
|
-
export * from './
|
|
19
|
-
export * from './importer/create-article-node';
|
|
20
|
-
export { parseJATSArticle } from './importer/parse-jats-article';
|
|
16
|
+
export { parseJATSFront, parseJATSBody, parseJATSArticle } from './importer';
|
|
17
|
+
export * from './jats-exporter';
|
|
18
|
+
export * from './jats-versions';
|