@manuscripts/transform 1.0.0

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

@@ -0,0 +1,36 @@
+/*!
+ * © 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 { 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;
+}
+export declare const PAGE_BREAK_NONE = 0;
+export declare const PAGE_BREAK_BEFORE = 1;
+export declare const PAGE_BREAK_AFTER = 2;
+export declare const PAGE_BREAK_BEFORE_AND_AFTER = 4;
+export declare const section: NodeSpec;
+export declare const isSectionNode: (node: ManuscriptNode) => node is SectionNode;
+export {};

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

@@ -0,0 +1,22 @@
+/*!
+ * © 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 { NodeSpec } from 'prosemirror-model';
+import { ManuscriptNode } from '../types';
+export interface SectionLabelNode extends ManuscriptNode {
+    attrs: Record<string, unknown>;
+}
+export declare const sectionLabel: NodeSpec;
+export declare const isSectionLabelNode: (node: ManuscriptNode) => node is SectionLabelNode;

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

@@ -0,0 +1,22 @@
+/*!
+ * © 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 { NodeSpec } from 'prosemirror-model';
+import { ManuscriptNode } from '../types';
+export interface SectionTitleNode extends ManuscriptNode {
+    attrs: Record<string, unknown>;
+}
+export declare const sectionTitle: NodeSpec;
+export declare const isSectionTitleNode: (node: ManuscriptNode) => node is SectionTitleNode;

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

@@ -0,0 +1,27 @@
+/*!
+ * © 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 { ManuscriptNode, TableNodeSpec } from '../types';
+import { CommentNode } from './comment';
+export interface TableNode extends ManuscriptNode {
+    attrs: {
+        id: string;
+        headerRows: number;
+        footerRows: number;
+        comments?: CommentNode[];
+    };
+}
+export declare const table: TableNodeSpec;
+export declare const tableBody: TableNodeSpec;

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

@@ -0,0 +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 { ManuscriptNode, TableNodeSpec } from '../types';
+export type TableColGroupNode = ManuscriptNode;
+export interface TableColNode extends ManuscriptNode {
+    attrs: {
+        width: string;
+    };
+}
+export declare const tableColGroup: TableNodeSpec;
+export declare const tableCol: TableNodeSpec;

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

@@ -0,0 +1,35 @@
+/*!
+ * © 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 { NodeSpec } from 'prosemirror-model';
+import { ManuscriptNode } from '../types';
+import { CommentNode } from './comment';
+interface Attrs {
+    id: string;
+    paragraphStyle: string;
+    tableStyle: string;
+    label: string;
+    suppressCaption: boolean;
+    suppressTitle?: boolean;
+    suppressFooter: boolean;
+    suppressHeader: boolean;
+    expandListing: boolean;
+    comments?: CommentNode[];
+}
+export interface TableElementNode extends ManuscriptNode {
+    attrs: Attrs;
+}
+export declare const tableElement: NodeSpec;
+export {};

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

@@ -0,0 +1,41 @@
+/*!
+ * © 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 { TableCellStyleKey } from '../../lib/table-cell-styles';
+import { ManuscriptNode, TableNodeSpec } from '../types';
+export interface TableRowNode extends ManuscriptNode {
+    attrs: {
+        placeholder: string;
+    };
+}
+export declare const tableRow: TableNodeSpec;
+export type TableCellStyles = {
+    [key in TableCellStyleKey]?: string | null;
+};
+export interface TableCellNode extends ManuscriptNode {
+    attrs: {
+        celltype: 'td' | 'th';
+        colspan: number | null;
+        rowspan: number | null;
+        colwidth: number[] | null;
+        placeholder: string | null;
+        styles: TableCellStyles;
+        valign: string | null;
+        align: string | null;
+        scope: string | null;
+        style: string | null;
+    };
+}
+export declare const tableCell: TableNodeSpec;

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

@@ -0,0 +1,17 @@
+/*!
+ * © 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 { NodeSpec } from 'prosemirror-model';
+export declare const text: NodeSpec;

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

@@ -0,0 +1,27 @@
+/*!
+ * © 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 { NodeSpec } from 'prosemirror-model';
+import { ManuscriptNode } from '../types';
+interface Attrs {
+    id: string;
+    contents: string;
+    paragraphStyle: string;
+}
+export interface TOCElementNode extends ManuscriptNode {
+    attrs: Attrs;
+}
+export declare const tocElement: NodeSpec;
+export {};

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

@@ -0,0 +1,26 @@
+/*!
+ * © 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 { NodeSpec } from 'prosemirror-model';
+import { ManuscriptNode } from '../types';
+interface Attrs {
+    id: string;
+}
+export interface TOCSectionNode extends ManuscriptNode {
+    attrs: Attrs;
+}
+export declare const tocSection: NodeSpec;
+export declare const isTOCSectionNode: (node: ManuscriptNode) => node is TOCSectionNode;
+export {};

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

@@ -0,0 +1,45 @@
+/*!
+ * © 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 { Fragment, Mark as ProsemirrorMark, MarkType, Node as ProsemirrorNode, NodeSpec, NodeType, ResolvedPos, Schema, Slice } from 'prosemirror-model';
+import { EditorState, NodeSelection, Plugin, TextSelection, Transaction } from 'prosemirror-state';
+import { EditorView, NodeView } from 'prosemirror-view';
+export type Marks = 'bold' | 'code' | 'italic' | 'smallcaps' | 'strikethrough' | 'styled' | 'subscript' | 'superscript' | 'underline' | 'tracked_insert' | 'tracked_delete';
+export type Nodes = 'attribution' | 'bibliography_item' | 'bibliography_element' | 'bibliography_section' | 'blockquote_element' | 'bullet_list' | 'caption' | 'caption_title' | 'comment' | 'citation' | 'cross_reference' | 'doc' | 'equation' | 'equation_element' | 'figcaption' | 'figure' | 'graphical_abstract_section' | 'figure_element' | 'footnote' | 'footnotes_element' | 'footnotes_section' | 'hard_break' | 'highlight_marker' | 'inline_equation' | 'inline_footnote' | 'keywords_element' | 'keywords_section' | 'link' | 'list_item' | 'listing' | 'listing_element' | 'manuscript' | 'missing_figure' | 'ordered_list' | 'paragraph' | 'placeholder' | 'placeholder_element' | 'pullquote_element' | 'section' | 'section_label' | 'section_title' | 'table' | 'table_body' | 'table_cell' | 'table_element' | 'table_row' | 'table_colgroup' | 'table_col' | 'text' | 'toc_element' | 'toc_section';
+export type ManuscriptSchema = Schema<Nodes, Marks>;
+export type ManuscriptEditorState = EditorState;
+export type ManuscriptEditorView = EditorView;
+export type ManuscriptFragment = Fragment;
+export type ManuscriptMark = ProsemirrorMark;
+export type ManuscriptNode = ProsemirrorNode;
+export type ManuscriptNodeSelection = NodeSelection;
+export type ManuscriptTextSelection = TextSelection;
+export type ManuscriptMarkType = MarkType;
+export type ManuscriptNodeType = NodeType;
+export type ManuscriptNodeView = NodeView;
+export type ManuscriptResolvedPos = ResolvedPos;
+export type ManuscriptPlugin = Plugin;
+export type ManuscriptSlice = Slice;
+export type ManuscriptTransaction = Transaction;
+export interface TableNodeSpec extends NodeSpec {
+    tableRole: string;
+}
+export type DataTrackedAttrs = {
+    id: string;
+    status: string;
+    operation: string;
+    userID: string;
+    createdAt: number;
+};

package/dist/types/tests.d.ts

@@ -0,0 +1,16 @@
+/*!
+ * © 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.
+ */
+export {};

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

@@ -0,0 +1,74 @@
+/*!
+ * © 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 { Affiliation, Attribution, AuxiliaryObjectReference, BibliographicDate, BibliographicName, BibliographyItem, Citation, CitationItem, Color, CommentAnnotation, Contribution, Contributor, ContributorRole, Corresponding, ElementsOrder, EmbeddedModel, Figure, Footnote, FootnotesOrder, Highlight, HighlightMarker, InlineMathFragment, InlineStyle, Journal, Keyword, KeywordGroup, LibraryCollection, Manuscript, ManuscriptKeyword, ManuscriptNote, ObjectTypes, ParagraphElement, Project, RequirementsValidation, RequirementsValidationData, Section, StatusLabel, Submission, Supplement, UserProfileAffiliation, UserProfileFootNote } from '@manuscripts/manuscripts-json-schema';
+import { FootnotesOrderIndexList } from './footnotes-order';
+import { CommentSelector, ManuscriptModel, ModelAttachment } from './models';
+export declare const DEFAULT_BUNDLE = "MPBundle:www-zotero-org-styles-nature";
+export declare const DEFAULT_PAGE_LAYOUT = "MPPageLayout:defaultA4";
+export type Build<T> = Pick<T, Exclude<keyof T, keyof ManuscriptModel>> & {
+    _id: string;
+    objectType: string;
+    contributions?: Contribution[];
+};
+export type BuildEmbedded<T extends EmbeddedModel, O> = Pick<T, Exclude<keyof T, keyof ManuscriptModel>> & {
+    _id: string;
+    objectType: O;
+};
+export declare const buildProject: (owner: string) => Build<Project>;
+export declare const buildManuscript: (title?: string) => Build<Manuscript>;
+export type ContributorRoleType = 'author';
+export declare const buildContributor: (bibliographicName: BibliographicName, role?: ContributorRoleType, priority?: number, userID?: string, invitationID?: string) => Build<Contributor>;
+export declare const buildBibliographyItem: (data: Partial<Build<BibliographyItem>>) => Build<BibliographyItem>;
+export declare const buildBibliographicName: (data: Partial<BibliographicName>) => BuildEmbedded<BibliographicName, ObjectTypes.BibliographicName>;
+export declare const buildBibliographicDate: (data: Partial<BibliographicDate>) => BuildEmbedded<BibliographicDate, ObjectTypes.BibliographicDate>;
+export declare const buildAuxiliaryObjectReference: (containingObject: string, rids: string[]) => Build<AuxiliaryObjectReference>;
+export declare const buildEmbeddedCitationItem: (bibliographyItem: string) => CitationItem;
+export declare const buildCitation: (containingObject: string, embeddedCitationItems: string[]) => Build<Citation>;
+export declare const buildKeyword: (name: string) => Build<Keyword>;
+export declare const buildKeywordGroup: (attributes: {
+    type?: string;
+    title?: string;
+    label?: string;
+}) => Build<KeywordGroup>;
+export declare const buildManuscriptKeyword: (name: string) => Build<ManuscriptKeyword>;
+export declare const buildLibraryCollection: (owner: string, name: string) => Build<LibraryCollection>;
+export declare const buildFigure: (blob: Blob) => Build<Figure & ModelAttachment>;
+export declare const buildAffiliation: (institution: string, priority?: number) => Build<Affiliation>;
+export declare const buildSupplementaryMaterial: (title: string, href: string) => Build<Supplement>;
+export declare const buildUserProfileAffiliation: (institution: string, priority?: number) => Build<UserProfileAffiliation>;
+export declare const buildComment: (target: string, contents?: string, selector?: CommentSelector, contributions?: Contribution[], annotationColor?: string) => Build<CommentAnnotation>;
+export declare const buildNote: (target: string, source: 'EMAIL' | 'EDITOR' | 'DASHBOARD', contents?: string) => Build<ManuscriptNote>;
+export declare const buildValidation: (results: RequirementsValidationData[]) => Build<RequirementsValidation>;
+export declare const buildInlineMathFragment: (containingObject: string, TeXRepresentation: string) => Build<InlineMathFragment>;
+export declare const buildFootnote: (containingObject: string, contents: string, kind?: 'footnote' | 'endnote') => Build<Footnote>;
+export declare const buildFootnotesOrder: (footnotesList: FootnotesOrderIndexList) => Build<FootnotesOrder>;
+export declare const buildCorresp: (contents: string) => Build<Corresponding>;
+export declare const buildSection: (priority?: number, path?: string[]) => Build<Section>;
+export declare const buildParagraph: (placeholderInnerHTML: string) => Build<ParagraphElement>;
+export declare const buildColor: (value: string, priority: number) => Build<Color>;
+export declare const buildHighlight: () => Build<Highlight>;
+export declare const buildHighlightMarker: (highlightID: string, start: boolean, offset: number, field: 'caption' | 'contents' | 'title') => Build<HighlightMarker>;
+export declare const buildContribution: (profileID: string) => Contribution;
+export declare const buildContributorRole: (name: string) => Build<ContributorRole>;
+export declare const buildInlineStyle: (priority: number, title?: string) => Build<InlineStyle>;
+export declare const buildAttribution: () => Build<Attribution>;
+export declare const buildSubmission: () => Build<Submission>;
+export declare const buildJournal: () => Build<Journal>;
+export declare const buildStatusLabel: (name: string) => Build<StatusLabel>;
+export declare const buildUserFootNote: (noteId: string, content: string) => Build<UserProfileFootNote>;
+export type AuxiliaryObjects = 'MPFigureElement' | 'MPTableElement' | 'MPListingElement' | 'MPEquationElement';
+export declare const auxiliaryObjectTypes: Set<import("prosemirror-model").NodeType>;
+export declare const buildElementsOrder: (elementType: AuxiliaryObjects) => Build<ElementsOrder>;

package/dist/types/transformer/bundles-data.d.ts

@@ -0,0 +1,3 @@
+import { Bundle } from '@manuscripts/manuscripts-json-schema';
+export declare const loadBundlesMap: () => Promise<Map<string, Bundle>>;
+export declare const loadIssnBundleIndex: () => Promise<Record<string, string>>;

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

@@ -0,0 +1,3 @@
+import { Bundle } from '@manuscripts/manuscripts-json-schema';
+export declare const createParentBundle: (bundle: Bundle, bundles: Map<string, Bundle>) => Bundle | undefined;
+export declare const createNewBundle: (bundleID: string, bundles: Map<string, Bundle>) => Bundle;

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

@@ -0,0 +1,38 @@
+/*!
+ * © 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 { CommentAnnotation, Model, Section } from '@manuscripts/manuscripts-json-schema';
+import { ParseOptions } from 'prosemirror-model';
+import { ManuscriptNode } from '../schema';
+export declare const getModelData: <T extends Model>(model: Model) => T;
+export declare const getModelsByType: <T extends Model>(modelMap: Map<string, Model>, objectType: string) => T[];
+export declare const sortSectionsByPriority: (a: Section, b: Section) => number;
+export declare const isManuscriptNode: (model: ManuscriptNode | null) => model is import("prosemirror-model").Node;
+export declare class Decoder {
+    private readonly modelMap;
+    private readonly allowMissingElements;
+    private creators;
+    private createCommentsNode;
+    private getComments;
+    private extractListing;
+    constructor(modelMap: Map<string, Model>, allowMissingElements?: boolean);
+    decode: (model: Model) => ManuscriptNode | null;
+    getModel: <T extends Model>(id: string) => T | undefined;
+    createArticleNode: (manuscriptID?: string) => ManuscriptNode;
+    addGeneratedLabels: (sections: Section[]) => Section[];
+    parseContents: (contents: string, wrapper?: string, commentAnnotations?: CommentAnnotation[], options?: ParseOptions) => ManuscriptNode;
+    private getManuscriptID;
+    private getFigcaption;
+}

package/dist/types/transformer/document-object-types.d.ts

@@ -0,0 +1,17 @@
+/*!
+ * © 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';
+export declare const documentObjectTypes: ObjectTypes[];

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

@@ -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 { CommentAnnotation, Model } from '@manuscripts/manuscripts-json-schema';
+import { ManuscriptNode } from '../schema';
+import { Build } from './builders';
+export declare const inlineContents: (node: ManuscriptNode) => string;
+export declare const inlineText: (node: ManuscriptNode) => string;
+export declare const modelFromNode: (node: ManuscriptNode, parent: ManuscriptNode, path: string[], priority: PrioritizedValue) => {
+    model: Model;
+    commentAnnotationsMap: Map<string, Build<CommentAnnotation>>;
+};
+interface PrioritizedValue {
+    value: number;
+}
+export declare const encode: (node: ManuscriptNode) => Map<string, Model>;
+export {};

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

@@ -0,0 +1,16 @@
+/*!
+ * © 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.
+ */
+export declare const generateAttachmentFilename: (id: string, contentType?: string) => string;

package/dist/types/transformer/footnote-category.d.ts

@@ -0,0 +1,17 @@
+/*!
+ * © 2021 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 type FootnoteType = 'con' | 'conflict' | 'deceased' | 'equal' | 'financial-disclosure' | 'present-address' | 'presented-at' | 'previously-at' | 'supplementary-material' | 'supported-by';
+export declare const buildFootnoteCategory: (category: string) => string | undefined;

package/dist/types/transformer/footnotes-order.d.ts

@@ -0,0 +1,23 @@
+/*!
+ * © 2022 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 { FootnotesOrder } from '@manuscripts/manuscripts-json-schema';
+export type FootnotesOrderIndexList = {
+    id: string;
+    index: number;
+}[];
+export declare const createOrderedFootnotesIDs: (doc: Document) => string[];
+export declare const handleFootnotesOrder: (orderedFootnotesIDs: Array<string>, replacements: Map<string, string>, footnotesOrder: FootnotesOrder) => void;
+export declare const createEmptyFootnotesOrder: () => import("./builders").Build<FootnotesOrder>;

package/dist/types/transformer/highlight-markers.d.ts

@@ -0,0 +1,26 @@
+/*!
+ * © 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 { CommentAnnotation, Model } from '@manuscripts/manuscripts-json-schema';
+import { Build } from './builders';
+export type HighlightableField = 'title' | 'caption' | 'contents';
+export declare const isHighlightableModel: (model: Model) => model is HighlightableModel;
+export interface HighlightableModel extends Model {
+    contents?: string;
+    title?: string;
+    caption?: string;
+}
+export declare const extractHighlightMarkers: (model: HighlightableModel, commentAnnotationsMap: Map<string, Build<CommentAnnotation>>) => void;
+export declare const insertHighlightMarkers: (contents: string, commentAnnotations: CommentAnnotation[]) => string;

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

@@ -0,0 +1,36 @@
+/*!
+ * © 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/manuscripts-json-schema';
+import { ManuscriptFragment } from '../schema';
+import { IDGenerator, MediaPathGenerator } from '../types';
+export interface HTMLExporterOptions {
+    idGenerator?: IDGenerator;
+    mediaPathGenerator?: MediaPathGenerator;
+}
+export declare class HTMLTransformer {
+    private document;
+    private modelMap;
+    private labelTargets?;
+    serializeToHTML: (fragment: ManuscriptFragment, modelMap: Map<string, Model>, options?: HTMLExporterOptions) => Promise<string>;
+    protected rewriteMediaPaths: (mediaPathGenerator: MediaPathGenerator) => Promise<void>;
+    protected rewriteIDs: (idGenerator?: IDGenerator) => Promise<void>;
+    private buildFront;
+    private buildContributors;
+    private buildBody;
+    private idSelector;
+    private fixFigure;
+    private fixBody;
+}