@manuscripts/transform 2.3.20 → 2.3.22-LEAN-3772.0

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

@@ -61,33 +61,6 @@ exports.section = {
             },
         },
     ],
-    toDOM: (node) => {
-        const sectionNode = node;
-        const { id, category, titleSuppressed, generatedLabel, pageBreakStyle } = sectionNode.attrs;
-        const classnames = [];
-        if (titleSuppressed) {
-            classnames.push('title-suppressed');
-        }
-        if (typeof generatedLabel === 'undefined' || generatedLabel) {
-            classnames.push('generated-label');
-        }
-        if (pageBreakStyle === exports.PAGE_BREAK_BEFORE ||
-            pageBreakStyle === exports.PAGE_BREAK_BEFORE_AND_AFTER) {
-            classnames.push('page-break-before');
-        }
-        if (pageBreakStyle === exports.PAGE_BREAK_AFTER ||
-            pageBreakStyle === exports.PAGE_BREAK_BEFORE_AND_AFTER) {
-            classnames.push('page-break-after');
-        }
-        const attrs = { id };
-        if (classnames.length) {
-            attrs['class'] = classnames.join(' ');
-        }
-        if (category) {
-            attrs['data-category'] = node.attrs.category;
-        }
-        return ['section', attrs, 0];
-    },
 };
 const isSectionNode = (node) => node.type === node.type.schema.nodes.section;
 exports.isSectionNode = isSectionNode;

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.20";
+exports.VERSION = "2.3.22-LEAN-3772.0";

package/dist/es/index.js

@@ -7,4 +7,5 @@ export * from './jats';
 export * from './types';
 export * from './errors';
 export { getVersion } from './getVersion';
+export { migrateFor } from './schema/migration/migrate';
 export { isSectionLabelNode } from './schema/nodes/section_label';

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

@@ -0,0 +1,42 @@
+import { cloneDeep } from 'lodash';
+import semver from 'semver';
+import { schema } from '..';
+import migrationScripts from './migration-scripts';
+export default 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);
+}
+export function migrateFor(oldDoc, baseVersion) {
+    const migrationScripts = ensureVersionAscOrder();
+    let migratedDoc = cloneDeep(oldDoc);
+    for (let i = 0; i < migrationScripts.length; i++) {
+        const script = migrationScripts[i];
+        if (semver.lt(script.fromVersion, baseVersion)) {
+            continue;
+        }
+        console.log('Migrating doc with script to version ' + script.toVersion);
+        migratedDoc = migrate(migratedDoc, script.migrateNode);
+    }
+    return testDoc(migratedDoc, baseVersion);
+}
+const ensureVersionAscOrder = () => migrationScripts.sort((a, b) => semver.compare(a.toVersion, b.toVersion));
+function testDoc(doc, fromVersion) {
+    try {
+        const resultDoc = 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/es/schema/migration/migration-script.js

@@ -0,0 +1,16 @@
+/*!
+ * © 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.
+ */
+export {};

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

@@ -0,0 +1,28 @@
+/*!
+ * © 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.
+ */
+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;
+    }
+}
+export default Migration125;

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

@@ -0,0 +1,18 @@
+/*!
+ * © 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.
+ */
+import Migration125 from './1.2.5';
+const migrations = [new Migration125()];
+export default migrations;

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

@@ -58,32 +58,5 @@ export const section = {
             },
         },
     ],
-    toDOM: (node) => {
-        const sectionNode = node;
-        const { id, category, titleSuppressed, generatedLabel, pageBreakStyle } = sectionNode.attrs;
-        const classnames = [];
-        if (titleSuppressed) {
-            classnames.push('title-suppressed');
-        }
-        if (typeof generatedLabel === 'undefined' || generatedLabel) {
-            classnames.push('generated-label');
-        }
-        if (pageBreakStyle === PAGE_BREAK_BEFORE ||
-            pageBreakStyle === PAGE_BREAK_BEFORE_AND_AFTER) {
-            classnames.push('page-break-before');
-        }
-        if (pageBreakStyle === PAGE_BREAK_AFTER ||
-            pageBreakStyle === PAGE_BREAK_BEFORE_AND_AFTER) {
-            classnames.push('page-break-after');
-        }
-        const attrs = { id };
-        if (classnames.length) {
-            attrs['class'] = classnames.join(' ');
-        }
-        if (category) {
-            attrs['data-category'] = node.attrs.category;
-        }
-        return ['section', attrs, 0];
-    },
 };
 export const isSectionNode = (node) => node.type === node.type.schema.nodes.section;

package/dist/es/version.js

@@ -1 +1 @@
-export const VERSION = "2.3.20";
+export const VERSION = "2.3.22-LEAN-3772.0";

package/dist/types/index.d.ts

@@ -7,4 +7,5 @@ export * from './jats';
 export * from './types';
 export * from './errors';
 export { getVersion } from './getVersion';
+export { migrateFor, JSONNode } from './schema/migration/migrate';
 export { isSectionLabelNode } from './schema/nodes/section_label';

package/dist/types/schema/migration/migrate.d.ts

@@ -0,0 +1,15 @@
+import { MigrationScript } from './migration-script';
+export type JSONNode = {
+    type: string;
+    attrs: {
+        [key: string]: any;
+    };
+    content?: JSONNode[];
+    text?: string;
+    marks?: Array<{
+        type: string;
+        attrs?: Record<string, any>;
+    }>;
+};
+export default function migrate(oldDoc: JSONNode, migrationScript: MigrationScript['migrateNode']): JSONNode;
+export declare function migrateFor(oldDoc: JSONNode, baseVersion: string): import("prosemirror-model").Node;

package/dist/types/schema/migration/migration-script.d.ts

@@ -0,0 +1,21 @@
+/*!
+ * © 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.
+ */
+import { JSONNode } from './migrate';
+export interface MigrationScript {
+    fromVersion: string;
+    toVersion: string;
+    migrateNode: (node: JSONNode, doc: JSONNode) => JSONNode;
+}

package/dist/types/schema/migration/migration-scripts/1.2.5.d.ts

@@ -0,0 +1,23 @@
+/*!
+ * © 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.
+ */
+import { JSONNode } from '../migrate';
+import { MigrationScript } from '../migration-script';
+declare class Migration125 implements MigrationScript {
+    fromVersion: string;
+    toVersion: string;
+    migrateNode(node: JSONNode, doc: JSONNode): JSONNode;
+}
+export default Migration125;

package/dist/types/schema/migration/migration-scripts/index.d.ts

@@ -0,0 +1,18 @@
+/*!
+ * © 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.
+ */
+import Migration125 from './1.2.5';
+declare const migrations: Migration125[];
+export default migrations;

package/dist/types/version.d.ts

@@ -1 +1 @@
-export declare const VERSION = "2.3.20";
+export declare const VERSION = "2.3.22-LEAN-3772.0";

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@manuscripts/transform",
   "description": "ProseMirror transformer for Manuscripts applications",
-  "version": "2.3.20",
+  "version": "2.3.22-LEAN-3772.0",
   "repository": "github:Atypon-OpenSource/manuscripts-transform",
   "license": "Apache-2.0",
   "main": "dist/cjs",
@@ -34,9 +34,11 @@
     "@manuscripts/library": "1.3.10",
     "debug": "^4.3.4",
     "jszip": "^3.10.1",
+    "lodash": "^4.17.21",
     "mime": "^3.0.0",
     "prosemirror-model": "^1.18.3",
     "prosemirror-tables": "^1.3.5",
+    "semver": "^7.6.2",
     "uuid": "^9.0.0",
     "w3c-xmlserializer": "^4.0.0"
   },
@@ -47,7 +49,7 @@
     "@jats4r/dtds": "^0.0.8",
     "@manuscripts/eslint-config": "^0.5.1",
     "@types/debug": "^4.1.7",
-    "@types/jest": "^29.2.4",
+    "@types/jest": "^29.5.12",
     "@types/lodash.pickby": "^4.6.7",
     "@types/mime": "^3.0.1",
     "@types/node": "^18.11.18",
@@ -72,6 +74,7 @@
     "jest": "^29.3.1",
     "jest-environment-jsdom": "^29.3.1",
     "libxmljs2": "^0.33.0",
+    "migration-base": "npm:@manuscripts/transform@2.3.20",
     "npm-run-all": "^4.1.5",
     "prettier": "^2.8.1",
     "prosemirror-state": "^1.4.2",
@@ -79,4 +82,4 @@
     "rimraf": "^3.0.2",
     "typescript": "^4.0.5"
   }
-}
+}