meca 1.0.4 → 1.0.5

package/dist/transfer-1.0.dtd

@@ -0,0 +1,44 @@
+<!-- DOCTYPE manifest PUBLIC “-//MECA//DTD Transfer v1.0//en" "https://meca.zip/transfer-1.0.dtd" -->
+<!-- ============================================================= -->
+<!-- SPECIAL CHARACTER MODULES -->
+<!-- ============================================================= -->
+<!-- SPECIAL CHARACTERS DECLARATIONS -->
+<!-- Declares any standard XML special character
+ entities used in this DTD -->
+<!ENTITY % xmlspecchars.ent
+ PUBLIC
+"-//NLM//DTD JATS (Z39.96) JATS DTD Suite XML Special Characters Module v1.2 20190208//EN"
+"JATS-xmlspecchars1.ent" >
+<!-- CUSTOM SPECIAL CHARACTERS DECLARATIONS -->
+<!-- Declares any custom special character
+ entities created for this Suite -->
+<!ENTITY % chars.ent PUBLIC
+"-//NLM//DTD JATS (Z39.96) JATS DTD Suite Custom Special Characters Module v1.2
+20190208//EN"
+"JATS-chars1.ent" >
+<!ELEMENT transfer (transfer-source, destination, processing-instructions?)>
+<!ATTLIST transfer xmlns CDATA #FIXED "https://manuscriptexchange.org/schema/transfer">
+<!ATTLIST transfer transfer-version CDATA #REQUIRED>
+<!ELEMENT transfer-source (service-provider?, publication, security?)>
+<!ELEMENT service-provider (provider-name?, contact?)>
+<!ELEMENT provider-name (#PCDATA)>
+<!ELEMENT contact (contact-name?, (email|phone)+)>
+<!ATTLIST contact contact-role CDATA #IMPLIED>
+<!ELEMENT contact-name (surname?, given-names?)>
+<!ELEMENT surname (#PCDATA)>
+<!ELEMENT given-names (#PCDATA)>
+<!ELEMENT email (#PCDATA)>
+<!ELEMENT phone (#PCDATA)>
+<!ELEMENT publication (publication-title, acronym?, contact?)>
+<!ATTLIST publication type CDATA #IMPLIED>
+<!ELEMENT publication-title (#PCDATA)>
+<!ELEMENT acronym (#PCDATA)>
+<!ELEMENT security (authentication-code)>
+<!ELEMENT authentication-code (#PCDATA)>
+<!ELEMENT destination (service-provider, publication, security?)>
+<!-- The processing instructions tag is a placeholder for implementation-specific instructions between
+vendors and publishers-->
+<!ELEMENT processing-instructions (processing-instruction*, processing-comments?)>
+<!ELEMENT processing-instruction (#PCDATA)>
+<!ATTLIST processing-instruction processing-sequence CDATA #IMPLIED>
+<!ELEMENT processing-comments (#PCDATA)>

package/dist/transfer.d.ts

@@ -0,0 +1,71 @@
+import type { GenericParent } from 'myst-common';
+import type { Element, DeclarationAttributes } from 'xml-js';
+import type { Logger } from 'myst-cli-utils';
+export declare const TRANSFER = "transfer.xml";
+export declare const TRANSFER_DTD = "transfer-1.0.dtd";
+type Options = {
+    log?: Logger;
+};
+export type Contact = {
+    role?: string;
+    name?: {
+        surname?: string;
+        given?: string;
+    };
+    email?: string;
+    phone?: string;
+};
+export type ServiceProvider = {
+    name?: string;
+    contact?: Contact;
+};
+export type Publication = {
+    type?: string;
+    title?: string;
+    acronym?: string;
+    contact?: Contact;
+};
+export type Security = {
+    auth?: string;
+};
+export type Location = {
+    provider?: ServiceProvider;
+    publication?: Publication;
+    security?: Security;
+};
+export type Instruction = {
+    sequence?: string;
+    instruction?: string;
+};
+export type ProcessingInstructions = {
+    instructions?: Instruction[];
+    comments?: string[];
+};
+export type Transfer = {
+    source?: Location;
+    destination?: Location;
+    instructions?: ProcessingInstructions;
+};
+export declare class TransferXml {
+    declaration?: DeclarationAttributes;
+    doctype?: string;
+    rawXML: string;
+    raw: Element;
+    log: Logger;
+    tree: GenericParent;
+    constructor(data: string, opts?: Options);
+    get localDtd(): string;
+    validateXml(remoteDtd?: string): Promise<boolean | undefined>;
+    get version(): string;
+    get source(): Location | undefined;
+    get destination(): Location | undefined;
+    get instructions(): ProcessingInstructions | undefined;
+}
+type WriteOptions = {
+    /** Some providers want a simplified XML output that changes the names of some of the XML elements. */
+    simplifiedXML?: boolean;
+    dtdUrl?: string;
+};
+export declare function createTransferXml(transfer: Transfer, opts?: WriteOptions): string;
+export {};
+//# sourceMappingURL=transfer.d.ts.map

package/dist/transfer.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"transfer.d.ts","sourceRoot":"","sources":["../src/transfer.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAe,aAAa,EAAE,MAAM,aAAa,CAAC;AAE9D,OAAO,KAAK,EAAE,OAAO,EAAE,qBAAqB,EAAE,MAAM,QAAQ,CAAC;AAE7D,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,gBAAgB,CAAC;AAK7C,eAAO,MAAM,QAAQ,iBAAiB,CAAC;AACvC,eAAO,MAAM,YAAY,qBAAqB,CAAC;AAE/C,KAAK,OAAO,GAAG;IAAE,GAAG,CAAC,EAAE,MAAM,CAAA;CAAE,CAAC;AAEhC,MAAM,MAAM,OAAO,GAAG;IACpB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,IAAI,CAAC,EAAE;QAAE,OAAO,CAAC,EAAE,MAAM,CAAC;QAAC,KAAK,CAAC,EAAE,MAAM,CAAA;KAAE,CAAC;IAC5C,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB,CAAC;AAEF,MAAM,MAAM,eAAe,GAAG;IAC5B,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,OAAO,CAAC,EAAE,OAAO,CAAC;CACnB,CAAC;AAEF,MAAM,MAAM,WAAW,GAAG;IACxB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,OAAO,CAAC,EAAE,OAAO,CAAC;CACnB,CAAC;AAEF,MAAM,MAAM,QAAQ,GAAG;IACrB,IAAI,CAAC,EAAE,MAAM,CAAC;CACf,CAAC;AAEF,MAAM,MAAM,QAAQ,GAAG;IACrB,QAAQ,CAAC,EAAE,eAAe,CAAC;IAC3B,WAAW,CAAC,EAAE,WAAW,CAAC;IAC1B,QAAQ,CAAC,EAAE,QAAQ,CAAC;CACrB,CAAC;AAEF,MAAM,MAAM,WAAW,GAAG;IACxB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB,CAAC;AAEF,MAAM,MAAM,sBAAsB,GAAG;IACnC,YAAY,CAAC,EAAE,WAAW,EAAE,CAAC;IAC7B,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAC;CACrB,CAAC;AAEF,MAAM,MAAM,QAAQ,GAAG;IACrB,MAAM,CAAC,EAAE,QAAQ,CAAC;IAClB,WAAW,CAAC,EAAE,QAAQ,CAAC;IACvB,YAAY,CAAC,EAAE,sBAAsB,CAAC;CACvC,CAAC;AA2CF,qBAAa,WAAW;IACtB,WAAW,CAAC,EAAE,qBAAqB,CAAC;IACpC,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,MAAM,EAAE,MAAM,CAAC;IACf,GAAG,EAAE,OAAO,CAAC;IACb,GAAG,EAAE,MAAM,CAAC;IACZ,IAAI,EAAE,aAAa,CAAC;gBAER,IAAI,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,OAAO;IAsBxC,IAAI,QAAQ,IAAI,MAAM,CAOrB;IAEK,WAAW,CAAC,SAAS,CAAC,EAAE,MAAM;IAqBpC,IAAI,OAAO,IAAI,MAAM,CAEpB;IAED,IAAI,MAAM,IAAI,QAAQ,GAAG,SAAS,CAOjC;IAED,IAAI,WAAW,IAAI,QAAQ,GAAG,SAAS,CAOtC;IAED,IAAI,YAAY,IAAI,sBAAsB,GAAG,SAAS,CAerD;CACF;AAED,KAAK,YAAY,GAAG;IAClB,sGAAsG;IACtG,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB,CAAC;AAyHF,wBAAgB,iBAAiB,CAAC,QAAQ,EAAE,QAAQ,EAAE,IAAI,CAAC,EAAE,YAAY,UA+BxE"}

package/dist/transfer.js

@@ -0,0 +1,276 @@
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+import fs from 'node:fs';
+import path from 'node:path';
+import { js2xml, xml2js } from 'xml-js';
+import { convertToUnist, xmllintValidate } from 'jats-xml';
+import { tic } from 'myst-cli-utils';
+import fetch from 'node-fetch';
+import { createTempFolder, elementWithText, removeTempFolder, select, selectAll } from './utils.js';
+export const TRANSFER = 'transfer.xml';
+export const TRANSFER_DTD = 'transfer-1.0.dtd';
+function extractContact(node) {
+    var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m;
+    if (!node)
+        return undefined;
+    const role = (node === null || node === void 0 ? void 0 : node['contact-role']) || (node === null || node === void 0 ? void 0 : node.role);
+    const surname = (_c = (_b = (_a = select('surname', node)) === null || _a === void 0 ? void 0 : _a.children) === null || _b === void 0 ? void 0 : _b[0]) === null || _c === void 0 ? void 0 : _c.value;
+    const given = (_f = (_e = (_d = select('given-names,given-name', node)) === null || _d === void 0 ? void 0 : _d.children) === null || _e === void 0 ? void 0 : _e[0]) === null || _f === void 0 ? void 0 : _f.value;
+    const email = (_j = (_h = (_g = select('email', node)) === null || _g === void 0 ? void 0 : _g.children) === null || _h === void 0 ? void 0 : _h[0]) === null || _j === void 0 ? void 0 : _j.value;
+    const phone = (_m = (_l = (_k = select('phone', node)) === null || _k === void 0 ? void 0 : _k.children) === null || _l === void 0 ? void 0 : _l[0]) === null || _m === void 0 ? void 0 : _m.value;
+    const contact = {
+        role,
+        name: given || surname ? { given, surname } : undefined,
+        email,
+        phone,
+    };
+    return contact;
+}
+function extractProvider(node) {
+    var _a, _b, _c;
+    if (!node)
+        return undefined;
+    const name = (_c = (_b = (_a = select('provider-name,name', node)) === null || _a === void 0 ? void 0 : _a.children) === null || _b === void 0 ? void 0 : _b[0]) === null || _c === void 0 ? void 0 : _c.value;
+    const contact = extractContact(select('contact', node));
+    const provider = { name, contact };
+    return provider;
+}
+function extractPublication(node) {
+    var _a, _b, _c, _d, _e, _f;
+    if (!node)
+        return undefined;
+    const type = node._type;
+    const title = (_c = (_b = (_a = select('publication-title,title', node)) === null || _a === void 0 ? void 0 : _a.children) === null || _b === void 0 ? void 0 : _b[0]) === null || _c === void 0 ? void 0 : _c.value;
+    const acronym = (_f = (_e = (_d = select('acronym', node)) === null || _d === void 0 ? void 0 : _d.children) === null || _e === void 0 ? void 0 : _e[0]) === null || _f === void 0 ? void 0 : _f.value;
+    const contact = extractContact(select('contact', node));
+    const serviceProvider = { type, title, acronym, contact };
+    return serviceProvider;
+}
+function extractSecurity(node) {
+    var _a, _b, _c;
+    if (!node)
+        return undefined;
+    const auth = (_c = (_b = (_a = select('authentication-code', node)) === null || _a === void 0 ? void 0 : _a.children) === null || _b === void 0 ? void 0 : _b[0]) === null || _c === void 0 ? void 0 : _c.value;
+    if (!auth)
+        return undefined;
+    return { auth };
+}
+export class TransferXml {
+    constructor(data, opts) {
+        var _a, _b;
+        const toc = tic();
+        this.rawXML = data;
+        this.log = (_a = opts === null || opts === void 0 ? void 0 : opts.log) !== null && _a !== void 0 ? _a : console;
+        try {
+            this.raw = xml2js(data, { compact: false });
+        }
+        catch (error) {
+            throw new Error('Problem parsing the TransferXML document, please ensure it is XML');
+        }
+        const { declaration, elements } = this.raw;
+        this.declaration = declaration === null || declaration === void 0 ? void 0 : declaration.attributes;
+        if (!((elements === null || elements === void 0 ? void 0 : elements.length) === 2 && elements[0].type === 'doctype' && elements[1].name === 'transfer')) {
+            throw new Error('Element <transfer> is not the only element of the transfer.xml');
+        }
+        this.doctype = elements[0].doctype;
+        const converted = convertToUnist(elements[1]);
+        this.tree = select('transfer', converted);
+        (_b = this.log) === null || _b === void 0 ? void 0 : _b.debug(toc('Parsed and converted transfer.xml to unist tree in %s'));
+    }
+    get localDtd() {
+        // This works both compiled and in tests
+        const dtd = fs.existsSync(path.join(__dirname, TRANSFER_DTD))
+            ? path.join(__dirname, TRANSFER_DTD)
+            : path.join(__dirname, '..', 'static', TRANSFER_DTD);
+        if (fs.existsSync(dtd))
+            return dtd;
+        throw new Error(`Unable to locate transfer DTD file ${TRANSFER_DTD} in meca lib distribution`);
+    }
+    validateXml(remoteDtd) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const tempFolder = createTempFolder();
+            fs.writeFileSync(path.join(tempFolder, TRANSFER), this.rawXML);
+            let dtdFile = this.localDtd;
+            if (remoteDtd) {
+                const data = yield (yield fetch(remoteDtd)).text();
+                dtdFile = path.join(tempFolder, TRANSFER_DTD);
+                fs.writeFileSync(dtdFile, data);
+            }
+            const manifestIsValid = yield xmllintValidate(this, path.join(tempFolder, TRANSFER), dtdFile).catch(() => {
+                this.log.error(`${TRANSFER} DTD validation failed`);
+                return false;
+            });
+            removeTempFolder(tempFolder);
+            return manifestIsValid;
+        });
+    }
+    get version() {
+        return this.tree['transfer-version'] || this.tree.version;
+    }
+    get source() {
+        const source = select('transfer-source', this.tree) || select('source', this.tree);
+        if (!source)
+            return undefined;
+        const provider = extractProvider(select('service-provider', source));
+        const publication = extractPublication(select('publication', source));
+        const security = extractSecurity(select('security', source));
+        return { provider, publication, security };
+    }
+    get destination() {
+        const source = select('transfer-destination', this.tree) || select('destination', this.tree);
+        if (!source)
+            return undefined;
+        const provider = extractProvider(select('service-provider', source));
+        const publication = extractPublication(select('publication', source));
+        const security = extractSecurity(select('security', source));
+        return { provider, publication, security };
+    }
+    get instructions() {
+        const parent = select('processing-instructions', this.tree);
+        if (!parent)
+            return undefined;
+        const instructions = selectAll('processing-instruction,instruction', parent).map((node) => {
+            var _a, _b;
+            return ({
+                sequence: node['processing-sequence'] || node.sequence,
+                instruction: (_b = (_a = node.children) === null || _a === void 0 ? void 0 : _a[0]) === null || _b === void 0 ? void 0 : _b.value,
+            });
+        });
+        const comments = selectAll('processing-comments,comments', parent).map((node) => { var _a, _b; return ((_b = (_a = node.children) === null || _a === void 0 ? void 0 : _a[0]) === null || _b === void 0 ? void 0 : _b.value) || ''; });
+        return { instructions, comments };
+    }
+}
+function writeContactElement(opts, contact) {
+    var _a, _b, _c, _d, _e, _f;
+    if (!contact)
+        return undefined;
+    return {
+        type: 'element',
+        name: 'contact',
+        attributes: contact.role
+            ? { [(opts === null || opts === void 0 ? void 0 : opts.simplifiedXML) ? 'role' : 'contact-role']: contact.role }
+            : undefined,
+        elements: [
+            ((_a = contact.name) === null || _a === void 0 ? void 0 : _a.surname) || ((_b = contact.name) === null || _b === void 0 ? void 0 : _b.given)
+                ? {
+                    type: 'element',
+                    name: 'contact-name',
+                    elements: [
+                        ((_c = contact.name) === null || _c === void 0 ? void 0 : _c.surname) ? elementWithText('surname', (_d = contact.name) === null || _d === void 0 ? void 0 : _d.surname) : undefined,
+                        ((_e = contact.name) === null || _e === void 0 ? void 0 : _e.given) ? elementWithText('given-names', (_f = contact.name) === null || _f === void 0 ? void 0 : _f.given) : undefined,
+                    ].filter((e) => !!e),
+                }
+                : undefined,
+            contact.email ? elementWithText('email', contact.email) : undefined,
+            contact.phone ? elementWithText('phone', contact.phone) : undefined,
+        ].filter((e) => !!e),
+    };
+}
+function writeServiceProviderElement(opts, provider) {
+    if (!provider)
+        return undefined;
+    return {
+        type: 'element',
+        name: 'service-provider',
+        elements: [
+            provider.name ? elementWithText('provider-name', provider.name) : undefined,
+            writeContactElement(opts, provider.contact),
+        ].filter((e) => !!e),
+    };
+}
+function writePublicationElement(opts, publication) {
+    if (!publication)
+        return undefined;
+    return {
+        type: 'element',
+        name: 'publication',
+        attributes: publication.type ? { type: publication.type } : undefined,
+        elements: [
+            publication.title
+                ? elementWithText((opts === null || opts === void 0 ? void 0 : opts.simplifiedXML) ? 'title' : 'publication-title', publication.title)
+                : undefined,
+            publication.acronym ? elementWithText('acronym', publication.acronym) : undefined,
+            writeContactElement(opts, publication.contact),
+        ].filter((e) => !!e),
+    };
+}
+function writeLocationElement(name, opts, location) {
+    if (!location)
+        return undefined;
+    return {
+        type: 'element',
+        name: name === 'source' ? ((opts === null || opts === void 0 ? void 0 : opts.simplifiedXML) ? 'source' : 'transfer-source') : 'destination',
+        elements: [
+            writeServiceProviderElement(opts, location.provider),
+            writePublicationElement(opts, location.publication),
+            location.security
+                ? {
+                    type: 'element',
+                    name: 'security',
+                    elements: [
+                        location.security.auth
+                            ? elementWithText('authentication-code', location.security.auth)
+                            : undefined,
+                    ].filter((e) => !!e),
+                }
+                : undefined,
+        ].filter((e) => !!e),
+    };
+}
+function writeInstructionsElement(opts, instructions) {
+    var _a, _b, _c;
+    if (!instructions)
+        return undefined;
+    return {
+        type: 'element',
+        name: 'processing-instructions',
+        elements: [
+            ...((_b = (_a = instructions.instructions) === null || _a === void 0 ? void 0 : _a.map(({ instruction, sequence }) => instruction
+                ? elementWithText((opts === null || opts === void 0 ? void 0 : opts.simplifiedXML) ? 'instruction' : 'processing-instruction', instruction, sequence
+                    ? { [(opts === null || opts === void 0 ? void 0 : opts.simplifiedXML) ? 'sequence' : 'processing-sequence']: sequence }
+                    : undefined)
+                : undefined).filter((e) => !!e)) !== null && _b !== void 0 ? _b : []),
+            ...(_c = instructions.comments) === null || _c === void 0 ? void 0 : _c.map((comment) => comment
+                ? elementWithText((opts === null || opts === void 0 ? void 0 : opts.simplifiedXML) ? 'comments' : 'processing-comments', comment)
+                : undefined).filter((e) => !!e),
+        ].filter((e) => !!e),
+    };
+}
+export function createTransferXml(transfer, opts) {
+    var _a;
+    const element = {
+        type: 'element',
+        elements: [
+            {
+                type: 'doctype',
+                doctype: `transfer PUBLIC "-//MECA//DTD Manifest v1.0//en" "${(_a = opts === null || opts === void 0 ? void 0 : opts.dtdUrl) !== null && _a !== void 0 ? _a : 'https://meca.zip/transfer-1.0.dtd'}"`,
+            },
+            {
+                type: 'element',
+                name: 'transfer',
+                attributes: {
+                    [(opts === null || opts === void 0 ? void 0 : opts.simplifiedXML) ? 'version' : 'transfer-version']: '1.0',
+                    xmlns: 'https://manuscriptexchange.org/schema/transfer',
+                },
+                elements: [
+                    writeLocationElement('source', opts, transfer.source),
+                    writeLocationElement('destination', opts, transfer.destination),
+                    writeInstructionsElement(opts, transfer.instructions),
+                ].filter((e) => !!e),
+            },
+        ],
+        declaration: { attributes: { version: '1.0', encoding: 'UTF-8' } },
+    };
+    const manifest = js2xml(element, {
+        compact: false,
+        spaces: 2,
+    });
+    return manifest;
+}

package/dist/utils.d.ts

@@ -0,0 +1,8 @@
+import type { GenericNode } from 'myst-common';
+import type { Element } from 'xml-js';
+export declare function createTempFolder(): string;
+export declare function removeTempFolder(tempFolder?: string): void;
+export declare function select<T extends GenericNode>(selector: string, node?: GenericNode): T | undefined;
+export declare function selectAll<T extends GenericNode>(selector: string, node?: GenericNode): T[];
+export declare function elementWithText(name: string, text: string, attributes?: Record<string, string>): Element;
+//# sourceMappingURL=utils.d.ts.map

package/dist/utils.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../src/utils.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,aAAa,CAAC;AAC/C,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,QAAQ,CAAC;AAItC,wBAAgB,gBAAgB,WAE/B;AAED,wBAAgB,gBAAgB,CAAC,UAAU,CAAC,EAAE,MAAM,QAUnD;AAED,wBAAgB,MAAM,CAAC,CAAC,SAAS,WAAW,EAAE,QAAQ,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,WAAW,GAAG,CAAC,GAAG,SAAS,CAEjG;AAED,wBAAgB,SAAS,CAAC,CAAC,SAAS,WAAW,EAAE,QAAQ,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,WAAW,GAAG,CAAC,EAAE,CAE1F;AAED,wBAAgB,eAAe,CAC7B,IAAI,EAAE,MAAM,EACZ,IAAI,EAAE,MAAM,EACZ,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAClC,OAAO,CAET"}

package/dist/utils.js

@@ -0,0 +1,30 @@
+import fs from 'node:fs';
+import path from 'node:path';
+import os from 'os';
+import { select as unistSelect, selectAll as unistSelectAll } from 'unist-util-select';
+export function createTempFolder() {
+    return fs.mkdtempSync(path.join(os.tmpdir(), 'meca'));
+}
+export function removeTempFolder(tempFolder) {
+    if (tempFolder && fs.existsSync(tempFolder)) {
+        if (fs.rmSync) {
+            // Node >= 14.14
+            fs.rmSync(tempFolder, { recursive: true });
+        }
+        else {
+            // Node < 14.14
+            fs.rmdirSync(tempFolder, { recursive: true });
+        }
+    }
+}
+export function select(selector, node) {
+    var _a;
+    return ((_a = unistSelect(selector, node)) !== null && _a !== void 0 ? _a : undefined);
+}
+export function selectAll(selector, node) {
+    var _a;
+    return ((_a = unistSelectAll(selector, node)) !== null && _a !== void 0 ? _a : undefined);
+}
+export function elementWithText(name, text, attributes) {
+    return { type: 'element', name, elements: [{ type: 'text', text }], attributes };
+}

package/dist/{validate/dtd.d.ts → validate.d.ts}

@@ -18,3 +18,4 @@ export declare function validateMeca(session: ISession, file: string, opts: Part
  * Logs confirmation message if valid and throws an error if invalid.
  */
 export declare function validateMecaWrapper(session: ISession, file: string, opts: Partial<JatsOptions>): Promise<void>;
+//# sourceMappingURL=validate.d.ts.map

package/dist/validate.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"validate.d.ts","sourceRoot":"","sources":["../src/validate.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAE,QAAQ,EAAE,WAAW,EAAE,MAAM,UAAU,CAAC;AAwBtD;;;;;;;;;;;GAWG;AACH,wBAAsB,YAAY,CAAC,OAAO,EAAE,QAAQ,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,OAAO,CAAC,WAAW,CAAC,oBAqH7F;AAED;;;;GAIG;AACH,wBAAsB,mBAAmB,CACvC,OAAO,EAAE,QAAQ,EACjB,IAAI,EAAE,MAAM,EACZ,IAAI,EAAE,OAAO,CAAC,WAAW,CAAC,iBAQ3B"}

package/dist/validate.js

@@ -0,0 +1,163 @@
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+import fs from 'fs';
+import path from 'path';
+import AdmZip from 'adm-zip';
+import chalk from 'chalk';
+import { validateJatsAgainstDtd } from 'jats-xml';
+import { ItemTypes, MANIFEST, ManifestXml } from './manifest.js';
+import { createTempFolder, removeTempFolder } from './utils.js';
+import { TRANSFER, TransferXml } from './transfer.js';
+const KNOWN_ITEM_TYPES = Object.values(ItemTypes);
+/**
+ * Function to log debug message for passing check
+ */
+function debugCheck(session, msg) {
+    session.log.debug(chalk.green(`✓ ${msg}`));
+}
+/**
+ * Function to log an error and clean temp folder
+ */
+function errorAndClean(session, msg, tempFolder) {
+    session.log.error(msg);
+    removeTempFolder(tempFolder);
+    return false;
+}
+/**
+ * Validate a given file as MECA bundle
+ *
+ * Returns true if file is valid.
+ *
+ * Validation checks:
+ * - File exists and is zip format
+ * - Bundle includes manifest.xlm which validates against DTD
+ * - manifest matches items present in the bundle
+ * - manifest item types match known types
+ * - JATS items validate
+ */
+export function validateMeca(session, file, opts) {
+    var _a;
+    return __awaiter(this, void 0, void 0, function* () {
+        if (!fs.existsSync(file))
+            return errorAndClean(session, `Input file does not exists: ${file}`);
+        if (!(file.endsWith('.meca') || file.endsWith('-meca.zip'))) {
+            session.log.warn(`Some providers may require a file ending with '.meca' or '-meca.zip'`);
+        }
+        let mecaZip;
+        try {
+            mecaZip = new AdmZip(file);
+        }
+        catch (_b) {
+            return errorAndClean(session, `Input file is not a zip archive: ${file}`);
+        }
+        debugCheck(session, 'is zip archive');
+        const manifestEntry = mecaZip.getEntry(MANIFEST);
+        if (!manifestEntry) {
+            return errorAndClean(session, `Input zip archive does not include required manifest file '${MANIFEST}'`);
+        }
+        debugCheck(session, `includes ${MANIFEST}`);
+        const manifestString = manifestEntry.getData().toString();
+        const manifest = new ManifestXml(manifestString, { log: session.log });
+        const tempFolder = createTempFolder();
+        const manifestIsValid = yield manifest.validateXml();
+        if (!manifestIsValid) {
+            return errorAndClean(session, `${MANIFEST} DTD validation failed`, tempFolder);
+        }
+        const transferFiles = yield Promise.all((_a = manifest.transferMetadata) === null || _a === void 0 ? void 0 : _a.map((item) => __awaiter(this, void 0, void 0, function* () {
+            const entry = mecaZip.getEntry(item.href);
+            if (!entry)
+                return false;
+            const data = entry.getData().toString();
+            console.log(data);
+            try {
+                const transfer = new TransferXml(data);
+                const valid = yield transfer.validateXml();
+                if (!valid)
+                    session.log.error(`${TRANSFER} DTD validation failed`);
+                return valid;
+            }
+            catch (error) {
+                session.log.error(`Could not read ${item.href} or DTD validation failed`);
+                return false;
+            }
+        })));
+        if (!transferFiles.reduce((a, b) => a && b, true)) {
+            return errorAndClean(session, `${TRANSFER} validation failed`, tempFolder);
+        }
+        debugCheck(session, `${MANIFEST} passes schema validation`);
+        const manifestItems = manifest.items;
+        const zipEntries = mecaZip.getEntries();
+        // Get all file and folder names in the zip file.
+        // Folders may not be explicitly listed in zipEntries, so we compute all folders from file paths.
+        const zipEntryNames = new Set();
+        zipEntries.forEach((entry) => {
+            const nameParts = entry.entryName.split('/');
+            for (let i = 1; i <= nameParts.length; i++) {
+                zipEntryNames.add(nameParts.slice(0, i).join('/'));
+            }
+        });
+        const manifestExtras = manifestItems
+            .map((item) => item.href)
+            .filter((href) => !zipEntryNames.has(href.replace(/\/$/, ''))); // Ignore trailing slash
+        const zipExtras = zipEntries
+            .filter((entry) => entry.entryName !== MANIFEST)
+            .filter((entry) => !entry.isDirectory)
+            .filter((entry) => !manifestItems.map((item) => item.href).includes(entry.entryName))
+            .map((entry) => entry.entryName);
+        if (zipExtras.length) {
+            session.log.warn(`MECA bundle includes items missing from manifest:\n- ${zipExtras.join('\n- ')}`);
+        }
+        if (manifestExtras.length) {
+            return errorAndClean(session, `manifest items missing from MECA bundle:\n- ${manifestExtras.join('\n- ')}`, tempFolder);
+        }
+        debugCheck(session, 'manifest matches MECA bundle contents');
+        manifestItems.forEach((item) => {
+            if (!item.mediaType) {
+                session.log.warn(`manifest item missing media-type: ${item.href}`);
+            }
+            if (!item.itemType) {
+                session.log.warn(`manifest item missing item-type: ${item.href}`);
+            }
+            else if (!KNOWN_ITEM_TYPES.includes(item.itemType)) {
+                session.log.warn(`manifest item has unknown item-type "${item.itemType}": ${item.href} `);
+            }
+        });
+        const jatsFiles = manifestItems
+            .filter((item) => item.itemType === 'article-metadata')
+            .map((item) => item.href);
+        const invalidJatsFiles = (yield Promise.all(jatsFiles.map((jatsFile) => __awaiter(this, void 0, void 0, function* () {
+            mecaZip.extractEntryTo(jatsFile, tempFolder);
+            const isValid = yield validateJatsAgainstDtd(session, path.join(tempFolder, ...jatsFile.split('/')), opts);
+            return isValid ? undefined : jatsFile;
+        })))).filter((jatsFile) => !!jatsFile);
+        if (invalidJatsFiles.length) {
+            return errorAndClean(session, `JATS DTD validation failed:\n- ${invalidJatsFiles.join('\n- ')}`, tempFolder);
+        }
+        debugCheck(session, 'JATS validation passed');
+        removeTempFolder(tempFolder);
+        return true;
+    });
+}
+/**
+ * Validate a given file as MECA bundle
+ *
+ * Logs confirmation message if valid and throws an error if invalid.
+ */
+export function validateMecaWrapper(session, file, opts) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const success = yield validateMeca(session, file, opts);
+        if (success) {
+            session.log.info(chalk.greenBright('MECA validation passed!'));
+        }
+        else {
+            throw new Error('MECA validation failed.');
+        }
+    });
+}

package/dist/version.d.ts

@@ -1,2 +1,3 @@
-declare const version = "1.0.4";
+declare const version = "1.0.5";
 export default version;
+//# sourceMappingURL=version.d.ts.map

package/dist/version.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"version.d.ts","sourceRoot":"","sources":["../src/version.ts"],"names":[],"mappings":"AAAA,QAAA,MAAM,OAAO,UAAU,CAAC;AACxB,eAAe,OAAO,CAAC"}

package/dist/version.js

@@ -1,2 +1,2 @@
-const version = '1.0.4';
+const version = '1.0.5';
 export default version;