Merge branch 'main' into matthewkaney/add-undocumented

jsdoc/undocumented.mjs

@@ -10,7 +10,7 @@ function getExports(code) {
   let ast;
   try {
     ast = parse(code, {
-      ecmaVersion: 11,
+      ecmaVersion: 'latest',
       sourceType: 'module',
     });
   } catch (err) {
@@ -49,9 +49,7 @@ function getExports(code) {
 }
 
 function isDocumented(name, docs) {
-  return docs.find(
+  return docs.find((d) => d.name === name || d.synonyms?.includes(name));
-    (d) => d.name === name || d.tags?.find((t) => t.title === 'synonyms' && t.value.split(', ').includes(name)),
-  );
 }
 
 async function getUndocumented(path, docs) {

packages/core/pattern.mjs

@@ -3289,6 +3289,7 @@ export const striate = register('striate', function (n, pat) {
 /**
  * Makes the sample fit the given number of cycles by changing the speed.
  * @name loopAt
+ * @synonyms loopat
  * @memberof Pattern
  * @returns Pattern
  * @example
@@ -3421,6 +3422,7 @@ export const fit = register('fit', (pat) =>
  * given by a global clock and this function will be
  * deprecated/removed.
  * @name loopAtCps
+ * @synonyms loopatcps
  * @memberof Pattern
  * @returns Pattern
  * @example

packages/core/signal.mjs

@@ -10,11 +10,27 @@ import Fraction from './fraction.mjs';
 
 import { id, keyAlias, getCurrentKeyboardState } from './util.mjs';
 
+/**
+ * A `signal` consisting of a constant value. Similar to `pure`, except that function
+ * creates a pattern with one event per cycle, whereas this pattern doesn't have an intrinsic
+ * structure.
+ *
+ * @param {*} value The constant value of the resulting pattern
+ * @returns Pattern
+ */
 export function steady(value) {
   // A continuous value
   return new Pattern((state) => [new Hap(undefined, state.span, value)]);
 }
 
+/**
+ * Creates a "signal", an unstructured pattern consisting of a single value that changes
+ * over time.
+ *
+ *
+ * @param {*} func
+ * @returns Pattern
+ */
 export const signal = (func) => {
   const query = (state) => [new Hap(undefined, state.span, func(state.span.begin))];
   return new Pattern(query);
@@ -23,7 +39,7 @@ export const signal = (func) => {
 /**
  *  A sawtooth signal between 0 and 1.
  *
- * @return {Pattern}
+ * @type {Pattern}
  * @example
  * note("<c3 [eb3,g3] g2 [g3,bb3]>*8")
  * .clip(saw.slow(2))
@@ -157,6 +173,7 @@ export const time = signal(id);
 /**
  *  The mouse's x position value ranges from 0 to 1.
  * @name mousex
+ * @synonyms mouseX
  * @return {Pattern}
  * @example
  * n(mousex.segment(4).range(0,7)).scale("C:minor")
@@ -166,6 +183,7 @@ export const time = signal(id);
 /**
  *  The mouse's y position value ranges from 0 to 1.
  * @name mousey
+ * @synonyms mouseY
  * @return {Pattern}
  * @example
  * n(mousey.segment(4).range(0,7)).scale("C:minor")
@@ -215,10 +233,6 @@ const timeToRandsPrime = (seed, n) => {
 
 const timeToRands = (t, n) => timeToRandsPrime(timeToIntSeed(t), n);
 
-/**
- *
- */
-
 /**
  * A discrete pattern of numbers from 0 to n-1
  * @example
@@ -389,17 +403,23 @@ export const chooseInWith = (pat, xs) => {
 
 /**
  * Chooses randomly from the given list of elements.
+ * @synonyms chooseOut
  * @param  {...any} xs values / patterns to choose from.
  * @returns {Pattern} - a continuous pattern.
  * @example
  * note("c2 g2!2 d2 f1").s(choose("sine", "triangle", "bd:6"))
  */
 export const choose = (...xs) => chooseWith(rand, xs);
-
-// todo: doc
-export const chooseIn = (...xs) => chooseInWith(rand, xs);
 export const chooseOut = choose;
 
+/**
+ * As with {choose}, but the structure comes from the chosen values, rather
+ * than the pattern you're using to choose with.
+ * @param  {...any} xs
+ * @returns
+ */
+export const chooseIn = (...xs) => chooseInWith(rand, xs);
+
 /**
  * Chooses from the given list of values (or patterns of values), according
  * to the pattern that the method is called on. The pattern should be in
@@ -496,6 +516,7 @@ function _perlin(t) {
   const v = interp(t - ta)(timeToRand(ta))(timeToRand(tb));
   return v;
 }
+
 export const perlinWith = (tpat) => {
   return tpat.fmap(_perlin);
 };
@@ -541,6 +562,15 @@ export const perlin = perlinWith(time.fmap((v) => Number(v)));
  */
 export const berlin = berlinWith(time.fmap((v) => Number(v)));
 
+/**
+ * Removes events from a pattern given a signal of numbers and a cutoff
+ * value for interpreting that pattern as true or false.
+ * @param {number} withPat - A numeric pattern for comparing the main pattern
+ * against. Values higher than the cutoff will let events through and lower
+ * values will remove events from the main pattern
+ * @param {number} cutoff - The threshold value to use when interpreting the
+ * `withPat`
+ */
 export const degradeByWith = register(
   'degradeByWith',
   (withPat, x, pat) => pat.fmap((a) => (_) => a).appLeft(withPat.filterValues((v) => v > x)),

undocumented.json

@@ -32,7 +32,12 @@
   "/packages/codemirror/keybindings.mjs": [
     "keybindings"
   ],
-  "/packages/codemirror/themes/strudel-theme.mjs": [],
+  "/packages/codemirror/themes/theme-helper.mjs": [
+    "createTheme"
+  ],
+  "/packages/codemirror/themes/strudel-theme.mjs": [
+    "settings"
+  ],
   "/packages/codemirror/themes/bluescreen.mjs": [
     "settings"
   ],
@@ -48,7 +53,103 @@
   "/packages/codemirror/themes/algoboy.mjs": [
     "settings"
   ],
-  "/packages/codemirror/themes/terminal.mjs": [
+  "/packages/codemirror/themes/CutiePi.mjs": [
+    "settings"
+  ],
+  "/packages/codemirror/themes/sonic-pink.mjs": [
+    "settings"
+  ],
+  "/packages/codemirror/themes/red-text.mjs": [
+    "settings"
+  ],
+  "/packages/codemirror/themes/green-text.mjs": [
+    "settings"
+  ],
+  "/packages/codemirror/themes/archBtw.mjs": [
+    "settings"
+  ],
+  "/packages/codemirror/themes/fruitDaw.mjs": [
+    "settings"
+  ],
+  "/packages/codemirror/themes/bluescreenlight.mjs": [
+    "settings"
+  ],
+  "/packages/codemirror/themes/androidstudio.mjs": [
+    "settings"
+  ],
+  "/packages/codemirror/themes/atomone.mjs": [
+    "settings"
+  ],
+  "/packages/codemirror/themes/aura.mjs": [
+    "settings"
+  ],
+  "/packages/codemirror/themes/darcula.mjs": [
+    "settings"
+  ],
+  "/packages/codemirror/themes/dracula.mjs": [
+    "settings"
+  ],
+  "/packages/codemirror/themes/duotoneDark.mjs": [
+    "settings"
+  ],
+  "/packages/codemirror/themes/eclipse.mjs": [
+    "settings"
+  ],
+  "/packages/codemirror/themes/githubDark.mjs": [
+    "settings"
+  ],
+  "/packages/codemirror/themes/githubLight.mjs": [
+    "settings"
+  ],
+  "/packages/codemirror/themes/gruvboxDark.mjs": [
+    "settings"
+  ],
+  "/packages/codemirror/themes/gruvboxLight.mjs": [
+    "settings"
+  ],
+  "/packages/codemirror/themes/materialDark.mjs": [
+    "settings"
+  ],
+  "/packages/codemirror/themes/materialLight.mjs": [
+    "settings"
+  ],
+  "/packages/codemirror/themes/nord.mjs": [
+    "settings"
+  ],
+  "/packages/codemirror/themes/monokai.mjs": [
+    "settings"
+  ],
+  "/packages/codemirror/themes/solarizedDark.mjs": [
+    "settings"
+  ],
+  "/packages/codemirror/themes/solarizedLight.mjs": [
+    "settings"
+  ],
+  "/packages/codemirror/themes/sublime.mjs": [
+    "settings"
+  ],
+  "/packages/codemirror/themes/tokyoNight.mjs": [
+    "settings"
+  ],
+  "/packages/codemirror/themes/tokioNightStorm.mjs": [
+    "settings"
+  ],
+  "/packages/codemirror/themes/tokyoNightDay.mjs": [
+    "settings"
+  ],
+  "/packages/codemirror/themes/vscodeDark.mjs": [
+    "settings"
+  ],
+  "/packages/codemirror/themes/vscodeLight.mjs": [
+    "settings"
+  ],
+  "/packages/codemirror/themes/xcodeLight.mjs": [
+    "settings"
+  ],
+  "/packages/codemirror/themes/bbedit.mjs": [
+    "settings"
+  ],
+  "/packages/codemirror/themes/noctisLilac.mjs": [
     "settings"
   ],
   "/packages/codemirror/themes.mjs": [
@@ -61,7 +162,12 @@
     "activateTheme"
   ],
   "/packages/codemirror/slider.mjs": [
-    "acorn parse error: SyntaxError: undefined"
+    "sliderValues",
+    "SliderWidget",
+    "setSliderWidgets",
+    "updateSliderWidgets",
+    "sliderPlugin",
+    "sliderWithID"
   ],
   "/packages/codemirror/widget.mjs": [
     "addWidget",
@@ -78,6 +184,59 @@
     "StrudelMirror"
   ],
   "/packages/codemirror/index.mjs": [],
+  "/packages/core/logger.mjs": [
+    "logKey",
+    "errorLogger",
+    "logger"
+  ],
+  "/packages/core/util.mjs": [
+    "isNoteWithOctave",
+    "isNote",
+    "tokenizeNote",
+    "noteToMidi",
+    "midiToFreq",
+    "freqToMidi",
+    "valueToMidi",
+    "getEventOffsetMs",
+    "_mod",
+    "averageArray",
+    "nanFallback",
+    "getSoundIndex",
+    "getPlayableNoteValue",
+    "getFrequency",
+    "rotate",
+    "pipe",
+    "compose",
+    "flatten",
+    "id",
+    "constant",
+    "listRange",
+    "curry",
+    "parseNumeral",
+    "mapArgs",
+    "numeralArgs",
+    "parseFractional",
+    "fractionalArgs",
+    "splitAt",
+    "zipWith",
+    "pairs",
+    "clamp",
+    "sol2note",
+    "uniq",
+    "uniqsort",
+    "uniqsortr",
+    "unicodeToBase64",
+    "base64ToUnicode",
+    "code2hash",
+    "hash2code",
+    "objectMap",
+    "cycleToSeconds",
+    "ClockCollator",
+    "getPerformanceTimeSeconds",
+    "keyAlias",
+    "getCurrentKeyboardState",
+    "stringifyValues"
+  ],
   "/packages/core/fraction.mjs": [
     "gcd",
     "lcm"
@@ -91,45 +250,6 @@
   "/packages/core/state.mjs": [
     "State"
   ],
-  "/packages/core/logger.mjs": [
-    "logKey",
-    "logger"
-  ],
-  "/packages/core/util.mjs": [
-    "isNoteWithOctave",
-    "isNote",
-    "tokenizeNote",
-    "noteToMidi",
-    "midiToFreq",
-    "freqToMidi",
-    "valueToMidi",
-    "_mod",
-    "nanFallback",
-    "getSoundIndex",
-    "getPlayableNoteValue",
-    "getFrequency",
-    "rotate",
-    "pipe",
-    "compose",
-    "flatten",
-    "constant",
-    "listRange",
-    "curry",
-    "parseNumeral",
-    "mapArgs",
-    "numeralArgs",
-    "parseFractional",
-    "fractionalArgs",
-    "splitAt",
-    "zipWith",
-    "clamp",
-    "sol2note",
-    "unicodeToBase64",
-    "base64ToUnicode",
-    "code2hash",
-    "hash2code",
-    "objectMap"
-  ],
   "/packages/core/value.mjs": [
     "unionWithObj",
     "valued",
@@ -138,10 +258,8 @@
   ],
   "/packages/core/drawLine.mjs": [],
   "/packages/core/pattern.mjs": [
+    "calculateSteps",
     "setStringParser",
-    "polyrhythm",
-    "pr",
-    "pm",
     "nothing",
     "isPattern",
     "reify",
@@ -149,8 +267,12 @@
     "stackRight",
     "stackCentre",
     "stackBy",
-    "fastcat",
+    "bind",
-    "_polymeterListSteps",
+    "innerBind",
+    "outerBind",
+    "squeezeBind",
+    "stepBind",
+    "polyBind",
     "set",
     "keep",
     "keepif",
@@ -174,96 +296,51 @@
     "func",
     "compressSpan",
     "compressspan",
-    "fastgap",
     "focusSpan",
     "focusspan",
-    "density",
-    "sparsity",
     "zoomArc",
     "zoomarc",
-    "inv",
-    "juxby",
-    "echowith",
-    "stutWith",
-    "stutwith",
-    "iterback",
-    "slowchunk",
-    "slowChunk",
-    "chunkback",
-    "fastchunk",
     "bypass",
     "hsla",
     "hsl",
-    "loopat",
+    "_retime",
-    "loopatcps"
+    "_slices",
+    "_fitslice",
+    "_match",
+    "_polymeterListSteps",
+    "shrinklist",
+    "s_cat",
+    "s_alt",
+    "s_polymeter",
+    "s_taper",
+    "s_taperlist",
+    "s_add",
+    "s_sub",
+    "s_expand",
+    "s_extend",
+    "s_contract",
+    "s_tour",
+    "s_zip",
+    "steps",
+    "_morph"
   ],
   "/packages/core/controls.mjs": [
     "createParam",
-    "sound",
+    "isControlName",
-    "src",
+    "registerControl",
-    "att",
-    "fmi",
     "fmrelease",
     "fmvelocity",
     "analyze",
     "fft",
-    "dec",
-    "sus",
-    "rel",
     "hold",
-    "bandf",
+    "duck",
-    "bp",
-    "bandq",
-    "loopb",
-    "loope",
-    "ch",
     "phaserrate",
-    "phasr",
-    "ph",
-    "phs",
-    "phc",
-    "phd",
     "phasdp",
-    "cutoff",
-    "ctf",
-    "lp",
-    "lpe",
-    "hpe",
-    "bpe",
-    "lpa",
-    "hpa",
-    "bpa",
-    "lpd",
-    "hpd",
-    "bpd",
-    "lps",
-    "hps",
-    "bps",
-    "lpr",
-    "hpr",
-    "bpr",
-    "fanchor",
-    "vibrato",
-    "v",
-    "vmod",
-    "hcutoff",
-    "hp",
-    "hresonance",
-    "resonance",
-    "delayfb",
-    "dfb",
-    "delayt",
-    "dt",
-    "lock",
-    "det",
     "fadeTime",
     "fadeOutTime",
     "fadeInTime",
-    "patt",
-    "pdec",
     "psustain",
     "psus",
-    "prel",
     "gate",
     "gat",
     "activeLabel",
@@ -291,26 +368,13 @@
     "offset",
     "octaves",
     "mode",
-    "rlp",
-    "rdim",
-    "rfade",
-    "ir",
-    "size",
-    "sz",
-    "rsize",
-    "dist",
     "compressorKnee",
     "compressorRatio",
     "compressorAttack",
     "compressorRelease",
     "waveloss",
-    "density",
     "expression",
     "sustainpedal",
-    "tremolodepth",
-    "tremdp",
-    "tremolorate",
-    "tremr",
     "fshift",
     "fshiftnote",
     "fshiftphase",
@@ -336,27 +400,15 @@
     "binshift",
     "hbrick",
     "lbrick",
-    "midichan",
-    "control",
-    "ccn",
-    "ccv",
-    "polyTouch",
-    "midibend",
-    "miditouch",
-    "ctlNum",
     "frameRate",
     "frames",
     "hours",
-    "midicmd",
     "minutes",
-    "progNum",
     "seconds",
     "songPtr",
     "uid",
     "val",
     "cps",
-    "legato",
-    "dur",
     "zrand",
     "curve",
     "deltaSlide",
@@ -368,44 +420,40 @@
     "zmod",
     "zcrush",
     "zdelay",
-    "tremolo",
     "zzfx",
-    "colour",
     "createParams",
     "ad",
     "ds",
-    "ar"
+    "ar",
+    "midimap",
+    "ctlNum",
+    "polyTouch",
+    "getControlName"
   ],
   "/packages/core/euclid.mjs": [
     "bjork",
+    "e",
     "euclidrot"
   ],
   "/packages/core/zyklus.mjs": [],
   "/packages/core/signal.mjs": [
-    "steady",
+    "randrun",
-    "signal",
-    "isaw",
-    "isaw2",
-    "saw2",
-    "sine2",
-    "cosine2",
-    "square2",
-    "tri2",
-    "time",
     "_brandBy",
     "_irand",
-    "pickSqueeze",
-    "pickmodSqueeze",
     "__chooseWith",
-    "randcat",
+    "chooseIn",
-    "wrandcat",
+    "chooseOut",
     "perlinWith",
-    "degradeByWith"
+    "berlinWith",
+    "degradeByWith",
+    "_keyDown"
   ],
+  "/packages/core/pick.mjs": [],
   "/packages/core/speak.mjs": [
     "speak"
   ],
   "/packages/core/evaluate.mjs": [
+    "strudelScope",
     "evalScope",
     "evaluate"
   ],
@@ -440,13 +488,18 @@
     "isTauri"
   ],
   "/packages/desktopbridge/midibridge.mjs": [],
-  "/packages/desktopbridge/oscbridge.mjs": [],
+  "/packages/desktopbridge/oscbridge.mjs": [
+    "oscTriggerTauri"
+  ],
   "/packages/desktopbridge/index.mjs": [],
   "/packages/draw/draw.mjs": [
     "getDrawContext",
     "cleanupDraw",
     "Framer",
-    "Drawer"
+    "Drawer",
+    "getComputedPropertyValue",
+    "getTheme",
+    "setTheme"
   ],
   "/packages/draw/animate.mjs": [
     "x",
@@ -467,16 +520,19 @@
     "convertHexToNumber"
   ],
   "/packages/draw/pianoroll.mjs": [
+    "__pianoroll",
     "getDrawOptions",
     "getPunchcardPainter",
     "drawPianoroll"
   ],
   "/packages/draw/spiral.mjs": [],
+  "/packages/draw/pitchwheel.mjs": [],
   "/packages/draw/index.mjs": [],
   "/packages/midi/midi.mjs": [
     "WebMidi",
     "enableWebMidi",
-    "midin"
+    "midicontrolMap",
+    "midisoundMap"
   ],
   "/packages/midi/index.mjs": [],
   "/packages/mini/krill-parser.js": [],
@@ -496,12 +552,11 @@
   "/packages/repl/prebake.mjs": [
     "prebake"
   ],
-  "/packages/repl/repl-component.mjs": [
+  "/packages/repl/repl-component.mjs": [],
-    "acorn parse error: SyntaxError: undefined"
-  ],
   "/packages/repl/index.mjs": [],
   "/packages/soundfonts/gm.mjs": [],
   "/packages/soundfonts/fontloader.mjs": [
+    "setSoundfontUrl",
     "getFontBufferSource",
     "getFontPitch",
     "registerSoundfonts"
@@ -522,6 +577,7 @@
     "vowelFormant"
   ],
   "/packages/superdough/logger.mjs": [
+    "errorLogger",
     "logger",
     "setLogger"
   ],
@@ -534,10 +590,19 @@
     "valueToMidi",
     "nanFallback",
     "_mod",
-    "getSoundIndex"
+    "getSoundIndex",
+    "cycleToSeconds",
+    "secondsToCycle"
+  ],
+  "/packages/superdough/noise.mjs": [
+    "getNoiseBuffer",
+    "getNoiseOscillator",
+    "getNoiseMix"
   ],
   "/packages/superdough/helpers.mjs": [
+    "noises",
     "gainNode",
+    "getWorklet",
     "getParamADSR",
     "getCompressor",
     "getADSRValues",
@@ -550,6 +615,8 @@
   ],
   "/packages/superdough/sampler.mjs": [
     "getCachedBuffer",
+    "getSampleInfo",
+    "getSampleBuffer",
     "getSampleBufferSource",
     "loadBuffer",
     "reverseBuffer",
@@ -559,18 +626,32 @@
     "onTriggerSample"
   ],
   "/packages/superdough/superdough.mjs": [
+    "DEFAULT_MAX_POLYPHONY",
+    "setMaxPolyphony",
+    "setMultiChannelOrbits",
     "soundMap",
     "registerSound",
+    "applyGainCurve",
+    "setGainCurve",
     "getSound",
+    "getAudioDevices",
+    "setDefault",
+    "resetDefaults",
+    "setDefaultValue",
+    "getDefaultValue",
+    "setDefaultValues",
+    "resetDefaultValues",
+    "setVersionDefaults",
     "resetLoadedSounds",
     "setDefaultAudioContext",
     "getAudioContext",
-    "getWorklet",
+    "getAudioContextCurrentTime",
     "initAudio",
     "initAudioOnFirstClick",
     "initializeAudioOutput",
     "connectToDestination",
     "panic",
+    "getLfo",
     "analysers",
     "analysersData",
     "getAnalyserById",
@@ -579,17 +660,13 @@
     "superdough",
     "superdoughTrigger"
   ],
-  "/packages/superdough/noise.mjs": [
-    "getNoiseOscillator",
-    "getNoiseMix"
-  ],
   "/packages/superdough/synth.mjs": [
     "registerSynthSounds",
     "waveformN",
     "getOscillator"
   ],
   "/packages/superdough/zzfx_fork.mjs": [
-    "acorn parse error: SyntaxError: undefined"
+    "buildSamples"
   ],
   "/packages/superdough/zzfx.mjs": [
     "getZZFX",
@@ -640,6 +717,7 @@
   ],
   "/packages/transpiler/transpiler.mjs": [
     "registerWidgetType",
+    "registerLanguage",
     "transpiler",
     "getWidgetID"
   ],
@@ -654,6 +732,7 @@
     "drawTimeScope",
     "drawFrequencyScope"
   ],
+  "/packages/webaudio/spectrum.mjs": [],
   "/packages/webaudio/index.mjs": [],
   "/packages/xen/xen.mjs": [
     "edo",