@manuscripts/transform 2.3.5-LEAN-3608.2 → 2.3.5-LEAN-3608.5

package/dist/cjs/schema/groups.js

@@ -15,11 +15,10 @@
  * limitations under the License.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.hasGroup = exports.GROUP_SECTION = exports.GROUP_LIST = exports.GROUP_EXECUTABLE = exports.GROUP_ELEMENT = exports.GROUP_BLOCK = void 0;
+exports.hasGroup = exports.GROUP_SECTION = exports.GROUP_EXECUTABLE = exports.GROUP_ELEMENT = exports.GROUP_BLOCK = void 0;
 exports.GROUP_BLOCK = 'block';
 exports.GROUP_ELEMENT = 'element';
 exports.GROUP_EXECUTABLE = 'executable';
-exports.GROUP_LIST = 'list';
 exports.GROUP_SECTION = 'sections';
 const hasGroup = (nodeType, groupName) => {
     const { group } = nodeType.spec;

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

@@ -1,32 +1,29 @@
 "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.
- */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.isListNode = exports.listItem = exports.list = exports.JATS_HTML_LIST_STYLE_MAPPING = void 0;
+exports.isListNode = exports.listItem = exports.list = exports.getListType = void 0;
 const json_schema_1 = require("@manuscripts/json-schema");
 const attributes_1 = require("../../lib/attributes");
-exports.JATS_HTML_LIST_STYLE_MAPPING = {
-    simple: { style: 'none', type: 'ul' },
-    bullet: { style: 'disc', type: 'ul' },
-    order: { style: 'decimal', type: 'ol' },
-    'alpha-lower': { style: 'lower-alpha', type: 'ol' },
-    'alpha-upper': { style: 'upper-alpha', type: 'ol' },
-    'roman-lower': { style: 'lower-roman', type: 'ol' },
-    'roman-upper': { style: 'upper-roman', type: 'ol' },
+const getListType = (style) => {
+    switch (style) {
+        case 'simple':
+            return { type: 'ul', style: 'none' };
+        case 'bullet':
+            return { type: 'ul', style: 'disc' };
+        case 'order':
+            return { type: 'ol', style: 'decimal' };
+        case 'alpha-lower':
+            return { type: 'ol', style: 'lower-alpha' };
+        case 'alpha-upper':
+            return { type: 'ol', style: 'upper-alpha' };
+        case 'roman-lower':
+            return { type: 'ol', style: 'lower-roman' };
+        case 'roman-upper':
+            return { type: 'ol', style: 'upper-roman' };
+        default:
+            throw new Error(`Unsupported style type: ${style}`);
+    }
 };
+exports.getListType = getListType;
 exports.list = {
     content: 'list_item+',
     group: 'block list element',
@@ -59,28 +56,18 @@ exports.list = {
         },
     ],
     toDOM: (node) => {
-        const ListNode = node;
-        return exports.JATS_HTML_LIST_STYLE_MAPPING[ListNode.attrs.listStyleType].type === 'ul'
-            ? [
-                'ul',
-                {
-                    id: ListNode.attrs.id,
-                    'list-type': ListNode.attrs.listStyleType,
-                    class: (0, attributes_1.buildElementClass)(ListNode.attrs),
-                    'data-object-type': json_schema_1.ObjectTypes.ListElement,
-                },
-                0,
-            ]
-            : [
-                'ol',
-                {
-                    id: ListNode.attrs.id,
-                    'list-type': ListNode.attrs.listStyleType,
-                    class: (0, attributes_1.buildElementClass)(ListNode.attrs),
-                    'data-object-type': json_schema_1.ObjectTypes.ListElement,
-                },
-                0,
-            ];
+        const list = node;
+        const { type } = (0, exports.getListType)(list.attrs.listStyleType);
+        return [
+            type,
+            {
+                id: list.attrs.id,
+                'list-type': list.attrs.listStyleType,
+                class: (0, attributes_1.buildElementClass)(list.attrs),
+                'data-object-type': json_schema_1.ObjectTypes.ListElement,
+            },
+            0,
+        ];
     },
 };
 exports.listItem = {

package/dist/cjs/transformer/decode.js

@@ -392,7 +392,7 @@ class Decoder {
                         return this.parseContents(model.contents || '<ol></ol>', undefined, this.getComments(model), {
                             topNode: schema_1.schema.nodes.list.create({
                                 id: model._id,
-                                listStyleType: model.listStyleType,
+                                listStyleType: model.listStyleType || 'order',
                                 paragraphStyle: model.paragraphStyle,
                                 comments: comments.map((c) => c.attrs.id),
                             }),
@@ -401,7 +401,7 @@ class Decoder {
                         return this.parseContents(model.contents || '<ul></ul>', undefined, this.getComments(model), {
                             topNode: schema_1.schema.nodes.list.create({
                                 id: model._id,
-                                listStyleType: model.listStyleType,
+                                listStyleType: model.listStyleType || 'bullet',
                                 paragraphStyle: model.paragraphStyle,
                             }),
                         });

package/dist/cjs/transformer/encode.js

@@ -327,7 +327,7 @@ const encoders = {
         quoteType: 'block',
     }),
     list: (node) => ({
-        elementType: schema_1.JATS_HTML_LIST_STYLE_MAPPING[node.attrs.listStyleType].type,
+        elementType: (0, schema_1.getListType)(node.attrs.listStyleType).type,
         contents: listContents(node),
         listStyleType: node.attrs.listStyleType,
         paragraphStyle: node.attrs.paragraphStyle || undefined,

package/dist/es/schema/groups.js

@@ -16,7 +16,6 @@
 export const GROUP_BLOCK = 'block';
 export const GROUP_ELEMENT = 'element';
 export const GROUP_EXECUTABLE = 'executable';
-export const GROUP_LIST = 'list';
 export const GROUP_SECTION = 'sections';
 export const hasGroup = (nodeType, groupName) => {
     const { group } = nodeType.spec;

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

@@ -1,28 +1,24 @@
-/*!
- * © 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 { ObjectTypes } from '@manuscripts/json-schema';
 import { buildElementClass } from '../../lib/attributes';
-export const JATS_HTML_LIST_STYLE_MAPPING = {
-    simple: { style: 'none', type: 'ul' },
-    bullet: { style: 'disc', type: 'ul' },
-    order: { style: 'decimal', type: 'ol' },
-    'alpha-lower': { style: 'lower-alpha', type: 'ol' },
-    'alpha-upper': { style: 'upper-alpha', type: 'ol' },
-    'roman-lower': { style: 'lower-roman', type: 'ol' },
-    'roman-upper': { style: 'upper-roman', type: 'ol' },
+export const getListType = (style) => {
+    switch (style) {
+        case 'simple':
+            return { type: 'ul', style: 'none' };
+        case 'bullet':
+            return { type: 'ul', style: 'disc' };
+        case 'order':
+            return { type: 'ol', style: 'decimal' };
+        case 'alpha-lower':
+            return { type: 'ol', style: 'lower-alpha' };
+        case 'alpha-upper':
+            return { type: 'ol', style: 'upper-alpha' };
+        case 'roman-lower':
+            return { type: 'ol', style: 'lower-roman' };
+        case 'roman-upper':
+            return { type: 'ol', style: 'upper-roman' };
+        default:
+            throw new Error(`Unsupported style type: ${style}`);
+    }
 };
 export const list = {
     content: 'list_item+',
@@ -56,28 +52,18 @@ export const list = {
         },
     ],
     toDOM: (node) => {
-        const ListNode = node;
-        return JATS_HTML_LIST_STYLE_MAPPING[ListNode.attrs.listStyleType].type === 'ul'
-            ? [
-                'ul',
-                {
-                    id: ListNode.attrs.id,
-                    'list-type': ListNode.attrs.listStyleType,
-                    class: buildElementClass(ListNode.attrs),
-                    'data-object-type': ObjectTypes.ListElement,
-                },
-                0,
-            ]
-            : [
-                'ol',
-                {
-                    id: ListNode.attrs.id,
-                    'list-type': ListNode.attrs.listStyleType,
-                    class: buildElementClass(ListNode.attrs),
-                    'data-object-type': ObjectTypes.ListElement,
-                },
-                0,
-            ];
+        const list = node;
+        const { type } = getListType(list.attrs.listStyleType);
+        return [
+            type,
+            {
+                id: list.attrs.id,
+                'list-type': list.attrs.listStyleType,
+                class: buildElementClass(list.attrs),
+                'data-object-type': ObjectTypes.ListElement,
+            },
+            0,
+        ];
     },
 };
 export const listItem = {

package/dist/es/transformer/decode.js

@@ -383,7 +383,7 @@ export class Decoder {
                         return this.parseContents(model.contents || '<ol></ol>', undefined, this.getComments(model), {
                             topNode: schema.nodes.list.create({
                                 id: model._id,
-                                listStyleType: model.listStyleType,
+                                listStyleType: model.listStyleType || 'order',
                                 paragraphStyle: model.paragraphStyle,
                                 comments: comments.map((c) => c.attrs.id),
                             }),
@@ -392,7 +392,7 @@ export class Decoder {
                         return this.parseContents(model.contents || '<ul></ul>', undefined, this.getComments(model), {
                             topNode: schema.nodes.list.create({
                                 id: model._id,
-                                listStyleType: model.listStyleType,
+                                listStyleType: model.listStyleType || 'bullet',
                                 paragraphStyle: model.paragraphStyle,
                             }),
                         });

package/dist/es/transformer/encode.js

@@ -16,7 +16,7 @@
 import { DOMSerializer } from 'prosemirror-model';
 import serializeToXML from 'w3c-xmlserializer';
 import { iterateChildren } from '../lib/utils';
-import { hasGroup, isHighlightMarkerNode, isManuscriptNode, isSectionNode, JATS_HTML_LIST_STYLE_MAPPING, schema, } from '../schema';
+import { getListType, hasGroup, isHighlightMarkerNode, isManuscriptNode, isSectionNode, schema, } from '../schema';
 import { auxiliaryObjectTypes, buildAttribution, buildElementsOrder, buildFootnotesOrder, } from './builders';
 import { extractCommentMarkers } from './highlight-markers';
 import { nodeTypesMap } from './node-types';
@@ -319,7 +319,7 @@ const encoders = {
         quoteType: 'block',
     }),
     list: (node) => ({
-        elementType: JATS_HTML_LIST_STYLE_MAPPING[node.attrs.listStyleType].type,
+        elementType: getListType(node.attrs.listStyleType).type,
         contents: listContents(node),
         listStyleType: node.attrs.listStyleType,
         paragraphStyle: node.attrs.paragraphStyle || undefined,

package/dist/types/schema/groups.d.ts

@@ -17,6 +17,5 @@ import { ManuscriptNodeType } from './types';
 export declare const GROUP_BLOCK = "block";
 export declare const GROUP_ELEMENT = "element";
 export declare const GROUP_EXECUTABLE = "executable";
-export declare const GROUP_LIST = "list";
 export declare const GROUP_SECTION = "sections";
 export declare const hasGroup: (nodeType: ManuscriptNodeType, groupName: string) => boolean;

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

@@ -1,28 +1,11 @@
-/*!
- * © 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 { ListElement } from '@manuscripts/json-schema';
 import { NodeSpec } from 'prosemirror-model';
 import { ManuscriptNode } from '../types';
-export type JatsStyleType = NonNullable<ListElement['listStyleType']>;
-export declare const JATS_HTML_LIST_STYLE_MAPPING: {
-    [key in JatsStyleType]: {
-        style: string;
-        type: string;
-    };
-};
+export type JatsStyleType = 'simple' | 'bullet' | 'order' | 'alpha-lower' | 'alpha-upper' | 'roman-lower' | 'roman-upper';
+interface ListTypeInfo {
+    type: 'ul' | 'ol';
+    style: string;
+}
+export declare const getListType: (style: JatsStyleType) => ListTypeInfo;
 export interface ListNode extends ManuscriptNode {
     attrs: {
         id: string;
@@ -38,3 +21,4 @@ export interface ListItemNode extends ManuscriptNode {
 }
 export declare const listItem: NodeSpec;
 export declare const isListNode: (node: ManuscriptNode) => node is ListNode;
+export {};

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@manuscripts/transform",
   "description": "ProseMirror transformer for Manuscripts applications",
-  "version": "2.3.5-LEAN-3608.2",
+  "version": "2.3.5-LEAN-3608.5",
   "repository": "github:Atypon-OpenSource/manuscripts-transform",
   "license": "Apache-2.0",
   "main": "dist/cjs",