@ogabrielluiz/patchflow 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 ogabrielluiz
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,119 @@
+# patchflow
+
+Eurorack patch diagram renderer. Patchbook-compatible notation to skeuomorphic SVG block diagrams.
+
+## Examples
+
+The diagrams below are regenerated on every push to `main` — they reflect the current output of the library.
+
+### Bouncing ball (self-patching feedback)
+
+```
+MATHS:
+* CH 1: Cycle ON
+* CH 2: Attenuverter ~2 o'clock
+
+- MATHS.CH 1 (OUT) >> MATHS.CH 2 (In)
+- MATHS.CH 2 (Out) >> MATHS.CH 1 (Fall CV) // shortens fall each cycle
+```
+
+<picture>
+  <source media="(prefers-color-scheme: dark)" srcset="./samples/bouncing-ball-dark.svg">
+  <img alt="Bouncing ball diagram" src="./samples/bouncing-ball-light.svg">
+</picture>
+
+### Quadrature LFOs (multi-module with feedback)
+
+```
+MATHS:
+* CH 1: Cycle OFF, Rise + Fall matched
+* CH 4: Cycle OFF, Rise + Fall matched
+
+- MATHS.CH 1 (EOR) g> MATHS.CH 4 (Trig)
+- MATHS.CH 4 (EOC) g> MATHS.CH 1 (Trig)
+- MATHS.CH 1 (OUT) >> Filter (Cutoff)
+- MATHS.CH 4 (OUT) >> VCA (CV)
+```
+
+<picture>
+  <source media="(prefers-color-scheme: dark)" srcset="./samples/quadrature-lfos-dark.svg">
+  <img alt="Quadrature LFOs diagram" src="./samples/quadrature-lfos-light.svg">
+</picture>
+
+### Simple chain
+
+```
+- Oscillator (Out) -> Filter (In)
+- Envelope (Out) >> Filter (Cutoff)
+- Filter (Out) -> VCA (In)
+- LFO (Out) >> VCA (CV)
+```
+
+<picture>
+  <source media="(prefers-color-scheme: dark)" srcset="./samples/simple-chain-dark.svg">
+  <img alt="Simple chain diagram" src="./samples/simple-chain-light.svg">
+</picture>
+
+### Multi-voice patch
+
+```
+VOICE 1:
+- Osc1 (Out) -> Mixer (In1)
+- Env1 (Out) >> VCA1 (CV)
+
+VOICE 2:
+- Osc2 (Out) -> Mixer (In2)
+- Env2 (Out) >> VCA2 (CV)
+
+- Mixer (Out) -> Filter (In)
+- Filter (Out) -> Output (In)
+```
+
+<picture>
+  <source media="(prefers-color-scheme: dark)" srcset="./samples/multi-voice-dark.svg">
+  <img alt="Multi-voice diagram" src="./samples/multi-voice-light.svg">
+</picture>
+
+## Install
+
+```bash
+npm install @ogabrielluiz/patchflow
+```
+
+## Usage
+
+```ts
+import { render } from '@ogabrielluiz/patchflow';
+
+const svg = render(`
+MATHS:
+* CH 1: Cycle ON
+* CH 2: Attenuverter ~2 o'clock
+
+- MATHS.CH 1 (OUT) >> MATHS.CH 2 (In)
+- MATHS.CH 2 (Out) >> MATHS.CH 1 (Fall CV) // shortens fall each cycle
+`);
+```
+
+## Signal Operators
+
+| Operator | Signal Type |
+|----------|-------------|
+| `->` | Audio |
+| `>>` | CV |
+| `p>` | Pitch / 1V/oct |
+| `g>` | Gate |
+| `t>` | Trigger |
+| `c>` | Clock |
+
+## API
+
+- `render(notation, options?)` — notation to SVG string
+- `parse(notation)` — notation to PatchGraph
+- `layout(graph, options?)` — PatchGraph to LayoutResult
+- `renderSvg(layoutResult, theme)` — LayoutResult + Theme to SVG
+- `createTheme(overrides)` — factory with deep partial merge
+
+## License
+
+MIT

package/dist/chunk-B7DUSPQH.js

@@ -0,0 +1,42 @@
+var __create = Object.create;
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __getProtoOf = Object.getPrototypeOf;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __commonJS = (cb, mod) => function __require() {
+  return mod || (0, cb[__getOwnPropNames(cb)[0]])((mod = { exports: {} }).exports, mod), mod.exports;
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
+  // If the importer is in node compatibility mode or this is not an ESM
+  // file that has been converted to a CommonJS file using a Babel-
+  // compatible transform (i.e. "__esModule" has not been set), then set
+  // "default" to the CommonJS "module.exports" for node compatibility.
+  isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
+  mod
+));
+
+// src/types.ts
+var SIGNAL_OPERATORS = {
+  "->": "audio",
+  ">>": "cv",
+  "p>": "pitch",
+  "g>": "gate",
+  "t>": "trigger",
+  "c>": "clock"
+};
+
+export {
+  __commonJS,
+  __toESM,
+  SIGNAL_OPERATORS
+};
+//# sourceMappingURL=chunk-B7DUSPQH.js.map

package/dist/chunk-B7DUSPQH.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/types.ts"],"sourcesContent":["// ── Signal Types ──\n\nexport type SignalType = 'audio' | 'cv' | 'pitch' | 'gate' | 'trigger' | 'clock';\n\nexport const SIGNAL_OPERATORS: Record<string, SignalType> = {\n  '->': 'audio',\n  '>>': 'cv',\n  'p>': 'pitch',\n  'g>': 'gate',\n  't>': 'trigger',\n  'c>': 'clock',\n};\n\n// ── Graph Primitives ──\n\nexport interface Port {\n  id: string;          // normalized key (lowercase, trimmed)\n  display: string;     // original form for rendering\n  direction: 'in' | 'out';\n}\n\nexport interface Param {\n  key: string;\n  value: string;\n}\n\nexport interface Block {\n  id: string;\n  label: string;\n  subLabel: string | null;\n  params: Param[];\n  ports: Port[];\n  parentModule: string | null;  // null for top-level modules, module name for sections\n  voice: string | null;\n}\n\nexport interface ConnectionEndpoint {\n  blockId: string;\n  portId: string;       // normalized key\n  portDisplay: string;  // original form\n}\n\nexport interface Connection {\n  id: string;\n  source: ConnectionEndpoint;\n  target: ConnectionEndpoint;\n  signalType: SignalType;\n  annotation: string | null;\n  graphvizExtras: Record<string, string> | null;\n}\n\n// ── Patch Graph (Parser Output) ──\n\nexport interface PatchGraph {\n  declaredBlocks: Block[];\n  stubBlocks: Block[];\n  connections: Connection[];\n  feedbackEdges: Connection[];\n  signalTypeStats: Partial<Record<SignalType, number>>;\n  voices: string[];\n}\n\n// ── Layout Types ──\n\nexport interface Point {\n  x: number;\n  y: number;\n}\n\nexport interface LayoutPort extends Port {\n  position: Point;\n  signalType: SignalType | null;\n}\n\nexport interface LayoutBlock {\n  id: string;\n  label: string;\n  subLabel: string | null;\n  params: Param[];\n  ports: LayoutPort[];\n  parentModule: string | null;\n  x: number;\n  y: number;\n  width: number;\n  height: number;\n}\n\nexport interface LayoutConnection {\n  id: string;\n  source: ConnectionEndpoint;\n  target: ConnectionEndpoint;\n  signalType: SignalType;\n  annotation: string | null;\n  path: string;            // SVG path d attribute\n  isFeedback: boolean;\n  sourcePoint: Point;\n  targetPoint: Point;\n}\n\nexport interface LayoutResult {\n  blocks: LayoutBlock[];\n  connections: LayoutConnection[];\n  width: number;\n  height: number;\n  signalTypeStats: Partial<Record<SignalType, number>>;\n}\n\n// ── Theme Types ──\n\nexport interface CableColor {\n  stroke: string;\n  plugTip: string;\n}\n\nexport interface SocketColors {\n  bezel: string;\n  bezelStroke: string;\n  ring: string;\n  hole: string;\n  pin: string;\n}\n\nexport interface Theme {\n  background: string;\n  panel: {\n    fill: string;\n    stroke: string;\n    highlight: string;\n    shadow: string;\n    cornerRadius: number;\n    shadowBlur: number;\n    shadowOpacity: number;\n    bevelWidth: number;\n  };\n  label: {\n    fontFamily: string;\n    color: string;\n    subColor: string;\n    plateFill: string;\n    plateStroke: string;\n  };\n  param: {\n    plateFill: string;\n    plateStroke: string;\n    textColor: string;\n  };\n  port: {\n    fontFamily: string;\n    fontSize: number;\n    colors: SocketColors;\n    hideSocket: boolean;\n    labelColor: string;\n    pill: {\n      show: boolean;\n      fontSize: number;\n      textColor: string;\n      cornerRadius: number;\n    };\n  };\n  cable: {\n    width: number;\n    colors: Record<SignalType, CableColor>;\n    plugTipRadius: number;\n  };\n  annotation: {\n    fontFamily: string;\n    fontSize: number;\n    color: string;\n    haloColor: string;\n  };\n  grid: {\n    dotColor: string;\n    dotRadius: number;\n    spacing: number;\n    opacity: number;\n  } | null;\n}\n\n// ── Options ──\n\nexport interface RenderOptions {\n  theme?: DeepPartial<Theme>;\n  maxWidth?: number;\n  padding?: number;\n  legend?: boolean | 'auto';\n}\n\nexport interface LayoutOptions {\n  direction?: 'LR' | 'TB';\n  nodeSep?: number;\n  rankSep?: number;\n  feedbackSide?: 'top' | 'bottom';\n}\n\n// ── Parse Result ──\n\nexport type ErrorCode =\n  | 'SYNTAX_ERROR'\n  | 'UNKNOWN_OPERATOR'\n  | 'MISSING_PORT'\n  | 'UNCLOSED_PAREN'\n  | 'DUPLICATE_MODULE'\n  | 'UNKNOWN_MODULE'\n  | 'INVALID_PORT';\n\nexport type ErrorSeverity = 'error' | 'warning';\n\nexport interface ParseDiagnostic {\n  code: ErrorCode;\n  message: string;\n  line: number;\n  column: number;\n  length: number;\n  severity: ErrorSeverity;\n}\n\nexport interface ParseResult {\n  graph: PatchGraph;\n  errors: ParseDiagnostic[];\n  warnings: ParseDiagnostic[];\n}\n\n// ── Utility Types ──\n\nexport type DeepPartial<T> = {\n  [P in keyof T]?: T[P] extends object ? DeepPartial<T[P]> : T[P];\n};\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;AAIO,IAAM,mBAA+C;AAAA,EAC1D,MAAM;AAAA,EACN,MAAM;AAAA,EACN,MAAM;AAAA,EACN,MAAM;AAAA,EACN,MAAM;AAAA,EACN,MAAM;AACR;","names":[]}