@manuscripts/transform 2.3.19 → 2.3.21-JSR

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/jats/jats-exporter.js

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

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

@@ -18,6 +18,9 @@ export const manuscript = {
     attrs: {
         id: { default: '' },
         doi: { default: '' },
+        prototype: { default: '' },
+        primaryLanguageCode: { default: '' },
+        articleType: { default: '' },
     },
     group: 'block',
     parseDOM: [

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

@@ -0,0 +1,29 @@
+/*!
+ * © 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.
+ */
+import projectDump from '../../../__tests__/data/project-dump.json';
+import { Decoder } from '../../decode';
+export const createTestModelMap = () => {
+    const modelMap = new Map();
+    for (const component of projectDump.data) {
+        modelMap.set(component._id, component);
+    }
+    return modelMap;
+};
+export const createTestDoc = () => {
+    const modelMap = createTestModelMap();
+    const decoder = new Decoder(modelMap);
+    return decoder.createArticleNode();
+};

package/dist/es/transformer/decode.js

@@ -718,9 +718,13 @@ export class Decoder {
                 this.createCommentsNode(),
             ];
             const contents = nodes.filter((node) => node !== false);
+            const props = this.getManuscript();
             return 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) => {
@@ -766,10 +770,10 @@ export class Decoder {
                 }
             }
         };
-        this.getManuscriptDOI = () => {
+        this.getManuscript = () => {
             for (const item of this.modelMap.values()) {
                 if (isManuscript(item)) {
-                    return item.DOI;
+                    return item;
                 }
             }
         };

package/dist/es/transformer/html.js

@@ -69,8 +69,7 @@ export class HTMLTransformer {
         this.serializeToHTML = async (fragment, modelMap, options = {}) => {
             const { idGenerator, mediaPathGenerator } = options;
             this.modelMap = modelMap;
-            const manuscript = findManuscript(this.modelMap);
-            this.labelTargets = buildTargets(fragment, manuscript);
+            this.labelTargets = 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/es/transformer/index.js

@@ -33,3 +33,4 @@ export * from './section-category';
 export * from './serializer';
 export * from './timestamp';
 export * from './update-identifiers';
+export { createTestDoc } from './__tests__/__helpers__/doc';

package/dist/es/transformer/labels.js

@@ -21,28 +21,15 @@ const labelledNodeTypes = [
     schema.nodes.equation_element,
     schema.nodes.listing_element,
 ];
-const labelProperties = new Map([
-    [schema.nodes.figure_element, 'figureElementLabel'],
-    [schema.nodes.table_element, 'tableElementLabel'],
-    [schema.nodes.equation_element, 'equationElementLabel'],
-    [schema.nodes.listing_element, 'listingElementLabel'],
-]);
 const excludedTypes = [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 nodeNames.get(nodeType);
 };
-export const buildTargets = (fragment, manuscript) => {
+export const buildTargets = (fragment) => {
     const counters = {};
     for (const nodeType of labelledNodeTypes) {
         counters[nodeType.name] = {
-            label: chooseLabel(nodeType, manuscript),
+            label: chooseLabel(nodeType),
             index: 0,
         };
     }

package/dist/es/version.js

@@ -1 +1 @@
-export const VERSION = "2.3.19";
+export const VERSION = "2.3.21-JSR";

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/schema/nodes/manuscript.d.ts

@@ -19,6 +19,9 @@ export interface ActualManuscriptNode extends ManuscriptNode {
     attrs: {
         id: string;
         doi: string;
+        articleType: string;
+        prototype: string;
+        primaryLanguageCode: string;
     };
 }
 export declare const manuscript: NodeSpec;

package/dist/types/transformer/__tests__/__helpers__/doc.d.ts

@@ -0,0 +1,18 @@
+/*!
+ * © 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.
+ */
+import { Model } from '@manuscripts/json-schema';
+export declare const createTestModelMap: () => Map<string, Model>;
+export declare const createTestDoc: () => import("prosemirror-model").Node;

package/dist/types/transformer/decode.d.ts

@@ -42,7 +42,7 @@ export declare class Decoder {
     addGeneratedLabels: (sections: Section[]) => Section[];
     parseContents: (contents: string, wrapper?: string, commentAnnotations?: CommentAnnotation[], options?: ParseOptions) => ManuscriptNode;
     private getManuscriptID;
-    private getManuscriptDOI;
+    private getManuscript;
     private getFigcaption;
     private createTable;
     private createTableColGroup;

package/dist/types/transformer/index.d.ts

@@ -33,3 +33,4 @@ export * from './section-category';
 export * from './serializer';
 export * from './timestamp';
 export * from './update-identifiers';
+export { createTestDoc } from './__tests__/__helpers__/doc';

package/dist/types/transformer/labels.d.ts

@@ -13,7 +13,6 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-import { Manuscript } from '@manuscripts/json-schema';
 import { ManuscriptFragment } from '../schema';
 export interface Target {
     type: string;
@@ -21,4 +20,4 @@ export interface Target {
     label: string;
     caption: string;
 }
-export declare const buildTargets: (fragment: ManuscriptFragment, manuscript: Manuscript) => Map<string, Target>;
+export declare const buildTargets: (fragment: ManuscriptFragment) => Map<string, Target>;

package/dist/types/version.d.ts

@@ -1 +1 @@
-export declare const VERSION = "2.3.19";
+export declare const VERSION = "2.3.21-JSR";

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@manuscripts/transform",
   "description": "ProseMirror transformer for Manuscripts applications",
-  "version": "2.3.19",
+  "version": "2.3.21-JSR",
   "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"
   }
-}
+}