@manuscripts/transform 2.3.17 → 2.3.19-LEAN-3577-test

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/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.4';
+    }
+    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/equation_element.js

@@ -22,7 +22,6 @@ exports.equationElement = {
         id: { default: '' },
         label: { default: '' },
         dataTracked: { default: null },
-        comments: { default: null },
     },
     selectable: false,
     group: 'block element',

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

@@ -30,7 +30,6 @@ exports.figureElement = {
         attribution: { default: undefined },
         alternatives: { default: undefined },
         dataTracked: { default: null },
-        comments: { default: null },
     },
     selectable: false,
     group: 'block element executable',

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

@@ -25,7 +25,6 @@ exports.footnote = {
         paragraphStyle: { default: '' },
         placeholder: { default: '' },
         dataTracked: { default: null },
-        comments: { default: null },
     },
     parseDOM: [
         {

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

@@ -19,7 +19,6 @@ exports.inlineEquation = void 0;
 exports.inlineEquation = {
     attrs: {
         dataTracked: { default: null },
-        comments: { default: null },
         id: { default: '' },
         contents: { default: '' },
         format: { default: '' },

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

@@ -22,7 +22,6 @@ exports.keyword = {
     attrs: {
         id: { default: '' },
         dataTracked: { default: null },
-        comments: { default: null },
     },
     group: 'block',
     selectable: false,

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

@@ -26,7 +26,6 @@ exports.listing = {
         isExpanded: { default: false },
         isExecuting: { default: false },
         dataTracked: { default: null },
-        comments: { default: null },
     },
     draggable: false,
     selectable: false,

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

@@ -23,7 +23,6 @@ exports.listingElement = {
         suppressCaption: { default: true },
         suppressTitle: { default: undefined },
         dataTracked: { default: null },
-        comments: { default: null },
     },
     group: 'block element',
     selectable: false,

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

@@ -25,7 +25,6 @@ exports.paragraph = {
         paragraphStyle: { default: '' },
         placeholder: { default: '' },
         dataTracked: { default: null },
-        comments: { default: null },
     },
     group: 'block element',
     selectable: false,

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

@@ -43,7 +43,6 @@ exports.section = {
         generatedLabel: { default: undefined },
         pageBreakStyle: { default: undefined },
         dataTracked: { default: null },
-        comments: { default: null },
     },
     group: 'block sections',
     selectable: false,

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

@@ -29,7 +29,6 @@ exports.tableElement = {
         suppressHeader: { default: false },
         expandListing: { default: false },
         dataTracked: { default: null },
-        comments: { default: null },
     },
     selectable: false,
     group: 'block element executable',

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

@@ -222,7 +222,6 @@ class Decoder {
                     page: model.page,
                     title: model.title,
                     literal: model.literal,
-                    comments: comments.map((c) => c.attrs.id),
                 });
             },
             [object_types_1.ExtraObjectTypes.PlaceholderElement]: (data) => {
@@ -240,7 +239,6 @@ class Decoder {
                     contentType: model.contentType,
                     src: model.src,
                     position: model.position,
-                    comments: comments.map((c) => c.attrs.id),
                 });
             },
             [json_schema_1.ObjectTypes.FigureElement]: (data) => {
@@ -291,7 +289,6 @@ class Decoder {
                     suppressTitle: Boolean(model.suppressTitle === undefined ? true : model.suppressTitle),
                     attribution: model.attribution,
                     alternatives: model.alternatives,
-                    comments: comments.map((c) => c.attrs.id),
                 }, content);
             },
             [json_schema_1.ObjectTypes.Equation]: (data) => {
@@ -338,7 +335,6 @@ class Decoder {
                                 topNode: schema_1.schema.nodes.footnote.create({
                                     id: model._id,
                                     kind: model.kind,
-                                    comments: comments.map((c) => c.attrs.id),
                                 }),
                             });
                             footnotesOfKind.push(footnote);
@@ -359,7 +355,6 @@ class Decoder {
                     topNode: schema_1.schema.nodes.footnote.create({
                         id: footnoteModel._id,
                         kind: footnoteModel.kind,
-                        comments: comments.map((c) => c.attrs.id),
                     }),
                 });
             },
@@ -381,7 +376,6 @@ class Decoder {
                 return schema_1.schema.nodes.keyword_group.create({
                     id: keywordGroup._id,
                     type: keywordGroup.type,
-                    comments: comments.map((c) => c.attrs.id),
                 }, keywords);
             },
             [json_schema_1.ObjectTypes.Keyword]: (data) => {
@@ -391,7 +385,6 @@ class Decoder {
                 return schema_1.schema.nodes.keyword.create({
                     id: keyword._id,
                     contents: keyword.name,
-                    comments: comments.map((c) => c.attrs.id),
                 }, schema_1.schema.text(keyword.name));
             },
             [json_schema_1.ObjectTypes.ListElement]: (data) => {
@@ -405,7 +398,6 @@ class Decoder {
                                 id: model._id,
                                 listStyleType: model.listStyleType || 'order',
                                 paragraphStyle: model.paragraphStyle,
-                                comments: comments.map((c) => c.attrs.id),
                             }),
                         });
                     case 'ul':
@@ -429,7 +421,6 @@ class Decoder {
                     contents: model.contents,
                     language: model.language,
                     languageKey: model.languageKey,
-                    comments: comments.map((c) => c.attrs.id),
                 });
             },
             [json_schema_1.ObjectTypes.ListingElement]: (data) => {
@@ -455,7 +446,6 @@ class Decoder {
                     id: model._id,
                     suppressCaption: model.suppressCaption,
                     suppressTitle: Boolean(model.suppressTitle === undefined ? true : model.suppressTitle),
-                    comments: comments.map((c) => c.attrs.id),
                 }, [listing, figcaption]);
             },
             [json_schema_1.ObjectTypes.MissingFigure]: (data) => {
@@ -474,7 +464,6 @@ class Decoder {
                         id: model._id,
                         paragraphStyle: model.paragraphStyle,
                         placeholder: model.placeholderInnerHTML,
-                        comments: comments.map((c) => c.attrs.id),
                     }),
                 });
             },
@@ -603,7 +592,6 @@ class Decoder {
                     titleSuppressed: model.titleSuppressed,
                     pageBreakStyle: model.pageBreakStyle,
                     generatedLabel: model.generatedLabel,
-                    comments: comments.map((c) => c.attrs.id),
                 }, content);
                 if (!sectionNode) {
                     console.error(model);
@@ -648,7 +636,6 @@ class Decoder {
                     suppressHeader: model.suppressHeader,
                     tableStyle: model.tableStyle,
                     paragraphStyle: model.paragraphStyle,
-                    comments: comments.map((c) => c.attrs.id),
                 }, content);
             },
             [json_schema_1.ObjectTypes.TOCElement]: (data) => {

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/version.js

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