rapier-math 1.0.1 → 1.1.0

package/src/package.json

@@ -1,7 +1,7 @@
 {
   "name": "rapier-math-source",
   "private": true,
-  "version": "1.0.1",
+  "version": "1.1.0",
   "type": "module",
   "scripts": {
     "build": "node tools/build-math.mjs"

package/src/shell/math-resources.json

@@ -1,16 +1,16 @@
 {
-  "bundle": "rapier-math-1.0.1.js",
-  "version": "1.0.1",
+  "bundle": "rapier-math-1.1.0.js",
+  "version": "1.1.0",
   "license": "MIT AND LicenseRef-GUST-Font-License",
-  "bytes": 803451,
-  "gzipBytes": 496298,
-  "sha256": "77640802b52935b60a66e2fd04c19d4702cee4b1a8b64aece5ca332236c09283",
-  "sha384": "1kdn6mohx3a5MAiwqRWY+6oviUHUheHfY1VMsxjDsUrn7woTaa7FSKo4juYtuNaF",
+  "bytes": 714051,
+  "gzipBytes": 442525,
+  "sha256": "22e5e40abbd1087922335893ad546fb7ffaeaa710338c97e5686e7b7b0b62021",
+  "sha384": "dYIPrqCf4rrTcAKw1Zzzo7vujbNtk2C7Zik/tIYOaLVT0U66WOXcGNE6waFbKych",
   "sources": [
     {
       "file": "math/font.js",
-      "bytes": 651457,
-      "sha256": "b697b5ba770e35904fe56a0aa6c2f748253b3d3c5b9ab39c68f4a25afae02a0d"
+      "bytes": 558719,
+      "sha256": "1263135501cb049efb087975db43c0fa6d131e5deee4282d982995d4ab0884c4"
     },
     {
       "file": "math/symbols.js",
@@ -24,13 +24,13 @@
     },
     {
       "file": "math/layout.js",
-      "bytes": 37394,
-      "sha256": "37cd00667aa1c7ef8b375c5e62171b1a7ceef53490cd13c8a77201e7ea6b13e8"
+      "bytes": 37632,
+      "sha256": "84f0abeb24907f370754e30e5cf0576cb2346b941815494c9958892f3d1cc939"
     },
     {
       "file": "math/fallbacks.js",
-      "bytes": 7958,
-      "sha256": "a59c9a32f4a1ea49ad7454ea48aa25489e8e786459055d91fef045b8cc2b5f4b"
+      "bytes": 7953,
+      "sha256": "400c5771756d5a4d4cf431d471b33c280791ce4aa276a0fd2615d91ee88ae8ce"
     },
     {
       "file": "math/responsive.js",
@@ -39,25 +39,25 @@
     },
     {
       "file": "math/browser.js",
-      "bytes": 8363,
-      "sha256": "0bf9fc6c5f02c2b0c5012118b80a8fad337fe25c3a4557e2747d4d4caa5c2e1b"
+      "bytes": 10048,
+      "sha256": "5a9b1ee1b8c55a5560058b0fcfb5d6623f7de74e49bcb4281acdf7c97b235101"
     },
     {
       "file": "math/api.js",
-      "bytes": 5825,
-      "sha256": "f05bc69c0e13230079526a98072a2ae8ffd58bfb2df2aecb0e2f26fdb43dbeb6"
+      "bytes": 7245,
+      "sha256": "66a2c6911aeba9d8f01003b37c132d25da06e9eaffddf0a785b35033aea5d50b"
     }
   ],
   "recipe": [
     {
       "file": "math/build-font.py",
-      "bytes": 24804,
-      "sha256": "83f27e773d451a7275f6b7d521a257f79c27b3c61452a869703fe44c4ca8b878"
+      "bytes": 33369,
+      "sha256": "d54dba7b83d945da4bdeeac6a262c45d0b8f531c0801114451ac3f3d8dab9d35"
     },
     {
       "file": "math/FONT-SOURCE.md",
-      "bytes": 8095,
-      "sha256": "05e0bba9e9bf340029c8bcc97492c17958949533717a62644505846905e65499"
+      "bytes": 10357,
+      "sha256": "84ab319b1f9342fa08b421231965dd685063d8fd6bb8a071e1f1c186848dcdd9"
     },
     {
       "file": "math/FONT-LICENSE.txt",
@@ -66,18 +66,43 @@
     },
     {
       "file": "math/package-verify.mjs",
-      "bytes": 2691,
-      "sha256": "6a53081729c020b7840363812138264195cb851a297c5542ef7aca007fdfc61f"
+      "bytes": 3314,
+      "sha256": "1ceddafe4f989313d4e0b733bb47572c9c6d62fcb06966048fc64402f0960dcb"
     },
     {
       "file": "tools/build-math.mjs",
-      "bytes": 5795,
-      "sha256": "7f8582f07832c2c2a50b0b6b552df3819e8e246f8aa7857e409d443b79d463f4"
+      "bytes": 7105,
+      "sha256": "d9959884cb2d1e0cc3c09e98b165a2e25f0cec55d7a963a5d810a4167f223cd2"
     },
     {
       "file": "math/LICENSE-MIT",
       "bytes": 1071,
       "sha256": "a3bc5d619ab9159f4eef2924e48dfb935556f4bc163f5ea61610b66a5915de70"
+    },
+    {
+      "file": "math/adoption-verify.mjs",
+      "bytes": 8253,
+      "sha256": "f497b40c03cb9ba2a053b91832ca7889e1c60b5eaf422a10d06f7a6ce7068446"
+    },
+    {
+      "file": "math/package-build.mjs",
+      "bytes": 1659,
+      "sha256": "b2a72f64a11b7bc58472e373080e9bb4356eda32bc7afcef72556b0c106b2225"
+    },
+    {
+      "file": "math/package-check.mjs",
+      "bytes": 7408,
+      "sha256": "0c7ba3d257ad1fba3e22b1dde2dd3cce281d3d7143cce726b36f89ac4c413e8b"
+    },
+    {
+      "file": "math/package-readme.mjs",
+      "bytes": 427,
+      "sha256": "1d3bc00108614b72978c4209d6b718f473e2ce3ab2d0f3008a803fcf68235616"
+    },
+    {
+      "file": "math/README.md",
+      "bytes": 14092,
+      "sha256": "480cec1bd6557d959dcae8aeb5e07405768dcbd780be2ff967042cfc9422318d"
     }
   ],
   "components": [
@@ -101,5 +126,139 @@
     "licenseFile": "math/FONT-LICENSE.txt",
     "licenseSha256": "91ded9a2a371cbeff028bfaf3bd3e97fddfb68af6f186aa261bfaff35baf800c",
     "licenseBytes": 21246
-  }
+  },
+  "adoption": [
+    {
+      "file": "math/delimiters.mjs",
+      "packageFile": "delimiters.mjs",
+      "bytes": 1945,
+      "sha256": "2847d23ba78534b32348d5e642ded601e4f6fd9c41e10d80c46955d440d24eba"
+    },
+    {
+      "file": "math/markdown-rules.mjs",
+      "packageFile": "markdown-rules.mjs",
+      "bytes": 3255,
+      "sha256": "3c2c1660f669eac88fbee4259e83f9227ed651e2e4bb228a861c5a1d8518f6a7"
+    },
+    {
+      "file": "math/integration.mjs",
+      "packageFile": "integration.mjs",
+      "bytes": 1493,
+      "sha256": "5bd61aa59e78cbab37219b9a569f3b5ad9c5a7723800abc7f3fe7af6b82ae7a6"
+    },
+    {
+      "file": "math/markdown-it.mjs",
+      "packageFile": "markdown-it.mjs",
+      "bytes": 2113,
+      "sha256": "d57abc5dc3e5a31b6be4507b2f5c57df8431763b8d88feaadbf242cb09af6c9d"
+    },
+    {
+      "file": "math/rehype.mjs",
+      "packageFile": "rehype.mjs",
+      "bytes": 2017,
+      "sha256": "7cc9c9d2e7c9b9667368cfc1a5a4f5f86d218b7c8a1acb8d2e12334d41e83bc8"
+    },
+    {
+      "file": "math/stream.mjs",
+      "packageFile": "stream.mjs",
+      "bytes": 2530,
+      "sha256": "2b26a895e531906be931af6f9f3764297d1ff98bf56875e9df457f82938fc03d"
+    },
+    {
+      "file": "math/index.d.ts",
+      "packageFile": "index.d.ts",
+      "bytes": 1698,
+      "sha256": "bc14a284cd5caffdf5bfe6825c49c360d313e693bbc0280aa924fd9fc594beb3"
+    },
+    {
+      "file": "math/classic.d.ts",
+      "packageFile": "classic.d.ts",
+      "bytes": 123,
+      "sha256": "dfc82014f54ed7364171cb73cc8bc118aba4a5929349f762da82988977f1593d"
+    },
+    {
+      "file": "math/delimiters.d.ts",
+      "packageFile": "delimiters.d.ts",
+      "bytes": 479,
+      "sha256": "db74cfb4fdd6d87e7f47a5de8ee3a4b78f409a4fe3cd2edeaa8e77660a489617"
+    },
+    {
+      "file": "math/integration.d.ts",
+      "packageFile": "integration.d.ts",
+      "bytes": 370,
+      "sha256": "4b3c53b01b34de3b328ef609e65aa3aa530fabc3522238bde335cb8c839cdda3"
+    },
+    {
+      "file": "math/markdown-it.d.ts",
+      "packageFile": "markdown-it.d.ts",
+      "bytes": 383,
+      "sha256": "bafce277328ba397bddbbb5101cc2545ba8b8c15830b47f2dc1f05af85de4b1d"
+    },
+    {
+      "file": "math/rehype.d.ts",
+      "packageFile": "rehype.d.ts",
+      "bytes": 340,
+      "sha256": "8f6b230284e64fb483d1ed2c6ed9420958cf1d7e609f71aee62322cabe56339b"
+    },
+    {
+      "file": "math/stream.d.ts",
+      "packageFile": "stream.d.ts",
+      "bytes": 630,
+      "sha256": "1b12bc176fdd243db75d247ff4dbb9b4787945167a033154a0d222ad68da4ff0"
+    },
+    {
+      "file": "math/examples/formula.mjs",
+      "packageFile": "examples/formula.mjs",
+      "bytes": 619,
+      "sha256": "43e3708d50737d1eac74f5132146838b58b733c5b0315b50d6eecd594ecb9e7d"
+    },
+    {
+      "file": "math/examples/markdown.mjs",
+      "packageFile": "examples/markdown.mjs",
+      "bytes": 375,
+      "sha256": "6dc4789538861d478f9afba403574b3f88928db4e9d4e4def88db87af8561641"
+    },
+    {
+      "file": "math/examples/stream.mjs",
+      "packageFile": "examples/stream.mjs",
+      "bytes": 841,
+      "sha256": "4b1feb25d38024a6f8531bb3353d0eea993628dcd1f97e736d42c9e076ec655b"
+    },
+    {
+      "file": "math/examples/unified.mjs",
+      "packageFile": "examples/unified.mjs",
+      "bytes": 1103,
+      "sha256": "9002f3f1f7cbbec2f8f9a4b3cdbde2f418fece7b8395e942441448b7f785ee9b"
+    },
+    {
+      "file": "math/examples/browser.html",
+      "packageFile": "examples/browser.html",
+      "bytes": 566,
+      "sha256": "c671541b4a3f1a4cb9e2b2ef2945778db825590f08a11ad48b768d132b5df96f"
+    },
+    {
+      "file": "math/examples/browser.mjs",
+      "packageFile": "examples/browser.mjs",
+      "bytes": 940,
+      "sha256": "c108898c6d8e8fec228980a06f430684de2dc7a4816208559a4f57a9a4f53c8b"
+    },
+    {
+      "file": "math/examples/react.tsx",
+      "packageFile": "examples/react.tsx",
+      "bytes": 899,
+      "sha256": "bfcbeb5219ce776a9c33f841c0aad222be9b6ceddffe0eb89f344bed170e0765"
+    },
+    {
+      "file": "math/examples/worker.mjs",
+      "packageFile": "examples/worker.mjs",
+      "bytes": 365,
+      "sha256": "612c334036dbf2f36f2357bf26a0a2601c976d4b193cc681facd8e003eaea4d4"
+    },
+    {
+      "file": "math/examples/README.md",
+      "packageFile": "examples/README.md",
+      "bytes": 1858,
+      "sha256": "c462b51cae9435336debca87e7e6407400ff06df3126ac8aeb4becc091cd31bf"
+    }
+  ]
 }

package/src/tools/build-math.mjs

@@ -9,10 +9,15 @@ import {gzipSync} from 'node:zlib';
 import {Script} from 'node:vm';
 
 const ROOT = resolve(dirname(fileURLToPath(import.meta.url)), '..');
-export const MATH_VERSION = '1.0.1';
+export const MATH_VERSION = '1.1.0';
 export const MATH_BUNDLE = 'rapier-math-' + MATH_VERSION + '.js';
 export const MATH_SOURCES = ['font.js', 'symbols.js', 'parser.js', 'layout.js', 'fallbacks.js', 'responsive.js', 'browser.js', 'api.js'].map(name => 'math/' + name);
-export const MATH_RECIPE = ['math/build-font.py', 'math/FONT-SOURCE.md', 'math/FONT-LICENSE.txt', 'math/package-verify.mjs', 'tools/build-math.mjs', 'math/LICENSE-MIT'];
+export const MATH_RECIPE = ['math/build-font.py', 'math/FONT-SOURCE.md', 'math/FONT-LICENSE.txt', 'math/package-verify.mjs', 'tools/build-math.mjs', 'math/LICENSE-MIT', 'math/adoption-verify.mjs', 'math/package-build.mjs', 'math/package-check.mjs', 'math/package-readme.mjs', 'math/README.md'];
+export const MATH_ADOPTION = ['delimiters.mjs', 'markdown-rules.mjs', 'integration.mjs', 'markdown-it.mjs', 'rehype.mjs', 'stream.mjs',
+  'index.d.ts', 'classic.d.ts', 'delimiters.d.ts', 'integration.d.ts', 'markdown-it.d.ts', 'rehype.d.ts', 'stream.d.ts',
+  'examples/formula.mjs', 'examples/markdown.mjs', 'examples/stream.mjs', 'examples/unified.mjs',
+  'examples/browser.html', 'examples/browser.mjs', 'examples/react.tsx', 'examples/worker.mjs', 'examples/README.md']
+  .map(file => ({file: 'math/' + file, packageFile: file}));
 const FONT = {
   name: 'Latin Modern Math', version: '1.959', license: 'LicenseRef-GUST-Font-License',
   licenseName: 'GUST Font License',
@@ -39,7 +44,7 @@ export async function fillMathLicense(markup, {root = ROOT} = {}) {
   return markup.replace(marker, () => '<pre class="license-text">' + escaped + '</pre>');
 }
 
-export async function buildMath({root = ROOT, updatePins = true} = {}) {
+export async function assembleMath({root = ROOT} = {}) {
   const inputs = [];
   for (const file of MATH_SOURCES) {
     const bytes = await readFile(resolve(root, file));
@@ -66,6 +71,17 @@ export async function buildMath({root = ROOT, updatePins = true} = {}) {
     components: [{name: FONT.name, version: FONT.version, license: FONT.license, source: FONT.source, sha256: FONT.sourceSha256}],
     font: {...FONT, licenseBytes: license.length},
   };
+  resources.adoption = [];
+  for (const {file, packageFile} of MATH_ADOPTION) {
+    const content = await readFile(resolve(root, file));
+    resources.adoption.push({file, packageFile, bytes: content.length, sha256: digest(content)});
+  }
+  return {resources, bytes};
+}
+
+export async function buildMath({root = ROOT, updatePins = true} = {}) {
+  const {resources, bytes} = await assembleMath({root});
+  const {sha256, sha384, gzipBytes} = resources;
   const vendor = resolve(root, 'shell/vendor');
   await mkdir(vendor, {recursive: true});
   await writeFile(resolve(vendor, MATH_BUNDLE), bytes);
@@ -82,7 +98,10 @@ export async function buildMath({root = ROOT, updatePins = true} = {}) {
     const loader = await readFile(loaderPath, 'utf8');
     const block = /(key: 'math',[\s\S]*?bytes: )\d+(,[\s\S]*?sri: ')[^']+(')/;
     if (!block.test(loader)) throw new Error('The math loader pin could not be located');
-    await writeFile(loaderPath, loader.replace(block, (_, before, middle, after) => before + bytes.length + middle + sha384 + after));
+    const version = /var MATH_VERSION = '[^']+';/;
+    if (!version.test(loader)) throw new Error('The math loader version could not be located');
+    await writeFile(loaderPath, loader.replace(version, "var MATH_VERSION = '" + MATH_VERSION + "';")
+      .replace(block, (_, before, middle, after) => before + bytes.length + middle + sha384 + after));
   }
   return {bundle: MATH_BUNDLE, bytes: bytes.length, gzipBytes, sha256, sha384};
 }

package/stream.d.ts

@@ -0,0 +1,14 @@
+// SPDX-License-Identifier: MIT
+export interface MarkdownSnapshot {source: string; html: string; revision: number; final: boolean}
+export interface MarkdownStream {
+  /** null means keep the previous preview; the chunk was still accepted. */
+  write(chunk: string): MarkdownSnapshot | null;
+  finish(): MarkdownSnapshot;
+  abort(): void;
+  /** Replace a message by resetting, then writing the replacement source. */
+  reset(): number;
+  readonly revision: number;
+}
+export function createMarkdownStream(renderMarkdown: (source: string) => string, options?: {
+  maxSourceLength?: number; previewEvery?: number;
+}): MarkdownStream;

package/stream.mjs

@@ -0,0 +1,46 @@
+// SPDX-License-Identifier: MIT
+// Full Markdown previews have no append-only promise. Geometric admission bounds
+// the total source passed to a synchronous host, including the final batch pass.
+export function createMarkdownStream(renderMarkdown, {maxSourceLength = 1_000_000, previewEvery = 256} = {}) {
+  if (typeof renderMarkdown !== 'function') throw new TypeError('Supply a synchronous Markdown renderer.');
+  for (const value of [maxSourceLength, previewEvery])
+    if (!Number.isSafeInteger(value) || value < 1) throw new RangeError('Stream limits must be positive finite integers.');
+  let chunks = [], length = 0, threshold = previewEvery, closed = false, revision = 0, rendering = false;
+  function open() {
+    if (closed || rendering) throw new Error(closed ? 'This stream is closed; reset it before writing.' : 'A stream renderer cannot reenter its stream.');
+  }
+  function snapshot(final) {
+    const source = chunks.join('');
+    chunks = source ? [source] : [];
+    // Failed previews consumed work too. Further chunks must still wait for the
+    // next geometric threshold; only an explicit finish retries immediately.
+    threshold = Math.max(previewEvery, length * 2);
+    rendering = true;
+    let html;
+    try {
+      html = renderMarkdown(source);
+      if (typeof html !== 'string') throw new TypeError('The Markdown renderer must return a string synchronously.');
+    } finally { rendering = false; }
+    if (final) { closed = true; chunks = []; length = 0; }
+    return {source, html, revision, final};
+  }
+  return {
+    write(chunk) {
+      open();
+      if (typeof chunk !== 'string') throw new TypeError('Decode transport bytes to strings before writing.');
+      if (chunk.length > maxSourceLength - length)
+        throw Object.assign(new RangeError('The message exceeds its source budget; this chunk was not accepted.'), {code: 'resource-limit'});
+      if (!chunk.length) return null;
+      chunks.push(chunk); length += chunk.length; revision++;
+      return length >= threshold ? snapshot(false) : null;
+    },
+    finish() { open(); revision++; return snapshot(true); },
+    abort() {
+      if (rendering) throw new Error('A stream renderer cannot abort its stream.');
+      if (closed) return;
+      chunks = []; length = 0; closed = true; revision++;
+    },
+    reset() { if (rendering) throw new Error('A stream renderer cannot reset its stream.'); chunks = []; length = 0; threshold = previewEvery; closed = false; return ++revision; },
+    get revision() { return revision; },
+  };
+}

package/verify.mjs

@@ -15,10 +15,11 @@ const payload = await read(resources.bundle);
 assert.equal(payload.length, resources.bytes, 'payload length');
 assert.equal(hash(payload), resources.sha256, 'payload SHA-256');
 assert.equal(hash(payload, 'sha384', 'base64'), resources.sha384, 'payload SHA-384');
-for (const input of [...resources.sources, ...resources.recipe]) {
+for (const input of [...resources.sources, ...resources.recipe, ...resources.adoption]) {
   const bytes = await read('src/' + input.file);
   assert.equal(bytes.length, input.bytes, input.file + ': length');
   assert.equal(hash(bytes), input.sha256, input.file + ': SHA-256');
+  if (input.packageFile) assert.deepEqual(await read(input.packageFile), bytes, input.packageFile + ': exact adoption source');
 }
 const rendererLicense = await read('src/math/LICENSE-MIT');
 for (const file of ['LICENSE-MIT', 'math-LICENSE.txt']) assert.deepEqual(await read(file), rendererLicense, file);
@@ -34,7 +35,11 @@ assert.equal(font.licenseDeclared, resources.font.license, 'font license identit
 assert.equal(sbom.hasExtractedLicensingInfos.find(item => item.licenseId === resources.font.license)?.extractedText,
   fontLicense.toString('utf8'), 'complete extracted font license');
 const {buildMath} = await import('./src/tools/build-math.mjs');
+const {mathReadme} = await import('./src/math/package-readme.mjs');
+assert.equal((await read('README.md')).toString('utf8'), mathReadme(resources), 'generated README source');
+for (const [file, owner] of [['check.mjs', 'package-check.mjs'], ['verify.mjs', 'package-verify.mjs'], ['adoption-check.mjs', 'adoption-verify.mjs']])
+  assert.deepEqual(await read(file), await read('src/math/' + owner), file + ': exact carried owner');
 await buildMath({root: source, updatePins: false});
 assert.deepEqual(await read('src/shell/vendor/' + resources.bundle), payload, 'rebuilt payload bytes');
 console.log(JSON.stringify({file: resources.bundle, bytes: payload.length, sha256: resources.sha256,
-  sources: resources.sources.length + resources.recipe.length, rebuild: 'exact', licenses: 'complete'}));
+  sources: resources.sources.length + resources.recipe.length, adoptionFiles: resources.adoption.length, rebuild: 'exact', licenses: 'complete'}));