@manuscripts/transform 4.0.1 → 4.1.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.migrateFor = exports.getVersion = void 0;
+exports.migrateFor = exports.CreditVocabTerm = exports.getVersion = void 0;
 __exportStar(require("./errors"), exports);
 var getVersion_1 = require("./getVersion");
 Object.defineProperty(exports, "getVersion", { enumerable: true, get: function () { return getVersion_1.getVersion; } });
@@ -23,6 +23,8 @@ __exportStar(require("./jats/types"), exports);
 __exportStar(require("./lib/footnotes"), exports);
 __exportStar(require("./lib/utils"), exports);
 __exportStar(require("./lib/section-categories"), exports);
+var credit_roles_1 = require("./lib/credit-roles");
+Object.defineProperty(exports, "CreditVocabTerm", { enumerable: true, get: function () { return credit_roles_1.CreditVocabTerm; } });
 __exportStar(require("./lib/citeproc"), exports);
 __exportStar(require("./schema"), exports);
 var migrate_1 = require("./schema/migration/migrate");

package/dist/cjs/jats/exporter/jats-exporter.js

@@ -1057,10 +1057,10 @@ class JATSExporter {
                             contrib.appendChild(xref);
                         });
                     }
-                    if (contributor.attrs.CRediTRoles) {
-                        contributor.attrs.CRediTRoles.forEach((cr) => {
+                    if (contributor.attrs.creditRoles) {
+                        contributor.attrs.creditRoles.forEach((cr) => {
                             const role = this.createElement('role');
-                            const creditUrl = credit_roles_1.CRediTRoleUrls.get(cr.vocabTerm);
+                            const creditUrl = credit_roles_1.CreditRoleUrls.get(cr.vocabTerm);
                             if (creditUrl) {
                                 role.setAttribute('vocab-identifier', 'http://credit.niso.org/');
                                 role.setAttribute('vocab', 'CRediT');

package/dist/cjs/jats/importer/jats-dom-parser.js

@@ -414,7 +414,7 @@ class JATSDOMParser {
                             ObjectType: json_schema_1.ObjectTypes.BibliographicName,
                         },
                         ORCIDIdentifier: (0, utils_1.getTrimmedTextContent)(element, 'contrib-id[contrib-id-type="orcid"]'),
-                        CRediTRoles: (0, utils_1.getCRediTRoleRole)(element),
+                        creditRoles: (0, utils_1.getCreditRole)(element),
                         priority: this.parsePriority(element.getAttribute('priority')),
                         email: (0, utils_1.getTrimmedTextContent)(element, 'email') || '',
                         prefix: (0, utils_1.getTrimmedTextContent)(element, 'prefix'),

package/dist/cjs/lib/credit-roles.js

@@ -15,62 +15,79 @@
  * limitations under the License.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.CRediTRoleUrls = void 0;
-exports.CRediTRoleUrls = new Map([
+exports.CreditRoleUrls = exports.CreditVocabTerm = void 0;
+var CreditVocabTerm;
+(function (CreditVocabTerm) {
+    CreditVocabTerm["Conceptualization"] = "Conceptualization";
+    CreditVocabTerm["DataCuration"] = "Data curation";
+    CreditVocabTerm["FormalAnalysis"] = "Formal analysis";
+    CreditVocabTerm["FundingAcquisition"] = "Funding acquisition";
+    CreditVocabTerm["Investigation"] = "Investigation";
+    CreditVocabTerm["Methodology"] = "Methodology";
+    CreditVocabTerm["ProjectAdministration"] = "Project administration";
+    CreditVocabTerm["Resources"] = "Resources";
+    CreditVocabTerm["Software"] = "Software";
+    CreditVocabTerm["Supervision"] = "Supervision";
+    CreditVocabTerm["Validation"] = "Validation";
+    CreditVocabTerm["Visualization"] = "Visualization";
+    CreditVocabTerm["WritingOriginalDraft"] = "Writing \u2013 original draft";
+    CreditVocabTerm["WritingReviewEditing"] = "Writing \u2013 review & editing";
+})(CreditVocabTerm = exports.CreditVocabTerm || (exports.CreditVocabTerm = {}));
+exports.CreditRoleUrls = new Map([
     [
-        "Conceptualization",
+        CreditVocabTerm.Conceptualization,
         'https://credit.niso.org/contributor-roles/conceptualization/',
     ],
     [
-        "Data curation",
+        CreditVocabTerm.DataCuration,
         'https://credit.niso.org/contributor-roles/data-curation/',
     ],
     [
-        "Formal analysis",
+        CreditVocabTerm.FormalAnalysis,
         'https://credit.niso.org/contributor-roles/formal-analysis/',
     ],
     [
-        "Funding acquisition",
+        CreditVocabTerm.FundingAcquisition,
         'https://credit.niso.org/contributor-roles/funding-acquisition/',
     ],
     [
-        "Investigation",
+        CreditVocabTerm.Investigation,
         'https://credit.niso.org/contributor-roles/investigation/',
     ],
     [
-        "Methodology",
+        CreditVocabTerm.Methodology,
         'https://credit.niso.org/contributor-roles/methodology/',
     ],
     [
-        "ProjectAdministration",
+        CreditVocabTerm.ProjectAdministration,
         'https://credit.niso.org/contributor-roles/project-administration/',
     ],
     [
-        "Resources",
+        CreditVocabTerm.Resources,
         'https://credit.niso.org/contributor-roles/resources/',
     ],
     [
-        "Software",
+        CreditVocabTerm.Software,
         'https://credit.niso.org/contributor-roles/software/',
     ],
     [
-        "Supervision",
+        CreditVocabTerm.Supervision,
         'https://credit.niso.org/contributor-roles/supervision/',
     ],
     [
-        "Validation",
+        CreditVocabTerm.Validation,
         'https://credit.niso.org/contributor-roles/validation/',
     ],
     [
-        "Visualization",
+        CreditVocabTerm.Visualization,
         'https://credit.niso.org/contributor-roles/visualization/',
     ],
     [
-        "Writing \u2013 original draft",
+        CreditVocabTerm.WritingOriginalDraft,
         'https://credit.niso.org/contributor-roles/writing-original-draft/',
     ],
     [
-        "Writing \u2013 review & editing",
+        CreditVocabTerm.WritingReviewEditing,
         'https://credit.niso.org/contributor-roles/writing-review-editing/',
     ],
 ]);

package/dist/cjs/lib/utils.js

@@ -15,7 +15,7 @@
  * limitations under the License.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getCRediTRoleRole = exports.dateToTimestamp = exports.getHTMLContent = exports.getTrimmedTextContent = exports.findParentNodeClosestToPos = exports.isInBibliographySection = exports.isInGraphicalAbstractSection = exports.findNodePositions = exports.iterateChildren = void 0;
+exports.getCreditRole = exports.dateToTimestamp = exports.getHTMLContent = exports.getTrimmedTextContent = exports.findParentNodeClosestToPos = exports.isInBibliographySection = exports.isInGraphicalAbstractSection = exports.findNodePositions = exports.iterateChildren = void 0;
 const jats_parser_utils_1 = require("../jats/importer/jats-parser-utils");
 const schema_1 = require("../schema");
 const credit_roles_1 = require("./credit-roles");
@@ -102,12 +102,12 @@ const dateToTimestamp = (dateElement) => {
     return Date.UTC(values[0], values[1] - 1, values[2]) / 1000;
 };
 exports.dateToTimestamp = dateToTimestamp;
-function getCRediTRoleRole(elem) {
+function getCreditRole(elem) {
     const sources = elem.querySelectorAll('role[vocab="CRediT"][vocab-identifier="http://credit.niso.org/"][vocab-term][vocab-term-identifier]');
     const results = [];
     sources.forEach((source) => {
         if (source &&
-            credit_roles_1.CRediTRoleUrls.has(source.getAttribute('vocab-term'))) {
+            credit_roles_1.CreditRoleUrls.has(source.getAttribute('vocab-term'))) {
             const result = {
                 vocabTerm: source.getAttribute('vocab-term'),
             };
@@ -116,4 +116,4 @@ function getCRediTRoleRole(elem) {
     });
     return results;
 }
-exports.getCRediTRoleRole = getCRediTRoleRole;
+exports.getCreditRole = getCreditRole;

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

@@ -17,7 +17,7 @@ exports.contributor = {
         isJointContributor: { default: undefined },
         ORCIDIdentifier: { default: undefined },
         priority: { default: undefined },
-        CRediTRoles: { default: [] },
+        creditRoles: { default: [] },
         dataTracked: { default: null },
         contents: { default: '' },
         prefix: { default: '' },

package/dist/cjs/version.js

@@ -1,4 +1,4 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.VERSION = void 0;
-exports.VERSION = "4.0.1";
+exports.VERSION = "4.1.0";

package/dist/es/index.js

@@ -5,6 +5,7 @@ export * from './jats/types';
 export * from './lib/footnotes';
 export * from './lib/utils';
 export * from './lib/section-categories';
+export { CreditVocabTerm } from './lib/credit-roles';
 export * from './lib/citeproc';
 export * from './schema';
 export { migrateFor } from './schema/migration/migrate';

package/dist/es/jats/exporter/jats-exporter.js

@@ -18,7 +18,7 @@ import { DOMParser as ProsemirrorDOMParser, DOMSerializer, } from 'prosemirror-m
 import { findChildrenByAttr, findChildrenByType } from 'prosemirror-utils';
 import serializeToXML from 'w3c-xmlserializer';
 import { buildCiteprocCitation } from '../../lib/citeproc';
-import { CRediTRoleUrls } from '../../lib/credit-roles';
+import { CreditRoleUrls } from '../../lib/credit-roles';
 import { generateFootnoteLabels } from '../../lib/footnotes';
 import { nodeFromHTML } from '../../lib/html';
 import { isBibliographyItemNode, isCitationNode, isNodeOfType, schema, } from '../../schema';
@@ -1027,10 +1027,10 @@ export class JATSExporter {
                             contrib.appendChild(xref);
                         });
                     }
-                    if (contributor.attrs.CRediTRoles) {
-                        contributor.attrs.CRediTRoles.forEach((cr) => {
+                    if (contributor.attrs.creditRoles) {
+                        contributor.attrs.creditRoles.forEach((cr) => {
                             const role = this.createElement('role');
-                            const creditUrl = CRediTRoleUrls.get(cr.vocabTerm);
+                            const creditUrl = CreditRoleUrls.get(cr.vocabTerm);
                             if (creditUrl) {
                                 role.setAttribute('vocab-identifier', 'http://credit.niso.org/');
                                 role.setAttribute('vocab', 'CRediT');

package/dist/es/jats/importer/jats-dom-parser.js

@@ -15,7 +15,7 @@
  */
 import { buildContribution, ObjectTypes } from '@manuscripts/json-schema';
 import { DOMParser, Fragment } from 'prosemirror-model';
-import { dateToTimestamp, getCRediTRoleRole, getHTMLContent, getTrimmedTextContent, } from '../../lib/utils';
+import { dateToTimestamp, getCreditRole, getHTMLContent, getTrimmedTextContent, } from '../../lib/utils';
 import { DEFAULT_PROFILE_ID } from './jats-comments';
 export class JATSDOMParser {
     constructor(sectionCategories, schema) {
@@ -411,7 +411,7 @@ export class JATSDOMParser {
                             ObjectType: ObjectTypes.BibliographicName,
                         },
                         ORCIDIdentifier: getTrimmedTextContent(element, 'contrib-id[contrib-id-type="orcid"]'),
-                        CRediTRoles: getCRediTRoleRole(element),
+                        creditRoles: getCreditRole(element),
                         priority: this.parsePriority(element.getAttribute('priority')),
                         email: getTrimmedTextContent(element, 'email') || '',
                         prefix: getTrimmedTextContent(element, 'prefix'),

package/dist/es/lib/credit-roles.js

@@ -13,61 +13,78 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-export const CRediTRoleUrls = new Map([
+export var CreditVocabTerm;
+(function (CreditVocabTerm) {
+    CreditVocabTerm["Conceptualization"] = "Conceptualization";
+    CreditVocabTerm["DataCuration"] = "Data curation";
+    CreditVocabTerm["FormalAnalysis"] = "Formal analysis";
+    CreditVocabTerm["FundingAcquisition"] = "Funding acquisition";
+    CreditVocabTerm["Investigation"] = "Investigation";
+    CreditVocabTerm["Methodology"] = "Methodology";
+    CreditVocabTerm["ProjectAdministration"] = "Project administration";
+    CreditVocabTerm["Resources"] = "Resources";
+    CreditVocabTerm["Software"] = "Software";
+    CreditVocabTerm["Supervision"] = "Supervision";
+    CreditVocabTerm["Validation"] = "Validation";
+    CreditVocabTerm["Visualization"] = "Visualization";
+    CreditVocabTerm["WritingOriginalDraft"] = "Writing \u2013 original draft";
+    CreditVocabTerm["WritingReviewEditing"] = "Writing \u2013 review & editing";
+})(CreditVocabTerm || (CreditVocabTerm = {}));
+export const CreditRoleUrls = new Map([
     [
-        "Conceptualization",
+        CreditVocabTerm.Conceptualization,
         'https://credit.niso.org/contributor-roles/conceptualization/',
     ],
     [
-        "Data curation",
+        CreditVocabTerm.DataCuration,
         'https://credit.niso.org/contributor-roles/data-curation/',
     ],
     [
-        "Formal analysis",
+        CreditVocabTerm.FormalAnalysis,
         'https://credit.niso.org/contributor-roles/formal-analysis/',
     ],
     [
-        "Funding acquisition",
+        CreditVocabTerm.FundingAcquisition,
         'https://credit.niso.org/contributor-roles/funding-acquisition/',
     ],
     [
-        "Investigation",
+        CreditVocabTerm.Investigation,
         'https://credit.niso.org/contributor-roles/investigation/',
     ],
     [
-        "Methodology",
+        CreditVocabTerm.Methodology,
         'https://credit.niso.org/contributor-roles/methodology/',
     ],
     [
-        "ProjectAdministration",
+        CreditVocabTerm.ProjectAdministration,
         'https://credit.niso.org/contributor-roles/project-administration/',
     ],
     [
-        "Resources",
+        CreditVocabTerm.Resources,
         'https://credit.niso.org/contributor-roles/resources/',
     ],
     [
-        "Software",
+        CreditVocabTerm.Software,
         'https://credit.niso.org/contributor-roles/software/',
     ],
     [
-        "Supervision",
+        CreditVocabTerm.Supervision,
         'https://credit.niso.org/contributor-roles/supervision/',
     ],
     [
-        "Validation",
+        CreditVocabTerm.Validation,
         'https://credit.niso.org/contributor-roles/validation/',
     ],
     [
-        "Visualization",
+        CreditVocabTerm.Visualization,
         'https://credit.niso.org/contributor-roles/visualization/',
     ],
     [
-        "Writing \u2013 original draft",
+        CreditVocabTerm.WritingOriginalDraft,
         'https://credit.niso.org/contributor-roles/writing-original-draft/',
     ],
     [
-        "Writing \u2013 review & editing",
+        CreditVocabTerm.WritingReviewEditing,
         'https://credit.niso.org/contributor-roles/writing-review-editing/',
     ],
 ]);

package/dist/es/lib/utils.js

@@ -15,7 +15,7 @@
  */
 import { htmlFromJatsNode } from '../jats/importer/jats-parser-utils';
 import { isBibliographySectionNode, isGraphicalAbstractSectionNode, } from '../schema';
-import { CRediTRoleUrls } from './credit-roles';
+import { CreditRoleUrls } from './credit-roles';
 export function* iterateChildren(node, recurse = false) {
     for (let i = 0; i < node.childCount; i++) {
         const child = node.child(i);
@@ -91,12 +91,12 @@ export const dateToTimestamp = (dateElement) => {
     }
     return Date.UTC(values[0], values[1] - 1, values[2]) / 1000;
 };
-export function getCRediTRoleRole(elem) {
+export function getCreditRole(elem) {
     const sources = elem.querySelectorAll('role[vocab="CRediT"][vocab-identifier="http://credit.niso.org/"][vocab-term][vocab-term-identifier]');
     const results = [];
     sources.forEach((source) => {
         if (source &&
-            CRediTRoleUrls.has(source.getAttribute('vocab-term'))) {
+            CreditRoleUrls.has(source.getAttribute('vocab-term'))) {
             const result = {
                 vocabTerm: source.getAttribute('vocab-term'),
             };

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

@@ -14,7 +14,7 @@ export const contributor = {
         isJointContributor: { default: undefined },
         ORCIDIdentifier: { default: undefined },
         priority: { default: undefined },
-        CRediTRoles: { default: [] },
+        creditRoles: { default: [] },
         dataTracked: { default: null },
         contents: { default: '' },
         prefix: { default: '' },

package/dist/es/version.js

@@ -1 +1 @@
-export const VERSION = "4.0.1";
+export const VERSION = "4.1.0";

package/dist/types/index.d.ts

@@ -5,6 +5,7 @@ export * from './jats/types';
 export * from './lib/footnotes';
 export * from './lib/utils';
 export * from './lib/section-categories';
+export { CreditVocabTerm } from './lib/credit-roles';
 export * from './lib/citeproc';
 export * from './schema';
 export { migrateFor } from './schema/migration/migrate';

package/dist/types/lib/credit-roles.d.ts

@@ -13,14 +13,14 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-export declare const enum CreditVocabTerm {
+export declare enum CreditVocabTerm {
     Conceptualization = "Conceptualization",
     DataCuration = "Data curation",
     FormalAnalysis = "Formal analysis",
     FundingAcquisition = "Funding acquisition",
     Investigation = "Investigation",
     Methodology = "Methodology",
-    ProjectAdministration = "ProjectAdministration",
+    ProjectAdministration = "Project administration",
     Resources = "Resources",
     Software = "Software",
     Supervision = "Supervision",
@@ -29,4 +29,4 @@ export declare const enum CreditVocabTerm {
     WritingOriginalDraft = "Writing \u2013 original draft",
     WritingReviewEditing = "Writing \u2013 review & editing"
 }
-export declare const CRediTRoleUrls: Map<CreditVocabTerm, string>;
+export declare const CreditRoleUrls: Map<CreditVocabTerm, string>;

package/dist/types/lib/utils.d.ts

@@ -14,7 +14,7 @@
  * limitations under the License.
  */
 import { Node as ProsemirrorNode, ResolvedPos } from 'prosemirror-model';
-import { CRediTRole, ManuscriptEditorState, ManuscriptNode } from '../schema';
+import { CreditRole, ManuscriptEditorState, ManuscriptNode } from '../schema';
 export declare function iterateChildren(node: ManuscriptNode, recurse?: boolean): Iterable<ManuscriptNode>;
 export declare const findNodePositions: (state: ManuscriptEditorState, predicate: (node: ManuscriptNode) => boolean) => number[];
 export declare const isInGraphicalAbstractSection: ($pos: ResolvedPos) => boolean;
@@ -28,4 +28,4 @@ export declare const findParentNodeClosestToPos: ($pos: ResolvedPos, predicate:
 export declare const getTrimmedTextContent: (node: Element | Document | null, selector?: string) => string | undefined;
 export declare const getHTMLContent: (node: Element, querySelector: string) => string | undefined;
 export declare const dateToTimestamp: (dateElement: Element) => number | undefined;
-export declare function getCRediTRoleRole(elem: Element): CRediTRole[];
+export declare function getCreditRole(elem: Element): CreditRole[];

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

@@ -1,6 +1,6 @@
 import { NodeSpec } from 'prosemirror-model';
 import { ManuscriptNode } from '../types';
-interface Email {
+export interface Email {
     href: string;
     text: string;
 }

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

@@ -10,9 +10,8 @@ export type ContributorFootnote = {
     noteID: string;
     noteLabel: string;
 };
-export type CRediTRole = {
+export type CreditRole = {
     vocabTerm: CreditVocabTerm;
-    degreeContribution?: string;
 };
 interface Attrs {
     id: string;
@@ -29,7 +28,7 @@ interface Attrs {
     isJointContributor: boolean;
     footnote: ContributorFootnote[];
     prefix: string;
-    CRediTRoles?: CRediTRole[];
+    creditRoles?: CreditRole[];
 }
 export interface ContributorNode extends ManuscriptNode {
     attrs: Attrs;

package/dist/types/version.d.ts

@@ -1 +1 @@
-export declare const VERSION = "4.0.1";
+export declare const VERSION = "4.1.0";

package/package.json

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