Module Catalog

The module catalog provides a searchable registry of all available modules with metadata for building dynamic UIs.

Browsing Modules

Get All Modules

const catalog = engine.catalog();

// Returns array of CatalogEntry:
// {
//   type_id: "Vco",
//   name: "VCO",
//   category: "oscillator",
//   description: "Voltage-controlled oscillator with multiple waveforms",
//   keywords: ["oscillator", "vco", "saw", "square", "triangle"],
//   inputs: [{ id: 0, name: "v_oct", kind: "VoltPerOctave" }, ...],
//   outputs: [{ id: 0, name: "out", kind: "Audio" }],
//   params: [{ id: "0", name: "frequency", ... }]
// }

Filter by Category

const oscillators = engine.by_category('oscillator');
const filters = engine.by_category('filter');
const utilities = engine.by_category('utility');

Categories

Searching Modules

Full-text search with relevance scoring:

const results = engine.search('filter');

// Returns matches sorted by relevance:
// [
//   { entry: {...}, score: 100 },  // Exact type_id match
//   { entry: {...}, score: 80 },   // Name contains "filter"
//   { entry: {...}, score: 50 },   // Keyword match
// ]

Search Matching

Module Metadata

Each catalog entry provides rich metadata for UI generation:

Port Information

const entry = catalog.find(m => m.type_id === 'SvfFilter');

// Input ports
entry.inputs.forEach(port => {
  console.log(port.id, port.name, port.kind);
  // 0, "input", "Audio"
  // 1, "cutoff", "CvBipolar"
  // 2, "resonance", "CvUnipolar"
});

// Output ports
entry.outputs.forEach(port => {
  console.log(port.id, port.name, port.kind);
  // 0, "lowpass", "Audio"
  // 1, "highpass", "Audio"
  // 2, "bandpass", "Audio"
});

Parameter Information

entry.params.forEach(param => {
  console.log(param);
  // {
  //   id: "0",
  //   name: "cutoff",
  //   min: 20.0,
  //   max: 20000.0,
  //   default: 1000.0,
  //   curve: "exponential",
  //   control_type: "knob",
  //   format: { type: "frequency" }
  // }
});

Building a Module Browser UI

function ModuleBrowser({ engine, onSelect }) {
  const [query, setQuery] = useState('');
  const [category, setCategory] = useState(null);

  const modules = useMemo(() => {
    if (query) {
      return engine.search(query).map(r => r.entry);
    }
    if (category) {
      return engine.by_category(category);
    }
    return engine.catalog();
  }, [query, category]);

  return (
    <div>
      <input
        value={query}
        onChange={e => setQuery(e.target.value)}
        placeholder="Search modules..."
      />

      <select onChange={e => setCategory(e.target.value || null)}>
        <option value="">All Categories</option>
        <option value="oscillator">Oscillators</option>
        <option value="filter">Filters</option>
        <option value="envelope">Envelopes</option>
        {/* ... */}
      </select>

      <ul>
        {modules.map(m => (
          <li key={m.type_id} onClick={() => onSelect(m.type_id)}>
            <strong>{m.name}</strong>
            <span>{m.category}</span>
            <p>{m.description}</p>
          </li>
        ))}
      </ul>
    </div>
  );
}

Signal Type Colors

For cable visualization, use the standard signal colors:

const colors = engine.signal_colors();
// {
//   audio: "#ff6b6b",      // Red
//   cv_bipolar: "#4ecdc4", // Cyan
//   cv_unipolar: "#95e879",// Green
//   volt_per_octave: "#ffd93d", // Yellow
//   gate: "#c44dff",       // Purple
//   trigger: "#ff6bcb",    // Magenta
//   clock: "#ffa94d"       // Orange
// }

Port Compatibility

Check if two ports can be connected:

const compat = engine.check_compatibility(
  'vco', 0,    // source: VCO output 0
  'vcf', 0     // dest: VCF input 0
);

// Returns: "exact" | "allowed" | "warning" | "incompatible"