react-native-marcus 0.1.1 → 0.2.0

package/lib/module/metro.js

@@ -0,0 +1,169 @@
+"use strict";
+
+/**
+ * Metro configuration for drawing maths.
+ *
+ * Two things stand between a Metro bundle and a working `MarkdownText` with
+ * `math` on, and `withMath` is both of them:
+ *
+ * 1. **The maths backend is swapped in.** `src/math/index.ts` is a stub that
+ *    draws nothing, and nothing in the library ever imports the real one --
+ *    otherwise every application that installed this package would carry
+ *    MathJax, whether or not it has an equation in it. This resolver points
+ *    that import at `src/math/mathjax.ts` instead, which is what opting in
+ *    means.
+ * 2. **MathJax's own imports resolve.** It addresses its modules through
+ *    Node's *subpath imports* -- the `imports` field in its `package.json`,
+ *    which maps `#js/*`, `#default-font/*` and four others onto real files.
+ *    Metro does not implement that field, so every internal import fails and
+ *    the bundle never builds. There is nothing to fix in MathJax: the field is
+ *    standard and Metro has not caught up. The mapping is read out of MathJax's
+ *    own manifest rather than written down here, because a list copied into a
+ *    second place is a list that goes stale.
+ *
+ *     const { getDefaultConfig } = require("expo/metro-config")
+ *     const { withMath } = require("react-native-marcus/metro")
+ *
+ *     module.exports = withMath(getDefaultConfig(__dirname))
+ *
+ * It does one thing more, which is to *remove* rather than add: the speech
+ * engine's rules for every language but the ones named in `{ locales }` are
+ * resolved away to nothing, so a display that reads its maths in English does
+ * not carry the twelve other languages it will never speak.
+ */
+import { dirname } from "path";
+
+/** As much of a Metro config as this touches. */
+
+/**
+ * MathJax's `#…` specifiers, as prefix pairs.
+ *
+ * Its manifest maps `"#js/*": "@mathjax/src/mjs/*"` and so on, and every entry
+ * is a single trailing wildcard, so a prefix swap is the whole of it. Anything
+ * shaped differently is skipped rather than guessed at.
+ */
+function importPrefixes(packageName) {
+  let manifest;
+  try {
+    // eslint-disable-next-line @typescript-eslint/no-var-requires
+    manifest = require(`${packageName}/package.json`);
+  } catch {
+    throw new Error(`[react-native-marcus] withMath() could not read "${packageName}/package.json". ` + `Install it (npm install ${packageName}) or drop withMath() from your Metro config.`);
+  }
+  const prefixes = [];
+  for (const [specifier, target] of Object.entries(manifest.imports ?? {})) {
+    if (typeof target === "string" && specifier.endsWith("/*") && target.endsWith("/*") && specifier.startsWith("#")) {
+      prefixes.push([specifier.slice(0, -1), target.slice(0, -1)]);
+    }
+  }
+  return prefixes;
+}
+
+/**
+ * The stub backend, whichever build of the library Metro picked: `lib/module`,
+ * `lib/commonjs`, or `src` itself when the library is being worked on.
+ */
+const STUB = /([\\/])math([\\/])index\.(js|jsx|ts|tsx|mjs|cjs)$/;
+
+/**
+ * One of the speech engine's rule tables, by the locale it holds.
+ *
+ * They are all named in `math/mathjax.ts` -- a `require` has to be written down
+ * for a bundler to find it -- and all but the ones the application asked for
+ * are resolved away here.
+ */
+const MATHMAPS = /[\\/]mathmaps[\\/]([a-z]+)\.json$/;
+
+/** The table every locale shares, which is never the one to leave out. */
+const BASE_LOCALE = "base";
+
+/** Where this library lives, so that nothing else's `math/index.js` is touched. */
+function libraryRoot(libraryName) {
+  try {
+    return dirname(require.resolve(`${libraryName}/package.json`));
+  } catch {
+    throw new Error(`[react-native-marcus] withMath() could not locate "${libraryName}". ` + `Pass { libraryName } if it is installed under another name.`);
+  }
+}
+
+/**
+ * Where the speech engine lives, when it is installed at all.
+ *
+ * It bounds the locale trimming the way the library root bounds the backend
+ * swap: only files under this directory are considered rule tables. Missing is
+ * not an error -- an application can draw maths without ever reading it out --
+ * and then there is nothing to trim.
+ */
+function speechRoot() {
+  try {
+    return dirname(require.resolve("speech-rule-engine/package.json"));
+  } catch {
+    return null;
+  }
+}
+
+/**
+ * Teaches Metro to resolve MathJax, and points the library's maths backend at
+ * it.
+ *
+ * Any `resolveRequest` already on the config is kept and called for everything
+ * else, so this composes with whatever else the application is doing.
+ */
+function withMath(config, options = {}) {
+  const prefixes = importPrefixes(options.packageName ?? "@mathjax/src");
+  const root = libraryRoot(options.libraryName ?? "react-native-marcus");
+  const speech = speechRoot();
+  const locales = new Set(options.locales ?? ["en"]);
+  const existing = config.resolver?.resolveRequest;
+  const resolveRequest = (context, moduleName, platform) => {
+    let name = moduleName;
+    if (name.charCodeAt(0) === 35 /* # */) {
+      for (const [from, to] of prefixes) {
+        if (name.startsWith(from)) {
+          name = to + name.slice(from.length);
+          break;
+        }
+      }
+    }
+    const resolution = existing ? existing(context, name, platform) : context.resolveRequest(context, name, platform);
+
+    // Matched on what it resolved to rather than on what was asked for: the
+    // import is written `"./math"`, relative to whichever of the three builds
+    // of this library the application ended up with, and a relative specifier
+    // says nothing about which package it is in.
+    const filePath = resolution?.filePath;
+    if (filePath && STUB.test(filePath) && isInside(root, filePath)) {
+      return {
+        ...resolution,
+        filePath: filePath.replace(STUB, "$1math$2mathjax.$3")
+      };
+    }
+    if (filePath && speech !== null && isInside(speech, filePath)) {
+      const locale = MATHMAPS.exec(filePath)?.[1];
+
+      // An empty module rather than a missing one: the backend requires every
+      // locale it knows of, unconditionally, and reads the empty object back as
+      // "this one was not bundled" -- which is what it warns about and falls
+      // back from. A resolution error here would be a bundle that does not
+      // build.
+      if (locale !== undefined && locale !== BASE_LOCALE && !locales.has(locale)) {
+        return {
+          type: "empty"
+        };
+      }
+    }
+    return resolution;
+  };
+  return {
+    ...config,
+    resolver: {
+      ...config.resolver,
+      resolveRequest
+    }
+  };
+}
+function isInside(root, filePath) {
+  return filePath.length > root.length && filePath.startsWith(root);
+}
+export { withMath };
+//# sourceMappingURL=metro.js.map

package/lib/module/metro.js.map

@@ -0,0 +1 @@
+{"version":3,"names":["dirname","importPrefixes","packageName","manifest","require","Error","prefixes","specifier","target","Object","entries","imports","endsWith","startsWith","push","slice","STUB","MATHMAPS","BASE_LOCALE","libraryRoot","libraryName","resolve","speechRoot","withMath","config","options","root","speech","locales","Set","existing","resolver","resolveRequest","context","moduleName","platform","name","charCodeAt","from","to","length","resolution","filePath","test","isInside","replace","locale","exec","undefined","has","type"],"sourceRoot":"../../src","sources":["metro.ts"],"mappings":";;AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,SAASA,OAAO,QAAQ,MAAM;;AAE9B;;AAyDA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,SAASC,cAAcA,CAACC,WAAmB,EAAsB;EAC/D,IAAIC,QAA+C;EAEnD,IAAI;IACF;IACAA,QAAQ,GAAGC,OAAO,CAAC,GAAGF,WAAW,eAAe,CAA0C;EAC5F,CAAC,CAAC,MAAM;IACN,MAAM,IAAIG,KAAK,CACb,oDAAoDH,WAAW,kBAAkB,GAC/E,2BAA2BA,WAAW,8CAC1C,CAAC;EACH;EAEA,MAAMI,QAA4B,GAAG,EAAE;EAEvC,KAAK,MAAM,CAACC,SAAS,EAAEC,MAAM,CAAC,IAAIC,MAAM,CAACC,OAAO,CAACP,QAAQ,CAACQ,OAAO,IAAI,CAAC,CAAC,CAAC,EAAE;IACxE,IACE,OAAOH,MAAM,KAAK,QAAQ,IAC1BD,SAAS,CAACK,QAAQ,CAAC,IAAI,CAAC,IACxBJ,MAAM,CAACI,QAAQ,CAAC,IAAI,CAAC,IACrBL,SAAS,CAACM,UAAU,CAAC,GAAG,CAAC,EACzB;MACAP,QAAQ,CAACQ,IAAI,CAAC,CAACP,SAAS,CAACQ,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAEP,MAAM,CAACO,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC;IAC9D;EACF;EAEA,OAAOT,QAAQ;AACjB;;AAEA;AACA;AACA;AACA;AACA,MAAMU,IAAI,GAAG,mDAAmD;;AAEhE;AACA;AACA;AACA;AACA;AACA;AACA;AACA,MAAMC,QAAQ,GAAG,mCAAmC;;AAEpD;AACA,MAAMC,WAAW,GAAG,MAAM;;AAE1B;AACA,SAASC,WAAWA,CAACC,WAAmB,EAAU;EAChD,IAAI;IACF,OAAOpB,OAAO,CAACI,OAAO,CAACiB,OAAO,CAAC,GAAGD,WAAW,eAAe,CAAC,CAAC;EAChE,CAAC,CAAC,MAAM;IACN,MAAM,IAAIf,KAAK,CACb,sDAAsDe,WAAW,KAAK,GACpE,6DACJ,CAAC;EACH;AACF;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,SAASE,UAAUA,CAAA,EAAkB;EACnC,IAAI;IACF,OAAOtB,OAAO,CAACI,OAAO,CAACiB,OAAO,CAAC,iCAAiC,CAAC,CAAC;EACpE,CAAC,CAAC,MAAM;IACN,OAAO,IAAI;EACb;AACF;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,SAASE,QAAQA,CAACC,MAAmB,EAAEC,OAAwB,GAAG,CAAC,CAAC,EAAe;EACjF,MAAMnB,QAAQ,GAAGL,cAAc,CAACwB,OAAO,CAACvB,WAAW,IAAI,cAAc,CAAC;EACtE,MAAMwB,IAAI,GAAGP,WAAW,CAACM,OAAO,CAACL,WAAW,IAAI,qBAAqB,CAAC;EACtE,MAAMO,MAAM,GAAGL,UAAU,CAAC,CAAC;EAC3B,MAAMM,OAAO,GAAG,IAAIC,GAAG,CAACJ,OAAO,CAACG,OAAO,IAAI,CAAC,IAAI,CAAC,CAAC;EAClD,MAAME,QAAQ,GAAGN,MAAM,CAACO,QAAQ,EAAEC,cAAc;EAEhD,MAAMA,cAA8B,GAAGA,CAACC,OAAO,EAAEC,UAAU,EAAEC,QAAQ,KAAK;IACxE,IAAIC,IAAI,GAAGF,UAAU;IAErB,IAAIE,IAAI,CAACC,UAAU,CAAC,CAAC,CAAC,KAAK,EAAE,CAAC,SAAS;MACrC,KAAK,MAAM,CAACC,IAAI,EAAEC,EAAE,CAAC,IAAIjC,QAAQ,EAAE;QACjC,IAAI8B,IAAI,CAACvB,UAAU,CAACyB,IAAI,CAAC,EAAE;UACzBF,IAAI,GAAGG,EAAE,GAAGH,IAAI,CAACrB,KAAK,CAACuB,IAAI,CAACE,MAAM,CAAC;UACnC;QACF;MACF;IACF;IAEA,MAAMC,UAAU,GAAGX,QAAQ,GACvBA,QAAQ,CAACG,OAAO,EAAEG,IAAI,EAAED,QAAQ,CAAC,GAChCF,OAAO,CAAuBD,cAAc,CAACC,OAAO,EAAEG,IAAI,EAAED,QAAQ,CAAC;;IAE1E;IACA;IACA;IACA;IACA,MAAMO,QAAQ,GAAGD,UAAU,EAAEC,QAAQ;IAErC,IAAIA,QAAQ,IAAI1B,IAAI,CAAC2B,IAAI,CAACD,QAAQ,CAAC,IAAIE,QAAQ,CAAClB,IAAI,EAAEgB,QAAQ,CAAC,EAAE;MAC/D,OAAO;QAAE,GAAGD,UAAU;QAAEC,QAAQ,EAAEA,QAAQ,CAACG,OAAO,CAAC7B,IAAI,EAAE,oBAAoB;MAAE,CAAC;IAClF;IAEA,IAAI0B,QAAQ,IAAIf,MAAM,KAAK,IAAI,IAAIiB,QAAQ,CAACjB,MAAM,EAAEe,QAAQ,CAAC,EAAE;MAC7D,MAAMI,MAAM,GAAG7B,QAAQ,CAAC8B,IAAI,CAACL,QAAQ,CAAC,GAAG,CAAC,CAAC;;MAE3C;MACA;MACA;MACA;MACA;MACA,IAAII,MAAM,KAAKE,SAAS,IAAIF,MAAM,KAAK5B,WAAW,IAAI,CAACU,OAAO,CAACqB,GAAG,CAACH,MAAM,CAAC,EAAE;QAC1E,OAAO;UAAEI,IAAI,EAAE;QAAQ,CAAC;MAC1B;IACF;IAEA,OAAOT,UAAU;EACnB,CAAC;EAED,OAAO;IAAE,GAAGjB,MAAM;IAAEO,QAAQ,EAAE;MAAE,GAAGP,MAAM,CAACO,QAAQ;MAAEC;IAAe;EAAE,CAAC;AACxE;AAEA,SAASY,QAAQA,CAAClB,IAAY,EAAEgB,QAAgB,EAAE;EAChD,OAAOA,QAAQ,CAACF,MAAM,GAAGd,IAAI,CAACc,MAAM,IAAIE,QAAQ,CAAC7B,UAAU,CAACa,IAAI,CAAC;AACnE;AAIA,SAASH,QAAQ","ignoreList":[]}

package/lib/module/parser/index.d.ts

@@ -0,0 +1,3 @@
+import type { MarkdownParser, ParserOptions } from "../../typescript/module/src/commonTypes.js"
+
+export declare function createParser(options?: ParserOptions): MarkdownParser