@graphlearning/graphl-flow 0.3.0 → 0.5.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -69,8 +69,11 @@ column), not below it — an edge is routed in the gap between two siblings, nev
69
69
 
70
70
  **Code.** `code` takes the source as a (template-literal) string; its common indent is dropped.
71
71
  `lang` is `python | sql | scala | java | js | ts | shell | text` — one small highlighter with seven
72
- token colours per theme. `show` keeps only those line ranges and folds each skipped run into
73
- `··· N lines`; `show` and `highlight` use the FILE's line numbers, and so do edges: `src.L17`.
72
+ token colours per theme, sharing one keyword set (Java's primitive types, `record`, `sealed` and
73
+ `switch` included); an `@Name` — a Java annotation, a Python decorator — draws as a keyword, and a
74
+ number keeps its separators and suffix (`1_000_000L`). `show` keeps only those line ranges and folds
75
+ each skipped run into `··· N lines`; `show` and `highlight` use the FILE's line numbers, and so do
76
+ edges: `src.L17`.
74
77
  `terminal: true` draws a terminal — `$ ` lines are commands, `! ` lines errors, the rest output.
75
78
 
76
79
  **IDE frames.** Three columns: `tree` | (editor `code` over terminal `code`, in a `bare` group) |
@@ -78,6 +81,13 @@ a SIDE PANE — a `bare` group with a fixed width `w`. The IDE alone is narrower
78
81
  pane fills the frame and holds whatever the moment needs (a `note`, a `compact` plot, a small memory
79
82
  diagram) or nothing. See `dev/fixtures/studies/ide-frame.ts`.
80
83
 
84
+ **Notebook frames.** The same three columns with a notebook in the middle: `tree` | a group (the
85
+ notebook: `title: 'explore.ipynb'`, `icon: 'jupyter'`) of CELLS | the fixed side pane. A cell is a
86
+ `group` with `cell: n`, the execution count drawn as `[n]` in a gutter (`cell: true` draws `[ ]`, not
87
+ run yet). Its first child is the input `code` (drawn without a tab bar, stretched to the cell),
88
+ followed by its outputs: `{ type: 'code', output: true }` for printed text (`! ` lines are errors), a
89
+ `table` for a DataFrame, or a `plot`. See `dev/fixtures/studies/notebook-frame.ts`.
90
+
81
91
  `minW`/`minH` are FLOORS and `maxW`/`maxH` CAPS, in the scene's own pixels; `w`/`h` set both. Give
82
92
  every frame of a video the same floors and a fixed side pane, and they get the same zoom: no pane
83
93
  moves between cuts, whatever the side pane holds. Prose wraps to the pane; tables and code do not,
@@ -120,9 +130,9 @@ writes `captures/<id>-<theme>.png`.
120
130
  | Type | Fields |
121
131
  |---------|--------|
122
132
  | `item` | `id`, `title`, `sub?`, `icon?`, `bullets?`, `stack?`, `chip?`, `tone?`, `span?` |
123
- | `group` | `id`, `children`, `title?`, `sub?`, `icon?`, `badge?`, `dir?: 'row' \| 'col' \| 'grid'`, `cols?`, `bare?`, `spread?`, `tone?`, `span?` |
133
+ | `group` | `id`, `children`, `title?`, `sub?`, `icon?`, `badge?`, `dir?: 'row' \| 'col' \| 'grid'`, `cols?`, `bare?`, `spread?`, `cell?: number \| true`, `tone?`, `span?` |
124
134
  | `table` | `id`, `rows`, `columns?`, `title?`, `tone?`, `span?` — a row is `[cells…]` or `{ cells, id?, tag?, tone? }` |
125
- | `code` | `id`, `code`, `lang?`, `filename?`, `show?: [from, to][]`, `highlight?: number[]`, `terminal?`, `tone?`, `span?` |
135
+ | `code` | `id`, `code`, `lang?`, `filename?`, `show?: [from, to][]`, `highlight?: number[]`, `terminal?`, `output?`, `tone?`, `span?` |
126
136
  | `plot` | `id`, `x`, `y` (axes: `min`, `max`, `step?`, `label?`, or `labels` for categories), `series`, `title?`, `axes?`, `grid?` |
127
137
  | `tree` | `id`, `entries` (`name`, `children?`, `folder?`, `state?: active \| new \| muted`, `note?`, `icon?`), `title?` |
128
138
  | `note` | `id`, `text`, `tone?` — a dashed callout of wrapping prose |
@@ -153,7 +163,7 @@ The theme (`dark` | `light`) picks the shade; repos cannot recolour.
153
163
  | generic (lucide) | the tone accent | `activity admin bell box branch building card chart check clock cloud code cpu database disk factory file filter fingerprint folder globe key layers lock network package pie screen search server settings shield stream table terminal user users workflow zap` |
154
164
  | Azure | its own colours | `adls aks analysisservices azuresql cosmos databricks datafactory defender devops eventhubs functions keyvault loganalytics monitor powerbi purview servicebus storage streamanalytics synapse vm` |
155
165
  | AWS | its own tile | `apigateway athena aurora cloudformation cloudwatch dms dynamodb ec2 eks elasticache emr eventbridge firehose glue iam kinesis kms lakeformation lambda msk mwaa rds redshift s3 sagemaker secretsmanager sns sqs stepfunctions vpc` |
156
- | brand | its own colour (ink if it would vanish) | `airflow docker duckdb flink git github githubactions grafana jupyter kafka kubernetes mongodb pandas postgresql prometheus python snowflakedb spark terraform` |
166
+ | brand | its own colour (ink if it would vanish) | `airflow docker duckdb flink git github githubactions grafana java junit jupyter kafka kubernetes maven mongodb pandas postgresql prometheus python snowflakedb spark terraform` |
157
167
 
158
168
  **`chip: true`** draws an item as a small framed pill — a thing counted, not described (`Task 1`,
159
169
  `Local disk`); chips fill their grid cell, so a row of them lines up.