@adapt-toolkit/mufl 0.8.0

package/LICENSE

@@ -0,0 +1,172 @@
+ADAPT ENGINE FREE-USE LICENSE (AEFL)
+Version 1.0 — 2026-06-29
+
+Covers the MUFL compiler, the MUFL REPL, and the adapt evaluator binaries
+(together, the "Software").
+
+Copyright (c) 2026 ADAPT FRAMEWORK SOLUTIONS LTD. All rights reserved.
+ADAPT FRAMEWORK SOLUTIONS LTD, a company registered in England and Wales
+(company no. 12371061), registered office: Steward House, 14 Commercial Way,
+Woking, England, GU21 6ET.
+
+PREAMBLE (non-binding)
+This license lets anyone download and use the MUFL compiler, REPL, and adapt
+evaluator at no charge, for any purpose including commercial, and keep full
+ownership of everything they build with them. The binaries are free to use and
+to redistribute unchanged; the underlying source code remains proprietary and
+may not be reverse engineered. If a term and the binding text below disagree,
+the binding text controls.
+
+
+1. DEFINITIONS
+
+ 1.1 "Software" means the MUFL compiler, the MUFL REPL, and the adapt evaluator
+     binaries distributed under this license, in any form (native executable,
+     archive, WebAssembly module, or N-API module), including any updates the
+     Licensor distributes under this license, but excluding any source code.
+
+ 1.2 "Licensor" means the copyright holder identified above and its successors
+     and assigns.
+
+ 1.3 "You" (or "Your") means the individual or legal entity exercising rights
+     under this license.
+
+ 1.4 "Your Programs" means source code, configuration, and data that You author
+     or supply for processing by the Software.
+
+ 1.5 "Output" means any artifact the Software produces from Your Programs,
+     including compiled modules, intermediate representations, and the results
+     of evaluation or execution.
+
+
+2. GRANT OF RIGHTS
+
+ Subject to Your compliance with this license, the Licensor grants You a
+ worldwide, royalty-free, non-exclusive, perpetual (subject to Section 8)
+ license to:
+
+ (a) install and run the Software, on any number of machines, for any purpose,
+     including commercial use, at no charge;
+
+ (b) use the Software to author, compile, evaluate, execute, debug, and test
+     Your Programs; and
+
+ (c) redistribute the Software to third parties, provided that each copy is
+     complete and unmodified and that a verbatim copy of this license
+     accompanies it.
+
+
+3. YOUR PROGRAMS AND OUTPUT
+
+ The Licensor claims no ownership of, and asserts no rights over, Your Programs
+ or the Output. You may use, reproduce, distribute, sublicense, sell, and
+ otherwise commercialize Your Programs and the Output without restriction and
+ without any obligation, attribution, or fee under this license. Authoring,
+ compiling, evaluating, or executing Your Programs with the Software does not
+ place Your Programs or the Output under this license or any obligation arising
+ from it.
+
+
+4. RESTRICTIONS
+
+ You may not:
+
+ (a) reverse engineer, decompile, disassemble, or otherwise attempt to derive
+     the source code, internal design, structure, or algorithms of the
+     Software, except, and only to the limited extent, that applicable law
+     expressly forbids restricting such acts notwithstanding this limitation;
+
+ (b) modify, adapt, translate, or create derivative works of the Software, or
+     distribute any modified copy of the Software;
+
+ (c) remove, alter, or obscure any copyright, trademark, license, or other
+     proprietary notice contained in or accompanying the Software;
+
+ (d) use the Software, or any knowledge, measurement, or observation obtained
+     from it, to design, develop, train, or distribute a competing compiler,
+     REPL, evaluator, language runtime, or substantially similar product or
+     service; or
+
+ (e) use any name, logo, or trademark of the Licensor, except as strictly
+     necessary to identify unmodified redistributions of the Software, and
+     never in a manner that suggests endorsement, sponsorship, or affiliation
+     without the Licensor's prior written permission.
+
+
+5. RESERVATION OF RIGHTS
+
+ The Software is licensed, not sold. The Licensor and its licensors retain all
+ right, title, and interest in and to the Software, including all intellectual
+ property rights and all rights in the Software's source code. All rights not
+ expressly granted to You in this license are reserved.
+
+
+6. NO WARRANTY
+
+ THE SOFTWARE IS PROVIDED "AS IS" AND "AS AVAILABLE", WITHOUT WARRANTY OF ANY
+ KIND, WHETHER EXPRESS, IMPLIED, STATUTORY, OR OTHERWISE, INCLUDING WITHOUT
+ LIMITATION THE IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
+ PURPOSE, TITLE, AND NON-INFRINGEMENT. THE LICENSOR DOES NOT WARRANT THAT THE
+ SOFTWARE WILL BE UNINTERRUPTED, ERROR-FREE, OR FREE OF HARMFUL COMPONENTS, OR
+ THAT ITS OUTPUT WILL BE ACCURATE OR RELIABLE.
+
+
+7. LIMITATION OF LIABILITY
+
+ TO THE MAXIMUM EXTENT PERMITTED BY APPLICABLE LAW, IN NO EVENT SHALL THE
+ LICENSOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY,
+ OR CONSEQUENTIAL DAMAGES, OR FOR ANY LOSS OF PROFITS, REVENUE, DATA, OR
+ GOODWILL, ARISING OUT OF OR IN CONNECTION WITH THE SOFTWARE OR ITS USE OR
+ INABILITY TO BE USED, WHETHER IN CONTRACT, TORT (INCLUDING NEGLIGENCE),
+ STRICT LIABILITY, OR ANY OTHER THEORY, EVEN IF ADVISED OF THE POSSIBILITY OF
+ SUCH DAMAGES. THIS SOFTWARE IS PROVIDED FREE OF CHARGE, AND THIS ALLOCATION OF
+ RISK IS AN ESSENTIAL BASIS OF THE LICENSOR'S DECISION TO PROVIDE IT.
+
+
+8. TERM AND TERMINATION
+
+ This license takes effect when You first download, install, or use the
+ Software and continues until terminated. It terminates automatically and
+ immediately if You breach any of its terms. Upon termination You must cease
+ all use of the Software and destroy all copies in Your possession or control.
+ Sections 3, 5, 6, 7, 9, and 10 survive termination. Termination does not
+ affect Your Programs or Output created before termination, nor any rights of
+ third parties who received the Software from You in compliance with this
+ license.
+
+
+9. GOVERNING LAW
+
+ This license is governed by and construed in accordance with the laws of
+ England and Wales, excluding its conflict-of-laws rules and excluding the
+ United Nations Convention on Contracts for the International Sale of Goods. The
+ courts of England and Wales shall have exclusive jurisdiction over any dispute
+ arising out of or relating to this license.
+
+
+10. GENERAL
+
+ 10.1 Entire Agreement. This license is the entire agreement between You and the
+      Licensor regarding the Software and supersedes any prior or contemporaneous
+      understandings.
+
+ 10.2 Severability. If any provision is held unenforceable, it shall be modified
+      to the minimum extent necessary to make it enforceable, and the remaining
+      provisions shall remain in full force.
+
+ 10.3 No Waiver. The Licensor's failure to enforce any provision is not a waiver
+      of its right to do so later.
+
+ 10.4 Assignment. You may not assign or transfer this license except as part of
+      a permitted, unmodified redistribution of the Software under Section 2(c).
+      The Licensor may assign this license freely.
+
+ 10.5 Reservation for Separate Terms. The Licensor may make the Software, or
+      additional rights to it, available to You or others under separate written
+      terms (for example, a commercial or source license). Those terms govern
+      only where expressly agreed and do not limit the rights granted here.
+
+ END OF TERMS
+
+To request rights beyond this license (including commercial source licensing),
+contact: alex@adaptframework.solutions.

package/LICENSE.fsl

@@ -0,0 +1,105 @@
+# Functional Source License, Version 1.1, ALv2 Future License
+
+## Abbreviation
+
+FSL-1.1-ALv2
+
+## Notice
+
+Copyright 2026 ADAPT FRAMEWORK SOLUTIONS LTD
+
+## Terms and Conditions
+
+### Licensor ("We")
+
+The party offering the Software under these Terms and Conditions.
+
+### The Software
+
+The "Software" is each version of the software that we make available under
+these Terms and Conditions, as indicated by our inclusion of these Terms and
+Conditions with the Software.
+
+### License Grant
+
+Subject to your compliance with this License Grant and the Patents,
+Redistribution and Trademark clauses below, we hereby grant you the right to
+use, copy, modify, create derivative works, publicly perform, publicly display
+and redistribute the Software for any Permitted Purpose identified below.
+
+### Permitted Purpose
+
+A Permitted Purpose is any purpose other than a Competing Use. A Competing Use
+means making the Software available to others in a commercial product or
+service that:
+
+1. substitutes for the Software;
+
+2. substitutes for any other product or service we offer using the Software
+   that exists as of the date we make the Software available; or
+
+3. offers the same or substantially similar functionality as the Software.
+
+Permitted Purposes specifically include using the Software:
+
+1. for your internal use and access;
+
+2. for non-commercial education;
+
+3. for non-commercial research; and
+
+4. in connection with professional services that you provide to a licensee
+   using the Software in accordance with these Terms and Conditions.
+
+### Patents
+
+To the extent your use for a Permitted Purpose would necessarily infringe our
+patents, the license grant above includes a license under our patents. If you
+make a claim against any party that the Software infringes or contributes to
+the infringement of any patent, then your patent license to the Software ends
+immediately.
+
+### Redistribution
+
+The Terms and Conditions apply to all copies, modifications and derivatives of
+the Software.
+
+If you redistribute any copies, modifications or derivatives of the Software,
+you must include a copy of or a link to these Terms and Conditions and not
+remove any copyright notices provided in or with the Software.
+
+### Disclaimer
+
+THE SOFTWARE IS PROVIDED "AS IS" AND WITHOUT WARRANTIES OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING WITHOUT LIMITATION WARRANTIES OF FITNESS FOR A PARTICULAR
+PURPOSE, MERCHANTABILITY, TITLE OR NON-INFRINGEMENT.
+
+IN NO EVENT WILL WE HAVE ANY LIABILITY TO YOU ARISING OUT OF OR RELATED TO THE
+SOFTWARE, INCLUDING INDIRECT, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES,
+EVEN IF WE HAVE BEEN INFORMED OF THEIR POSSIBILITY IN ADVANCE.
+
+### Trademarks
+
+Except for displaying the License Details and identifying us as the origin of
+the Software, you have no right under these Terms and Conditions to use our
+trademarks, trade names, service marks or product names.
+
+## Grant of Future License
+
+We hereby irrevocably grant you an additional license to use the Software under
+the Apache License, Version 2.0 that is effective on the second anniversary of
+the date we make the Software available. On or after that date, you may use the
+Software under the Apache License, Version 2.0, in which case the following
+will apply:
+
+Licensed under the Apache License, Version 2.0 (the "License"); you may not use
+this file except in compliance with the License.
+
+You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software distributed
+under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
+CONDITIONS OF ANY KIND, either express or implied. See the License for the
+specific language governing permissions and limitations under the License.

package/NOTICE

@@ -0,0 +1,25 @@
+NOTICE — Bundled proprietary components (@adapt-toolkit/mufl)
+
+This package ships two kinds of content under two licenses. The package
+`license` field says "SEE LICENSE IN LICENSE"; this file is the map.
+
+1. ENGINE BINARIES — the `mufl` (REPL) and `mufl-compile` (compiler)
+   executables under prebuilds/ are proprietary software of ADAPT FRAMEWORK
+   SOLUTIONS LTD, licensed under the Adapt Engine Free-Use License (AEFL);
+   the full text is in the LICENSE file at the package root. Free use,
+   including commercial use; redistribution only complete and unmodified with
+   the license text; no modification, derivatives, or reverse engineering.
+
+2. EVERYTHING ELSE — the Node launcher shims (bin/, lib/) and the bundled
+   MUFL source trees (mufl_stdlib/, meta/, transactions/) are licensed under
+   the Functional Source License, Version 1.1, Apache 2.0 Future License
+   (FSL-1.1-Apache-2.0); the full text is in the LICENSE.fsl file.
+
+For the avoidance of doubt, the binaries in (1) are EXCLUDED from the FSL
+grant AND from the FSL "Future License" conversion: they do NOT become
+available under Apache-2.0 (or any other license) on the Change Date or at
+any other time. All rights in them are reserved except as expressly granted
+by the AEFL. The proprietary MUFL/adapt engine implementation is never
+distributed in source form.
+
+Source-access / commercial licensing: alex@adaptframework.solutions

package/README.md

@@ -0,0 +1,70 @@
+# @adapt-toolkit/mufl
+
+The MUFL toolchain as an npm package: prebuilt **`mufl`** (REPL / unified CLI)
+and **`mufl-compile`** (compiler) engine binaries, plus the MUFL standard
+library trees they need at run time (`mufl_stdlib/`, `meta/`, `transactions/`).
+
+```sh
+npm install @adapt-toolkit/mufl
+
+npx mufl-compile my_packet.mu     # writes a content-hashed <hash>.muflo to the cwd
+npx mufl --help                   # unified CLI: compile / run / repl subcommands
+npx mufl                          # interactive REPL (console mode)
+```
+
+## Platform support
+
+`linux-x64` (glibc) only. On any other platform/arch both commands exit 1 with:
+
+```
+@adapt-toolkit/mufl: no prebuilt binary for <platform>-<arch> (available: linux-x64)
+```
+
+On unsupported platforms, build from an adapt-toolkit checkout instead and
+point your scripts at it (see the environment contract below — it is preserved
+verbatim, so checkout-based workflows keep working).
+
+Requires Node >= 20. The package weighs tens of MB (two native binaries plus
+three MUFL source trees).
+
+## Environment / flag contract
+
+The launcher shims are thin: they spawn the real binary with your stdio and
+propagate its exit code and signals. Two defaults are injected, both losing to
+the caller:
+
+- **`MUFL_STDLIB_PATH`** — set to the packaged `mufl_stdlib/` **unless already
+  set in your environment**. Your value always wins.
+- **`-mp` meta search paths** — `-mp <pkg>/meta -mp <pkg>/transactions` are
+  appended **only when you passed no `-mp` flag at all**. Any caller-supplied
+  `-mp` disables the packaged defaults entirely (compose your own full set,
+  exactly like invocations inside an adapt checkout do).
+
+## Programmatic paths
+
+Build scripts can locate the toolkit without spawning a process:
+
+```js
+import { binDir, stdlibPath, metaPath, transactionsPath, binaryPath }
+  from '@adapt-toolkit/mufl/paths';
+
+binaryPath('mufl-compile'); // <pkg>/prebuilds/linux-x64/mufl-compile
+                            // throws the unsupported-platform error elsewhere
+```
+
+## Versioning
+
+Version-locked to `@adapt-toolkit/sdk`: every release of this package is built
+from the same CI run of the same commit as the SDK of the same version.
+
+## License
+
+`SEE LICENSE IN LICENSE` — dual scheme, mapped in [NOTICE](./NOTICE):
+
+- the **engine binaries** (`prebuilds/`) are proprietary, under the
+  **Adapt Engine Free-Use License (AEFL)** — full text in `LICENSE`;
+- the **launcher shims and bundled MUFL source trees** are under the
+  **Functional Source License, Version 1.1, Apache 2.0 Future License
+  (FSL-1.1-Apache-2.0)** — full text in `LICENSE.fsl`.
+
+Source-access / commercial licensing: alex@adaptframework.solutions

package/bin/mufl-compile.js

@@ -0,0 +1,4 @@
+#!/usr/bin/env node
+import { run } from '../lib/launcher.js';
+
+run('mufl-compile');

package/bin/mufl.js

@@ -0,0 +1,4 @@
+#!/usr/bin/env node
+import { run } from '../lib/launcher.js';
+
+run('mufl');

package/lib/launcher.js

@@ -0,0 +1,60 @@
+// Shared launcher logic for the `mufl` / `mufl-compile` bin shims.
+// Precedence contract (SPEC-5): a caller-provided MUFL_STDLIB_PATH always wins
+// over the packaged stdlib, and any caller-supplied -mp flag disables the
+// packaged -mp defaults entirely.
+
+import { existsSync } from 'node:fs';
+import { spawn } from 'node:child_process';
+
+import { stdlibPath, metaPath, transactionsPath, binaryPath } from './paths.js';
+
+export function buildEnv(env = process.env) {
+  const out = { ...env };
+  if (out.MUFL_STDLIB_PATH === undefined) {
+    out.MUFL_STDLIB_PATH = stdlibPath;
+  }
+  return out;
+}
+
+export function buildArgs(argv) {
+  if (argv.includes('-mp')) {
+    return [...argv];
+  }
+  return [...argv, '-mp', metaPath, '-mp', transactionsPath];
+}
+
+export function run(name, argv = process.argv.slice(2)) {
+  let bin;
+  try {
+    bin = binaryPath(name);
+  } catch (err) {
+    console.error(err.message);
+    process.exit(1);
+  }
+  if (!existsSync(bin)) {
+    console.error(`@adapt-toolkit/mufl: prebuilt binary missing at ${bin} (broken install?)`);
+    process.exit(1);
+  }
+
+  const child = spawn(bin, buildArgs(argv), {
+    stdio: 'inherit',
+    env: buildEnv(),
+  });
+
+  for (const sig of ['SIGINT', 'SIGTERM']) {
+    process.on(sig, () => child.kill(sig));
+  }
+
+  child.on('error', (err) => {
+    console.error(`@adapt-toolkit/mufl: failed to launch ${name}: ${err.message}`);
+    process.exit(1);
+  });
+
+  child.on('close', (code, signal) => {
+    if (signal) {
+      process.kill(process.pid, signal);
+      return;
+    }
+    process.exit(code ?? 1);
+  });
+}

package/lib/paths.js

@@ -0,0 +1,26 @@
+// Programmatic access to the toolkit paths shipped in this package.
+// Public interface: exported as `@adapt-toolkit/mufl/paths` — consumer build
+// scripts locate the compiler and its runtime trees through these instead of
+// spawning the CLI per query.
+
+import { resolve, dirname } from 'node:path';
+import { fileURLToPath } from 'node:url';
+
+const pkgRoot = resolve(dirname(fileURLToPath(import.meta.url)), '..');
+
+const SUPPORTED = ['linux-x64'];
+
+export const binDir = resolve(pkgRoot, 'prebuilds');
+export const stdlibPath = resolve(pkgRoot, 'mufl_stdlib');
+export const metaPath = resolve(pkgRoot, 'meta');
+export const transactionsPath = resolve(pkgRoot, 'transactions');
+
+export function binaryPath(name, platform = process.platform, arch = process.arch) {
+  const platformArch = `${platform}-${arch}`;
+  if (!SUPPORTED.includes(platformArch)) {
+    throw new Error(
+      `@adapt-toolkit/mufl: no prebuilt binary for ${platformArch} (available: ${SUPPORTED.join(', ')})`,
+    );
+  }
+  return resolve(binDir, platformArch, name);
+}