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

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

@@ -19,7 +19,6 @@ export const equationElement = {
         id: { default: '' },
         label: { default: '' },
         dataTracked: { default: null },
-        comments: { default: null },
     },
     selectable: false,
     group: 'block element',

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

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

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

@@ -22,7 +22,6 @@ export const footnote = {
         paragraphStyle: { default: '' },
         placeholder: { default: '' },
         dataTracked: { default: null },
-        comments: { default: null },
     },
     parseDOM: [
         {

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

@@ -16,7 +16,6 @@
 export const inlineEquation = {
     attrs: {
         dataTracked: { default: null },
-        comments: { default: null },
         id: { default: '' },
         contents: { default: '' },
         format: { default: '' },

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

@@ -19,7 +19,6 @@ export const keyword = {
     attrs: {
         id: { default: '' },
         dataTracked: { default: null },
-        comments: { default: null },
     },
     group: 'block',
     selectable: false,

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

@@ -23,7 +23,6 @@ export const listing = {
         isExpanded: { default: false },
         isExecuting: { default: false },
         dataTracked: { default: null },
-        comments: { default: null },
     },
     draggable: false,
     selectable: false,

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

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

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

@@ -22,7 +22,6 @@ export const paragraph = {
         paragraphStyle: { default: '' },
         placeholder: { default: '' },
         dataTracked: { default: null },
-        comments: { default: null },
     },
     group: 'block element',
     selectable: false,

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

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

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

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

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

@@ -213,7 +213,6 @@ export class Decoder {
                     page: model.page,
                     title: model.title,
                     literal: model.literal,
-                    comments: comments.map((c) => c.attrs.id),
                 });
             },
             [ExtraObjectTypes.PlaceholderElement]: (data) => {
@@ -231,7 +230,6 @@ export class Decoder {
                     contentType: model.contentType,
                     src: model.src,
                     position: model.position,
-                    comments: comments.map((c) => c.attrs.id),
                 });
             },
             [ObjectTypes.FigureElement]: (data) => {
@@ -282,7 +280,6 @@ export class Decoder {
                     suppressTitle: Boolean(model.suppressTitle === undefined ? true : model.suppressTitle),
                     attribution: model.attribution,
                     alternatives: model.alternatives,
-                    comments: comments.map((c) => c.attrs.id),
                 }, content);
             },
             [ObjectTypes.Equation]: (data) => {
@@ -329,7 +326,6 @@ export class Decoder {
                                 topNode: schema.nodes.footnote.create({
                                     id: model._id,
                                     kind: model.kind,
-                                    comments: comments.map((c) => c.attrs.id),
                                 }),
                             });
                             footnotesOfKind.push(footnote);
@@ -350,7 +346,6 @@ export class Decoder {
                     topNode: schema.nodes.footnote.create({
                         id: footnoteModel._id,
                         kind: footnoteModel.kind,
-                        comments: comments.map((c) => c.attrs.id),
                     }),
                 });
             },
@@ -372,7 +367,6 @@ export class Decoder {
                 return schema.nodes.keyword_group.create({
                     id: keywordGroup._id,
                     type: keywordGroup.type,
-                    comments: comments.map((c) => c.attrs.id),
                 }, keywords);
             },
             [ObjectTypes.Keyword]: (data) => {
@@ -382,7 +376,6 @@ export class Decoder {
                 return schema.nodes.keyword.create({
                     id: keyword._id,
                     contents: keyword.name,
-                    comments: comments.map((c) => c.attrs.id),
                 }, schema.text(keyword.name));
             },
             [ObjectTypes.ListElement]: (data) => {
@@ -396,7 +389,6 @@ export class Decoder {
                                 id: model._id,
                                 listStyleType: model.listStyleType || 'order',
                                 paragraphStyle: model.paragraphStyle,
-                                comments: comments.map((c) => c.attrs.id),
                             }),
                         });
                     case 'ul':
@@ -420,7 +412,6 @@ export class Decoder {
                     contents: model.contents,
                     language: model.language,
                     languageKey: model.languageKey,
-                    comments: comments.map((c) => c.attrs.id),
                 });
             },
             [ObjectTypes.ListingElement]: (data) => {
@@ -446,7 +437,6 @@ export 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]);
             },
             [ObjectTypes.MissingFigure]: (data) => {
@@ -465,7 +455,6 @@ export class Decoder {
                         id: model._id,
                         paragraphStyle: model.paragraphStyle,
                         placeholder: model.placeholderInnerHTML,
-                        comments: comments.map((c) => c.attrs.id),
                     }),
                 });
             },
@@ -594,7 +583,6 @@ export class Decoder {
                     titleSuppressed: model.titleSuppressed,
                     pageBreakStyle: model.pageBreakStyle,
                     generatedLabel: model.generatedLabel,
-                    comments: comments.map((c) => c.attrs.id),
                 }, content);
                 if (!sectionNode) {
                     console.error(model);
@@ -639,7 +627,6 @@ export class Decoder {
                     suppressHeader: model.suppressHeader,
                     tableStyle: model.tableStyle,
                     paragraphStyle: model.paragraphStyle,
-                    comments: comments.map((c) => c.attrs.id),
                 }, content);
             },
             [ObjectTypes.TOCElement]: (data) => {

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

@@ -1 +1 @@
-export const VERSION = "2.3.17";
+export const VERSION = "2.3.19-LEAN-3577-test";

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/equation_element.d.ts

@@ -15,11 +15,9 @@
  */
 import { NodeSpec } from 'prosemirror-model';
 import { ManuscriptNode } from '../types';
-import { CommentNode } from './comment';
 interface Attrs {
     id: string;
     label: string;
-    comments?: CommentNode[];
 }
 export interface EquationElementNode extends ManuscriptNode {
     attrs: Attrs;

package/dist/types/schema/nodes/figure_element.d.ts

@@ -16,7 +16,6 @@
 import { NodeSpec } from 'prosemirror-model';
 import { ManuscriptNode } from '../types';
 import { AttributionNode } from './attribution';
-import { CommentNode } from './comment';
 interface Attrs {
     columns: number;
     figureLayout: string;
@@ -34,7 +33,6 @@ interface Attrs {
         src: string;
         type?: string;
     }[];
-    comments?: CommentNode[];
 }
 export interface FigureElementNode extends ManuscriptNode {
     attrs: Attrs;

package/dist/types/schema/nodes/footnote.d.ts

@@ -15,14 +15,12 @@
  */
 import { NodeSpec } from 'prosemirror-model';
 import { ManuscriptNode } from '../types';
-import { CommentNode } from './comment';
 type Kind = 'footnote' | 'endnote';
 interface Attrs {
     id: string;
     kind: Kind;
     paragraphStyle?: string;
     placeholder?: string;
-    comments?: CommentNode[];
 }
 export interface FootnoteNode extends ManuscriptNode {
     attrs: Attrs;

package/dist/types/schema/nodes/inline_equation.d.ts

@@ -15,12 +15,10 @@
  */
 import { NodeSpec } from 'prosemirror-model';
 import { ManuscriptNode } from '../types';
-import { CommentNode } from './comment';
 interface Attrs {
     id: string;
     contents: string;
     format: string;
-    comments?: CommentNode[];
 }
 export interface InlineEquationNode extends ManuscriptNode {
     attrs: Attrs;

package/dist/types/schema/nodes/keyword.d.ts

@@ -15,10 +15,8 @@
  */
 import { NodeSpec } from 'prosemirror-model';
 import { ManuscriptNode } from '../types';
-import { CommentNode } from './comment';
 interface Attrs {
     id: string;
-    comments?: CommentNode[];
 }
 export interface KeywordNode extends ManuscriptNode {
     attrs: Attrs;

package/dist/types/schema/nodes/listing.d.ts

@@ -15,7 +15,6 @@
  */
 import { NodeSpec } from 'prosemirror-model';
 import { ManuscriptNode } from '../types';
-import { CommentNode } from './comment';
 interface Attrs {
     id: string;
     contents: string;
@@ -23,7 +22,6 @@ interface Attrs {
     languageKey: string;
     isExpanded: boolean;
     isExecuting: boolean;
-    comments?: CommentNode[];
 }
 export interface ListingNode extends ManuscriptNode {
     attrs: Attrs;

package/dist/types/schema/nodes/listing_element.d.ts

@@ -15,12 +15,10 @@
  */
 import { NodeSpec } from 'prosemirror-model';
 import { ManuscriptNode } from '../types';
-import { CommentNode } from './comment';
 interface Attrs {
     id: string;
     suppressCaption: boolean;
     suppressTitle?: boolean;
-    comments?: CommentNode[];
 }
 export interface ListingElementNode extends ManuscriptNode {
     attrs: Attrs;

package/dist/types/schema/nodes/paragraph.d.ts

@@ -15,12 +15,10 @@
  */
 import { NodeSpec } from 'prosemirror-model';
 import { ManuscriptNode } from '../types';
-import { CommentNode } from './comment';
 interface Attrs {
     id: string;
     paragraphStyle: string;
     placeholder: string;
-    comments?: CommentNode[];
 }
 export interface ParagraphNode extends ManuscriptNode {
     attrs: Attrs;

package/dist/types/schema/nodes/section.d.ts

@@ -15,14 +15,12 @@
  */
 import { NodeSpec } from 'prosemirror-model';
 import { ManuscriptNode } from '../types';
-import { CommentNode } from './comment';
 interface Attrs {
     id: string;
     category?: string;
     titleSuppressed: boolean;
     generatedLabel: boolean;
     pageBreakStyle?: number;
-    comments?: CommentNode[];
 }
 export interface SectionNode extends ManuscriptNode {
     attrs: Attrs;

package/dist/types/schema/nodes/table_element.d.ts

@@ -15,7 +15,6 @@
  */
 import { NodeSpec } from 'prosemirror-model';
 import { ManuscriptNode } from '../types';
-import { CommentNode } from './comment';
 interface Attrs {
     id: string;
     paragraphStyle: string;
@@ -26,7 +25,6 @@ interface Attrs {
     suppressFooter: boolean;
     suppressHeader: boolean;
     expandListing: boolean;
-    comments?: CommentNode[];
 }
 export interface TableElementNode extends ManuscriptNode {
     attrs: Attrs;

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/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/version.d.ts

@@ -1 +1 @@
-export declare const VERSION = "2.3.17";
+export declare const VERSION = "2.3.19-LEAN-3577-test";