@manuscripts/transform 1.0.0

package/dist/es/transformer/builders.js

@@ -0,0 +1,261 @@
+/*!
+ * © 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/manuscripts-json-schema';
+import serializeToXML from 'w3c-xmlserializer';
+import { schema } from '../schema';
+import { generateID } from './id';
+import { timestamp } from './timestamp';
+export const DEFAULT_BUNDLE = 'MPBundle:www-zotero-org-styles-nature';
+export const DEFAULT_PAGE_LAYOUT = 'MPPageLayout:defaultA4';
+export const buildProject = (owner) => ({
+    _id: generateID(ObjectTypes.Project),
+    objectType: ObjectTypes.Project,
+    owners: [owner],
+    writers: [],
+    viewers: [],
+    title: '',
+});
+export const buildManuscript = (title = '') => ({
+    _id: generateID(ObjectTypes.Manuscript),
+    objectType: ObjectTypes.Manuscript,
+    title,
+});
+export const buildContributor = (bibliographicName, role = 'author', priority = 0, userID, invitationID) => ({
+    _id: generateID(ObjectTypes.Contributor),
+    objectType: ObjectTypes.Contributor,
+    priority,
+    role,
+    affiliations: [],
+    bibliographicName: buildBibliographicName(bibliographicName),
+    userID,
+    invitationID,
+});
+export const buildBibliographyItem = (data) => (Object.assign(Object.assign({}, data), { type: data.type || 'article-journal', _id: generateID(ObjectTypes.BibliographyItem), objectType: ObjectTypes.BibliographyItem }));
+export const buildBibliographicName = (data) => (Object.assign(Object.assign({}, data), { _id: generateID(ObjectTypes.BibliographicName), objectType: ObjectTypes.BibliographicName }));
+export const buildBibliographicDate = (data) => (Object.assign(Object.assign({}, data), { _id: generateID(ObjectTypes.BibliographicDate), objectType: ObjectTypes.BibliographicDate }));
+export const buildAuxiliaryObjectReference = (containingObject, rids) => {
+    const auxiliaryObjectReference = {
+        _id: generateID(ObjectTypes.AuxiliaryObjectReference),
+        objectType: ObjectTypes.AuxiliaryObjectReference,
+        containingObject: containingObject || undefined,
+    };
+    if (rids.length < 2) {
+        Object.assign(auxiliaryObjectReference, { referencedObject: rids[0] });
+    }
+    else {
+        Object.assign(auxiliaryObjectReference, { referencedObjects: rids });
+    }
+    return auxiliaryObjectReference;
+};
+export const buildEmbeddedCitationItem = (bibliographyItem) => ({
+    _id: generateID(ObjectTypes.CitationItem),
+    objectType: ObjectTypes.CitationItem,
+    bibliographyItem,
+});
+export const buildCitation = (containingObject, embeddedCitationItems) => ({
+    _id: generateID(ObjectTypes.Citation),
+    objectType: ObjectTypes.Citation,
+    containingObject: containingObject || undefined,
+    embeddedCitationItems: embeddedCitationItems.map(buildEmbeddedCitationItem),
+});
+export const buildKeyword = (name) => ({
+    _id: generateID(ObjectTypes.Keyword),
+    objectType: ObjectTypes.Keyword,
+    name,
+});
+export const buildKeywordGroup = (attributes) => (Object.assign(Object.assign(Object.assign({ _id: generateID(ObjectTypes.KeywordGroup), objectType: ObjectTypes.KeywordGroup }, (attributes.type && { type: attributes.type })), (attributes.title && { title: attributes.title })), (attributes.label && { label: attributes.label })));
+export const buildManuscriptKeyword = (name) => ({
+    _id: generateID(ObjectTypes.ManuscriptKeyword),
+    objectType: ObjectTypes.ManuscriptKeyword,
+    name,
+});
+export const buildLibraryCollection = (owner, name) => ({
+    _id: generateID(ObjectTypes.LibraryCollection),
+    objectType: ObjectTypes.LibraryCollection,
+    owners: [owner],
+    writers: [],
+    viewers: [],
+    name,
+});
+export const buildFigure = (blob) => ({
+    _id: generateID(ObjectTypes.Figure),
+    objectType: ObjectTypes.Figure,
+    contentType: blob.type,
+    src: window.URL.createObjectURL(blob),
+    attachment: {
+        id: 'image',
+        type: blob.type,
+        data: blob,
+    },
+});
+export const buildAffiliation = (institution, priority = 0) => ({
+    _id: generateID(ObjectTypes.Affiliation),
+    objectType: ObjectTypes.Affiliation,
+    institution,
+    priority,
+});
+export const buildSupplementaryMaterial = (title, href) => ({
+    _id: generateID(ObjectTypes.Supplement),
+    objectType: ObjectTypes.Supplement,
+    title,
+    href,
+});
+export const buildUserProfileAffiliation = (institution, priority = 0) => ({
+    _id: generateID(ObjectTypes.UserProfileAffiliation),
+    objectType: ObjectTypes.UserProfileAffiliation,
+    institution,
+    priority,
+});
+export const buildComment = (target, contents = '', selector, contributions, annotationColor) => ({
+    _id: generateID(ObjectTypes.CommentAnnotation),
+    objectType: ObjectTypes.CommentAnnotation,
+    target,
+    selector,
+    contents,
+    contributions,
+    annotationColor,
+});
+export const buildNote = (target, source, contents = '') => ({
+    _id: generateID(ObjectTypes.ManuscriptNote),
+    objectType: ObjectTypes.ManuscriptNote,
+    target,
+    source,
+    contents,
+});
+export const buildValidation = (results) => ({
+    _id: generateID(ObjectTypes.RequirementsValidation),
+    objectType: ObjectTypes.RequirementsValidation,
+    results,
+});
+export const buildInlineMathFragment = (containingObject, TeXRepresentation) => ({
+    _id: generateID(ObjectTypes.InlineMathFragment),
+    objectType: ObjectTypes.InlineMathFragment,
+    containingObject: containingObject || undefined,
+    TeXRepresentation,
+});
+export const buildFootnote = (containingObject, contents, kind = 'footnote') => ({
+    _id: generateID(ObjectTypes.Footnote),
+    objectType: ObjectTypes.Footnote,
+    containingObject: containingObject || undefined,
+    contents,
+    kind,
+});
+export const buildFootnotesOrder = (footnotesList) => ({
+    _id: generateID(ObjectTypes.FootnotesOrder),
+    objectType: ObjectTypes.FootnotesOrder,
+    footnotesList,
+});
+export const buildCorresp = (contents) => ({
+    _id: generateID(ObjectTypes.Corresponding),
+    objectType: ObjectTypes.Corresponding,
+    contents,
+});
+export const buildSection = (priority = 0, path = []) => {
+    const id = generateID(ObjectTypes.Section);
+    return {
+        _id: id,
+        objectType: ObjectTypes.Section,
+        priority,
+        path: path.concat(id),
+    };
+};
+export const buildParagraph = (placeholderInnerHTML) => {
+    const _id = generateID(ObjectTypes.ParagraphElement);
+    const element = document.createElementNS('http://www.w3.org/1999/xhtml', 'p');
+    element.setAttribute('id', _id);
+    element.setAttribute('class', 'MPElement');
+    if (placeholderInnerHTML) {
+        element.setAttribute('data-placeholder-text', placeholderInnerHTML);
+    }
+    const contents = serializeToXML(element);
+    return {
+        _id,
+        objectType: ObjectTypes.ParagraphElement,
+        elementType: 'p',
+        contents,
+        placeholderInnerHTML,
+    };
+};
+export const buildColor = (value, priority) => ({
+    _id: generateID(ObjectTypes.Color),
+    objectType: ObjectTypes.Color,
+    priority,
+    value,
+});
+export const buildHighlight = () => ({
+    _id: generateID(ObjectTypes.Highlight),
+    objectType: ObjectTypes.Highlight,
+});
+export const buildHighlightMarker = (highlightID, start, offset, field) => ({
+    highlightID,
+    objectType: ObjectTypes.HighlightMarker,
+    _id: generateID(ObjectTypes.HighlightMarker),
+    start,
+    offset,
+    field,
+});
+export const buildContribution = (profileID) => ({
+    _id: generateID(ObjectTypes.Contribution),
+    objectType: ObjectTypes.Contribution,
+    profileID,
+    timestamp: timestamp(),
+});
+export const buildContributorRole = (name) => ({
+    _id: generateID(ObjectTypes.ContributorRole),
+    objectType: ObjectTypes.ContributorRole,
+    name,
+});
+export const buildInlineStyle = (priority, title) => ({
+    _id: generateID(ObjectTypes.InlineStyle),
+    objectType: ObjectTypes.InlineStyle,
+    priority,
+    title,
+});
+export const buildAttribution = () => ({
+    _id: generateID(ObjectTypes.Attribution),
+    objectType: ObjectTypes.Attribution,
+});
+export const buildSubmission = () => ({
+    _id: generateID(ObjectTypes.Submission),
+    objectType: ObjectTypes.Submission,
+});
+export const buildJournal = () => ({
+    _id: generateID(ObjectTypes.Journal),
+    objectType: ObjectTypes.Journal,
+});
+export const buildStatusLabel = (name) => ({
+    _id: generateID(ObjectTypes.StatusLabel),
+    objectType: ObjectTypes.StatusLabel,
+    name,
+});
+export const buildUserFootNote = (noteId, content) => ({
+    _id: generateID(ObjectTypes.UserProfileFootNote),
+    objectType: ObjectTypes.UserProfileFootNote,
+    noteId,
+    content,
+});
+export const auxiliaryObjectTypes = new Set([
+    schema.nodes.figure_element,
+    schema.nodes.table_element,
+    schema.nodes.equation_element,
+    schema.nodes.listing_element,
+]);
+export const buildElementsOrder = (elementType) => ({
+    _id: generateID(ObjectTypes.ElementsOrder),
+    objectType: ObjectTypes.ElementsOrder,
+    elementType: elementType,
+    elements: [],
+});

package/dist/es/transformer/bundles-data.js

@@ -0,0 +1,8 @@
+export const loadBundlesMap = async () => {
+    const { default: bundles } = await import('@manuscripts/data/dist/shared/bundles.json');
+    return new Map(bundles.map((bundle) => [bundle._id, bundle]));
+};
+export const loadIssnBundleIndex = async () => {
+    const { default: issnBundleIndex } = await import('@manuscripts/data/dist/shared/issn-bundle-index.json');
+    return issnBundleIndex;
+};

package/dist/es/transformer/bundles.js

@@ -0,0 +1,27 @@
+import { fromPrototype } from './manuscript-dependencies';
+const findBundleByURL = (url, bundles) => {
+    for (const bundle of bundles.values()) {
+        if (bundle.csl && bundle.csl['self-URL'] === url) {
+            return bundle;
+        }
+    }
+};
+export const createParentBundle = (bundle, bundles) => {
+    if (bundle.csl) {
+        const parentURL = bundle.csl['independent-parent-URL'];
+        if (parentURL) {
+            const parentBundle = findBundleByURL(parentURL, bundles);
+            if (!parentBundle) {
+                throw new Error(`Bundle with URL not found: ${parentURL} `);
+            }
+            return fromPrototype(parentBundle);
+        }
+    }
+};
+export const createNewBundle = (bundleID, bundles) => {
+    const bundle = bundles.get(bundleID);
+    if (!bundle) {
+        throw new Error(`Bundle not found: ${bundleID}`);
+    }
+    return fromPrototype(bundle);
+};