meca 0.0.0 → 1.0.3

package/README.md

@@ -0,0 +1,37 @@
+# meca
+
+[![meca on npm](https://img.shields.io/npm/v/meca.svg)](https://www.npmjs.com/package/meca)
+[![MIT License](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/curvenote/meca/blob/main/LICENSE)
+[![CI](https://github.com/curvenote/meca/workflows/CI/badge.svg)](https://github.com/curvenote/meca/actions)
+
+Types and utilities for working with MECA bundles documents in Node and Typescript.
+
+Read and write MECA bundles from node or see summaries from the command line.
+
+To use from the command line, use the `-g` to create a global install, which will provide a `meca` CLI:
+
+```
+npm install -g meca
+meca -v
+```
+
+## What is MECA?
+
+## Packages
+
+See packages folder:
+
+- meca
+
+---
+
+This package is [ESM only](https://gist.github.com/sindresorhus/a39789f98801d908bbc7ff3ecc99d99c).
+
+---
+
+<p style="text-align: center; color: #aaa; padding-top: 50px">
+  Made with love by
+  <a href="https://curvenote.com" target="_blank" style="color: #aaa">
+    <img src="https://curvenote.dev/images/icon.png" style="height: 1em" /> Curvenote
+  </a>
+</p>

package/dist/MECA_manifest.dtd

@@ -0,0 +1,43 @@
+<!-- DOCTYPE manifest PUBLIC “-//MECA//DTD Manifest v1.0//en"
+ "https://www.manuscriptexchange.org/schema/manifest-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 manifest (item+)>
+<!ATTLIST manifest xmlns CDATA #FIXED "https://manuscriptexchange.org/schema/manifest">
+<!ATTLIST manifest xmlns:xlink CDATA #FIXED "http://www.w3.org/1999/xlink">
+<!ATTLIST manifest manifest-version CDATA #REQUIRED>
+<!ELEMENT item (item-title?, item-description?, file-order?, item-metadata?, instance+)>
+<!ATTLIST item id ID #IMPLIED>
+<!ATTLIST item item-type CDATA #IMPLIED>
+<!ATTLIST item custom-metadata-id CDATA #IMPLIED>
+<!ATTLIST item item-version CDATA #IMPLIED>
+<!ELEMENT item-title (#PCDATA)>
+<!ELEMENT item-description (#PCDATA)>
+<!ELEMENT file-order (#PCDATA)>
+<!ELEMENT item-metadata (metadata+)>
+<!ELEMENT metadata (#PCDATA)>
+<!ATTLIST metadata metadata-name CDATA #REQUIRED>
+<!ELEMENT instance EMPTY>
+<!ATTLIST instance xmlns:xlink CDATA #FIXED 'http://www.w3.org/1999/xlink'
+ xlink:type (locator) #FIXED 'locator'
+ xlink:href CDATA #REQUIRED>
+<!ATTLIST instance media-type CDATA #IMPLIED>
+<!ATTLIST instance origin CDATA #IMPLIED>
+<!ATTLIST instance conversion CDATA #IMPLIED>
+<!ATTLIST instance composition CDATA #IMPLIED>

package/dist/cli/index.d.ts

@@ -0,0 +1,2 @@
+#!/usr/bin/env node
+export {};

package/dist/cli/index.js

@@ -0,0 +1,9 @@
+#!/usr/bin/env node
+import { Command } from 'commander';
+import version from '../version.js';
+import { addValidateCLI } from './validate.js';
+const program = new Command();
+addValidateCLI(program);
+program.version(`v${version}`, '-v, --version', 'Print the current version of jats-xml');
+program.option('-d, --debug', 'Log out any errors to the console.');
+program.parse(process.argv);

package/dist/cli/validate.d.ts

@@ -0,0 +1,2 @@
+import { Command } from 'commander';
+export declare function addValidateCLI(program: Command): void;

package/dist/cli/validate.js

@@ -0,0 +1,25 @@
+import { Command, Option } from 'commander';
+import { clirun } from 'myst-cli-utils';
+import { getSession } from 'jats-xml';
+import { validateMecaWrapper } from '../validate/index.js';
+function makeValidateCLI(program) {
+    const command = new Command('validate')
+        .description(`
+      Validate MECA file against zip structure and DTD schemas.
+
+      The zip file must have a 'manifest.xml' file which must pass Manifest DTD validation.
+      All the files in the manifest must exist in the zip file, with no others present.
+      Any JATS files must validate against JATS DTD schema.
+      `)
+        .argument('<file>', 'MECA file to validate')
+        .addOption(new Option('--library <value>', 'JATS library - archiving, publishing, or authoring (default: archiving, if value cannot be inferred from file)'))
+        .addOption(new Option('--jats <version>', 'JATS version, must be 1.1 or later (default: 1.3, if value cannot be inferred from file)'))
+        .addOption(new Option('--mathml <version>', 'MathML version, 2 or 3 (default: 3, if value cannot be inferred from file)'))
+        .addOption(new Option('--oasis', 'Use OASIS table model (default: false, if value cannot be inferred from file)'))
+        .addOption(new Option('--directory <value>', 'Directory to save JATS DTD file'))
+        .action(clirun(validateMecaWrapper, { program, getSession }));
+    return command;
+}
+export function addValidateCLI(program) {
+    program.addCommand(makeValidateCLI(program));
+}

package/dist/index.d.ts

@@ -0,0 +1,2 @@
+export { default as version } from './version.js';
+export * from './validate/index.js';

package/dist/index.js

@@ -0,0 +1,2 @@
+export { default as version } from './version.js';
+export * from './validate/index.js';