@manuscripts/transform 2.3.19 → 2.3.21-JSR

package/dist/cjs/index.js

@@ -14,7 +14,7 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.isSectionLabelNode = exports.getVersion = void 0;
+exports.isSectionLabelNode = exports.migrateFor = exports.getVersion = void 0;
 __exportStar(require("./lib/section-group-type"), exports);
 __exportStar(require("./lib/table-cell-styles"), exports);
 __exportStar(require("./lib/utils"), exports);
@@ -25,5 +25,7 @@ __exportStar(require("./types"), exports);
 __exportStar(require("./errors"), exports);
 var getVersion_1 = require("./getVersion");
 Object.defineProperty(exports, "getVersion", { enumerable: true, get: function () { return getVersion_1.getVersion; } });
+var migrate_1 = require("./schema/migration/migrate");
+Object.defineProperty(exports, "migrateFor", { enumerable: true, get: function () { return migrate_1.migrateFor; } });
 var section_label_1 = require("./schema/nodes/section_label");
 Object.defineProperty(exports, "isSectionLabelNode", { enumerable: true, get: function () { return section_label_1.isSectionLabelNode; } });

package/dist/cjs/jats/jats-exporter.js

@@ -143,7 +143,7 @@ class JATSExporter {
             const manuscript = (0, project_bundle_1.findManuscriptById)(this.modelMap, manuscriptID);
             article.setAttribute('article-type', manuscript.articleType || 'other');
             if (!frontMatterOnly) {
-                this.labelTargets = (0, labels_1.buildTargets)(fragment, manuscript);
+                this.labelTargets = (0, labels_1.buildTargets)(fragment);
                 const body = this.buildBody(fragment);
                 article.appendChild(body);
                 const back = this.buildBack(body);

package/dist/cjs/schema/migration/migrate.js

@@ -0,0 +1,50 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.migrateFor = void 0;
+const lodash_1 = require("lodash");
+const semver_1 = __importDefault(require("semver"));
+const __1 = require("..");
+const migration_scripts_1 = __importDefault(require("./migration-scripts"));
+function migrate(oldDoc, migrationScript) {
+    function migrateNode(node) {
+        const migrated = migrationScript(node, oldDoc);
+        if (migrated.content) {
+            migrated.content = migrated.content.map((m) => migrateNode(m));
+        }
+        return migrated;
+    }
+    return migrateNode(oldDoc);
+}
+exports.default = migrate;
+function migrateFor(oldDoc, baseVersion) {
+    const migrationScripts = ensureVersionAscOrder();
+    let migratedDoc = (0, lodash_1.cloneDeep)(oldDoc);
+    for (let i = 0; i < migrationScripts.length; i++) {
+        const script = migrationScripts[i];
+        if (semver_1.default.lt(script.fromVersion, baseVersion)) {
+            continue;
+        }
+        console.log('Migrating doc with script to version ' + script.toVersion);
+        migratedDoc = migrate(migratedDoc, script.migrateNode);
+    }
+    return testDoc(migratedDoc, baseVersion);
+}
+exports.migrateFor = migrateFor;
+const ensureVersionAscOrder = () => migration_scripts_1.default.sort((a, b) => semver_1.default.compare(a.toVersion, b.toVersion));
+function testDoc(doc, fromVersion) {
+    try {
+        const resultDoc = __1.schema.nodeFromJSON(doc);
+        resultDoc.check();
+        return resultDoc;
+    }
+    catch (e) {
+        const error = 'Migration application from version ' +
+            fromVersion +
+            ' did not produce a valid document with ' +
+            e;
+        throw new Error(error);
+    }
+}

package/dist/cjs/schema/migration/migration-script.js

@@ -0,0 +1,17 @@
+"use strict";
+/*!
+ * © 2024 Atypon Systems LLC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *    http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/schema/migration/migration-scripts/1.2.5.js

@@ -0,0 +1,30 @@
+"use strict";
+/*!
+ * © 2024 Atypon Systems LLC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *    http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+class Migration125 {
+    constructor() {
+        this.fromVersion = '1.2.3';
+        this.toVersion = '1.2.5';
+    }
+    migrateNode(node, doc) {
+        if (node.type === 'paragraph') {
+            return Object.assign(Object.assign({}, node), { attrs: Object.assign(Object.assign({}, node.attrs), { someNewFanctAttribute: 'example-value' }) });
+        }
+        return node;
+    }
+}
+exports.default = Migration125;

package/dist/cjs/schema/migration/migration-scripts/index.js

@@ -0,0 +1,23 @@
+"use strict";
+/*!
+ * © 2024 Atypon Systems LLC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *    http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const _1_2_5_1 = __importDefault(require("./1.2.5"));
+const migrations = [new _1_2_5_1.default()];
+exports.default = migrations;

package/dist/cjs/schema/nodes/manuscript.js

@@ -21,6 +21,9 @@ exports.manuscript = {
     attrs: {
         id: { default: '' },
         doi: { default: '' },
+        prototype: { default: '' },
+        primaryLanguageCode: { default: '' },
+        articleType: { default: '' },
     },
     group: 'block',
     parseDOM: [

package/dist/cjs/transformer/__tests__/__helpers__/doc.js

@@ -0,0 +1,37 @@
+"use strict";
+/*!
+ * © 2019 Atypon Systems LLC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *    http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createTestDoc = exports.createTestModelMap = void 0;
+const project_dump_json_1 = __importDefault(require("../../../__tests__/data/project-dump.json"));
+const decode_1 = require("../../decode");
+const createTestModelMap = () => {
+    const modelMap = new Map();
+    for (const component of project_dump_json_1.default.data) {
+        modelMap.set(component._id, component);
+    }
+    return modelMap;
+};
+exports.createTestModelMap = createTestModelMap;
+const createTestDoc = () => {
+    const modelMap = (0, exports.createTestModelMap)();
+    const decoder = new decode_1.Decoder(modelMap);
+    return decoder.createArticleNode();
+};
+exports.createTestDoc = createTestDoc;

package/dist/cjs/transformer/decode.js

@@ -727,9 +727,13 @@ class Decoder {
                 this.createCommentsNode(),
             ];
             const contents = nodes.filter((node) => node !== false);
+            const props = this.getManuscript();
             return schema_1.schema.nodes.manuscript.create({
                 id: manuscriptID || this.getManuscriptID(),
-                doi: this.getManuscriptDOI() || '',
+                doi: (props === null || props === void 0 ? void 0 : props.DOI) || '',
+                articleType: props === null || props === void 0 ? void 0 : props.articleType,
+                prototype: props === null || props === void 0 ? void 0 : props.prototype,
+                primaryLanguageCode: props === null || props === void 0 ? void 0 : props.primaryLanguageCode,
             }, contents);
         };
         this.addGeneratedLabels = (sections) => {
@@ -775,10 +779,10 @@ class Decoder {
                 }
             }
         };
-        this.getManuscriptDOI = () => {
+        this.getManuscript = () => {
             for (const item of this.modelMap.values()) {
                 if ((0, object_types_1.isManuscript)(item)) {
-                    return item.DOI;
+                    return item;
                 }
             }
         };

package/dist/cjs/transformer/html.js

@@ -75,8 +75,7 @@ class HTMLTransformer {
         this.serializeToHTML = async (fragment, modelMap, options = {}) => {
             const { idGenerator, mediaPathGenerator } = options;
             this.modelMap = modelMap;
-            const manuscript = (0, project_bundle_1.findManuscript)(this.modelMap);
-            this.labelTargets = (0, labels_1.buildTargets)(fragment, manuscript);
+            this.labelTargets = (0, labels_1.buildTargets)(fragment);
             this.document = document.implementation.createDocument('http://www.w3.org/1999/xhtml', 'html', document.implementation.createDocumentType('html', '', ''));
             const article = this.document.createElement('article');
             this.document.documentElement.appendChild(article);

package/dist/cjs/transformer/index.js

@@ -29,6 +29,7 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.createTestDoc = void 0;
 __exportStar(require("./builders"), exports);
 __exportStar(require("./decode"), exports);
 __exportStar(require("./document-object-types"), exports);
@@ -49,3 +50,5 @@ __exportStar(require("./section-category"), exports);
 __exportStar(require("./serializer"), exports);
 __exportStar(require("./timestamp"), exports);
 __exportStar(require("./update-identifiers"), exports);
+var doc_1 = require("./__tests__/__helpers__/doc");
+Object.defineProperty(exports, "createTestDoc", { enumerable: true, get: function () { return doc_1.createTestDoc; } });

package/dist/cjs/transformer/labels.js

@@ -24,28 +24,15 @@ const labelledNodeTypes = [
     schema_1.schema.nodes.equation_element,
     schema_1.schema.nodes.listing_element,
 ];
-const labelProperties = new Map([
-    [schema_1.schema.nodes.figure_element, 'figureElementLabel'],
-    [schema_1.schema.nodes.table_element, 'tableElementLabel'],
-    [schema_1.schema.nodes.equation_element, 'equationElementLabel'],
-    [schema_1.schema.nodes.listing_element, 'listingElementLabel'],
-]);
 const excludedTypes = [schema_1.schema.nodes.graphical_abstract_section];
-const chooseLabel = (nodeType, manuscript) => {
-    const labelProperty = labelProperties.get(nodeType);
-    if (labelProperty) {
-        const label = manuscript[labelProperty];
-        if (label) {
-            return label;
-        }
-    }
+const chooseLabel = (nodeType) => {
     return node_names_1.nodeNames.get(nodeType);
 };
-const buildTargets = (fragment, manuscript) => {
+const buildTargets = (fragment) => {
     const counters = {};
     for (const nodeType of labelledNodeTypes) {
         counters[nodeType.name] = {
-            label: chooseLabel(nodeType, manuscript),
+            label: chooseLabel(nodeType),
             index: 0,
         };
     }

package/dist/cjs/version.js

@@ -1,4 +1,4 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.VERSION = void 0;
-exports.VERSION = "2.3.19";
+exports.VERSION = "2.3.21-JSR";