From aa78c4ee410d52c971439342fd315bc5c6b8050b Mon Sep 17 00:00:00 2001
From: Felix Roos <flix91@gmail.com>
Date: Thu, 27 Jun 2024 15:06:13 +0200
Subject: [PATCH] add section about modules + implement exportModule

---
 packages/core/src/node.js     | 12 +++++++++++-
 website/src/pages/learn.astro | 27 +++++++++++++++++++++++++++
 2 files changed, 38 insertions(+), 1 deletion(-)

diff --git a/packages/core/src/node.js b/packages/core/src/node.js
index 5a76dda..df11602 100644
--- a/packages/core/src/node.js
+++ b/packages/core/src/node.js
@@ -53,7 +53,7 @@ let dfs = (node, fn, visited = []) => {
   return node;
 };
 
-let modules = new Map(); // module registry
+export let modules = new Map(); // module registry
 
 // user facing function to create modules
 export function module(name, fn) {
@@ -74,6 +74,16 @@ Node.prototype.resolveModules = function () {
   return resolveModules(this);
 };
 
+// converts a registered module into a json string
+export function exportModule(name) {
+  const mod = modules.get(name);
+  const inputs = Array.from({ length: mod.length }, (_, i) =>
+    node(`$INPUT${i}`)
+  );
+  const exported = mod(...inputs);
+  return JSON.stringify(exported, null, 2);
+}
+
 // returns true if the given node forms a cycle with "me" (or is me)
 function loopsToMe(node, me) {
   if (node === me) {
diff --git a/website/src/pages/learn.astro b/website/src/pages/learn.astro
index 9acf4fe..a1b8192 100644
--- a/website/src/pages/learn.astro
+++ b/website/src/pages/learn.astro
@@ -250,6 +250,33 @@ saw(midifreq().fork(8)) // 8 saw voices
   .out();`
         client:only="solid"
       />
+      <h2>Modules</h2>
+      The graph representation of the previous patch is very much cable salad at
+      this point. To improve things, you can define modules like this:
+      <MiniRepl
+        code=`let synth = module("synth", (freq, gate) => {
+  let env = gate.adsr(0.01, 0.4, 0.7, 0.1);
+  return saw(freq).mul(env)
+    .filter( env.range(0.2, 0.8).mul(env) );
+});
+
+let freq = impulse(4).seq(55,110,220,330)
+let gate = impulse(4).perc(.2)
+synth(freq, gate)
+.add((x) => x.delay(0.2).mul(0.4)) // feedback delay
+.out()`
+        client:only="solid"
+      />
+      <Box>
+        <p>
+          Note that in the graph above, the "synth" is a single node, hiding its
+          internal complexity.
+        </p>
+        <p>
+          Defining modules is a more advanced feature and requires you to know
+          how JS functions are written.
+        </p>
+      </Box>
     </main>
   </body>
 </html>