@the-inclusionist/engine 8.0.0 → 10.0.0

package/scripts/heavy-into-the-delivery.mjs

@@ -0,0 +1,144 @@
+#!/usr/bin/env node
+// SPDX-License-Identifier: AGPL-3.0-or-later
+//
+// Puts the heavy files into a delivery (ADR-0177, issue #173): each upstream address of the download catalogue is fetched at
+// BUILD time, checked against its pinned sha256, and written to `<destination>/heavy/<host><path>` — where the page asks for
+// it. A file whose hash differs stops the build: nothing unchecked reaches a delivery.
+//
+// Usage (after `npm run build`): `npm run heavy:delivery` — builds the package, then `node scripts/heavy-into-the-delivery.mjs dist`.
+// A cartridge, after its own build, runs the published command: `npx inclusionist-heavy dist`. The catalogue is read from the
+// package beside this script, never from the caller's folder.
+// ⚠️ It downloads about 300 MB from Hugging Face, jsDelivr and Google Storage: the build machine
+// contacts them once, and the child's device never does.
+//
+// WHERE FROM IS A CHOICE (the Dev, 2026-09-21): `--base <address or folder>`, the variable `INCLUSIONIST_HEAVY_BASE`, or a `.env`
+// beside the build. With a base, each file comes from the project's mirror, a school's server or a folder on this machine
+// (`platform/heavy-mirror`); without one, from upstream. The sha256 check does not move: a base that serves other bytes writes
+// nothing, which is why pointing elsewhere is safe and needs no trust.
+//
+// WHAT THE FILES OWE TRAVELS WITH THEM (`licences/third-party.mjs`): every folder of `heavy/` that holds a file also gets its
+// project's `LICENSE` and `NOTICE` (eSpeak NG's also a `SOURCE`), and `heavy/THIRD-PARTY-NOTICES.md` lists each project. A
+// catalogue entry whose licence nobody recorded there is refused like a file whose sha256 differs.
+
+import { mkdirSync, writeFileSync, readFileSync, existsSync, realpathSync } from 'node:fs';
+import { dirname, join } from 'node:path';
+import { createHash } from 'node:crypto';
+import { pathToFileURL, fileURLToPath } from 'node:url';
+import { THIRD_PARTY, groupOf, writeLicences } from './licences/third-party.mjs';
+
+/** The compiled catalogue of the package this script ships in — beside it, whatever folder the build runs from. */
+export function moduloDoPacote() {
+  return new URL('../dist-pkg/platform/heavy.js', import.meta.url).href;
+}
+
+const sha256DoNode = (buf) => createHash('sha256').update(Buffer.from(buf)).digest('hex');
+
+/**
+ * Fetches, checks and writes every entry with an address, then the licence files beside them. Returns one line per entry and
+ * the licence folders written (`licences`); `ok` is false when any file — or the licences — failed.
+ * Everything is injected so a gate can run it without the network.
+ */
+export async function levarPesadosParaEntrega({ destino, pesados, deliveryPath, fetch: buscar = fetch, sha256 = sha256DoNode,
+  base = '', fonteDe = (url) => url, lerLocal = (caminho) => readFileSync(caminho), thirdParty = THIRD_PARTY }) {
+  const linhas = [];
+  const present = [];
+  for (const p of pesados) {
+    if (!p.url) { linhas.push({ id: p.id, outcome: 'sem-fonte' }); continue; }
+    if (!groupOf(p.id, thirdParty)) {
+      linhas.push({ id: p.id, outcome: 'falhou', error: 'no licence recorded for it in scripts/licences/third-party.mjs — not written' });
+      continue;
+    }
+    const alvo = join(destino, deliveryPath(p.url));
+    if (existsSync(alvo) && sha256(readFileSync(alvo)) === p.sha256) {
+      linhas.push({ id: p.id, outcome: 'ja-tinha' });
+      present.push({ id: p.id, path: deliveryPath(p.url) });
+      continue;
+    }
+    const fonte = fonteDe(p.url, base);
+    const daRede = /^https?:\/\//i.test(fonte);
+    try {
+      let corpo;
+      if (daRede) {
+        const resp = await buscar(fonte);
+        if (!resp.ok) { linhas.push({ id: p.id, outcome: 'falhou', error: `HTTP ${resp.status} — ${fonte}` }); continue; }
+        corpo = await resp.arrayBuffer();
+      } else {
+        corpo = lerLocal(fonte);
+      }
+      const obtido = sha256(corpo);
+      if (!p.sha256 || obtido !== p.sha256) {
+        linhas.push({ id: p.id, outcome: 'falhou', error: `sha256 mismatch at ${fonte}: expected ${p.sha256}, got ${obtido} — not written` });
+        continue;
+      }
+      mkdirSync(dirname(alvo), { recursive: true });
+      writeFileSync(alvo, Buffer.from(corpo));
+      linhas.push({ id: p.id, outcome: 'escrito', bytes: corpo.byteLength });
+      present.push({ id: p.id, path: deliveryPath(p.url) });
+    } catch (e) {
+      linhas.push({ id: p.id, outcome: 'falhou', error: e instanceof Error ? e.message : String(e) });
+    }
+  }
+  let licences = [];
+  try {
+    licences = writeLicences({ destination: destino, present, groups: thirdParty });
+  } catch (e) {
+    linhas.push({ id: 'licences', outcome: 'falhou', error: e instanceof Error ? e.message : String(e) });
+  }
+  return { ok: linhas.every((l) => l.outcome !== 'falhou'), linhas, licences };
+}
+
+/**
+ * The command's arguments, which are the game's answers (ADR-0216 §3) said to the build:
+ *
+ * · `--kokoro` for a game that declares `uses: { neuralVoice: true }` — without it Kokoro's model, voices and runtime stay out of
+ *   the delivery, as they stay out of the start's download.
+ * · `--reading <pt|en|es>`, repeatable, for a game that declares `uses: { reading: true }`: each language named puts ITS model in
+ *   the delivery (pt 378 MiB, en 162, es 310). A delivery for a school that reads in one language carries one.
+ * · `--commands <pt|en|es>`, repeatable: the voice COMMANDS (issue #184), 31–39 MiB a language plus 3.1 MiB of runtime. No game
+ *   declares this one — saying «menu» is a way into the controller, not a feature (ADR-0111) — so it is the DELIVERY that says
+ *   which languages it serves. Without it a child who speaks is told the delivery carries no model for her language.
+ */
+export function argumentosDaEntrega(args, ambiente = process.env) {
+  // ⚠️ `--base <value>` eats the token after it: without that, the value was read as the delivery folder (caught by its case).
+  let destino, base;
+  const reading = [];
+  const commands = [];
+  for (let i = 0; i < args.length; i++) {
+    if (args[i] === '--base') { base = args[++i]; continue; }
+    if (args[i] === '--reading') { const v = args[++i]; if (v) reading.push(v); continue; }
+    if (args[i] === '--commands') { const v = args[++i]; if (v) commands.push(v); continue; }
+    if (!args[i].startsWith('--') && destino === undefined) destino = args[i];
+  }
+  return { destino, kokoro: args.includes('--kokoro'), reading, commands, base: base ?? ambiente.INCLUSIONIST_HEAVY_BASE ?? '' };
+}
+
+/** A `.env` beside the build, if there is one: Node reads it into `process.env`, and the command line still wins. */
+export function carregarEnv(caminho = join(process.cwd(), '.env'), carregar = process.loadEnvFile) {
+  try { if (existsSync(caminho)) carregar.call(process, caminho); return true; } catch { return false; }
+}
+
+// Run as a program (directly, or through the `inclusionist-heavy` shim, which may be a symlink): compare real paths.
+const executado = (() => { try { return realpathSync(process.argv[1] ?? '') === realpathSync(fileURLToPath(import.meta.url)); } catch { return false; } })();
+if (executado) {
+  carregarEnv();
+  const { destino, kokoro, reading, commands, base } = argumentosDaEntrega(process.argv.slice(2));
+  if (!destino) { console.error('usage: inclusionist-heavy <delivery folder, e.g. dist> [--kokoro] [--reading pt|en|es]… [--commands pt|en|es]…'); process.exit(2); }
+  const modulo = moduloDoPacote();
+  if (!existsSync(fileURLToPath(modulo))) { console.error('dist-pkg/platform/heavy.js is missing beside this script: in the engine repository, run `npm run build:pkg` first'); process.exit(2); }
+  const { HEAVY_FILES, deliveryPath, heavyAtBoot } = await import(modulo);
+  const { heavySourceOf } = await import(new URL('../dist-pkg/platform/heavy-mirror.js', import.meta.url).href);
+  // one pass per language, because the start asks for ONE and the delivery may hold several
+  const ids = [...new Set([
+    ...heavyAtBoot({ kokoro }),
+    ...reading.flatMap((lingua) => heavyAtBoot({ kokoro: false, reading: lingua })),
+    ...commands.flatMap((lingua) => heavyAtBoot({ kokoro: false, commands: lingua })),
+  ])];
+  if (base) console.log(`base: ${base}`);
+  const { ok, linhas, licences } = await levarPesadosParaEntrega({
+    destino, pesados: HEAVY_FILES.filter((p) => ids.includes(p.id)), deliveryPath, base, fonteDe: heavySourceOf,
+  });
+  for (const l of linhas) console.log(`${l.outcome.padEnd(9)} ${l.id}${l.error ? ` — ${l.error}` : ''}`);
+  for (const l of licences) console.log(`licence   ${l.key} — ${l.folders.length} folder(s)`);
+  if (licences.length) console.log('notices   heavy/THIRD-PARTY-NOTICES.md');
+  if (!ok) { console.error('a heavy file failed: the delivery is incomplete, and nothing unchecked was written'); process.exit(1); }
+}

package/scripts/licences/Apache-2.0.txt

@@ -0,0 +1,176 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. this License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS