Repository navigation
Expand file tree
/
Copy pathdocs.html
More file actions
1224 lines (1034 loc) · 64.4 KB
/
Copy pathdocs.html
File metadata and controls
1224 lines (1034 loc) · 64.4 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Documentation — Mango</title>
<meta name="description" content="Developer documentation for Mango, a native MongoDB GUI built with Perry. Learn the architecture, extend the app, and contribute.">
<link rel="icon" type="image/png" href="/favicon.png">
<link rel="preconnect" href="https://fonts.googleapis.com">
<link rel="preconnect" href="https://fonts.gstatic.com" crossorigin>
<link href="https://fonts.googleapis.com/css2?family=Rubik:wght@400;500;600;700&family=JetBrains+Mono:wght@400;500&display=swap" rel="stylesheet">
<style>
*, *::before, *::after { box-sizing: border-box; margin: 0; padding: 0; }
:root {
--orange: #FF9F1C;
--yellow: #FFBF69;
--red: #E8572A;
--green: #2EC4B6;
--charcoal: #2B2D42;
--cream: #FFF8F0;
--slate: #8D99AE;
--surface: #FFFFFF;
--border: #E8E9ED;
--sidebar-w: 260px;
}
html { scroll-behavior: smooth; }
body {
font-family: 'Rubik', -apple-system, BlinkMacSystemFont, 'Segoe UI', sans-serif;
color: var(--charcoal);
background: var(--cream);
line-height: 1.7;
-webkit-font-smoothing: antialiased;
}
/* --- NAV --- */
nav {
position: fixed;
top: 0;
left: 0;
right: 0;
z-index: 100;
background: rgba(255, 248, 240, 0.85);
backdrop-filter: blur(12px);
-webkit-backdrop-filter: blur(12px);
border-bottom: 1px solid var(--border);
padding: 0 2rem;
height: 64px;
display: flex;
align-items: center;
justify-content: space-between;
}
nav .logo { height: 36px; }
nav .links { display: flex; gap: 2rem; align-items: center; }
nav .links a {
text-decoration: none;
color: var(--charcoal);
font-size: 0.95rem;
font-weight: 500;
opacity: 0.7;
transition: opacity 0.2s;
}
nav .links a:hover { opacity: 1; }
nav .links a.active { opacity: 1; }
nav .links a.btn-primary { color: #fff; opacity: 1; }
.btn {
display: inline-flex;
align-items: center;
gap: 0.5rem;
padding: 0.6rem 1.4rem;
border-radius: 8px;
font-family: inherit;
font-size: 0.95rem;
font-weight: 600;
text-decoration: none;
border: none;
cursor: pointer;
transition: transform 0.15s, box-shadow 0.15s;
}
.btn:hover { transform: translateY(-1px); box-shadow: 0 4px 12px rgba(0,0,0,0.1); }
.btn-primary { background: var(--charcoal); color: #fff; }
/* --- LAYOUT --- */
.docs-layout {
display: flex;
margin-top: 64px;
min-height: calc(100vh - 64px);
}
/* --- SIDEBAR --- */
.sidebar {
position: fixed;
top: 64px;
left: 0;
bottom: 0;
width: var(--sidebar-w);
overflow-y: auto;
padding: 2rem 1.5rem;
border-right: 1px solid var(--border);
background: var(--cream);
scrollbar-width: thin;
}
.sidebar::-webkit-scrollbar { width: 4px; }
.sidebar::-webkit-scrollbar-thumb { background: var(--border); border-radius: 4px; }
.sidebar-group { margin-bottom: 1.75rem; }
.sidebar-group-title {
font-size: 0.7rem;
font-weight: 700;
text-transform: uppercase;
letter-spacing: 0.08em;
color: var(--slate);
margin-bottom: 0.5rem;
padding-left: 0.75rem;
}
.sidebar a {
display: block;
padding: 0.35rem 0.75rem;
font-size: 0.88rem;
font-weight: 450;
color: var(--charcoal);
text-decoration: none;
border-radius: 6px;
opacity: 0.65;
transition: opacity 0.15s, background 0.15s;
}
.sidebar a:hover { opacity: 1; background: rgba(0,0,0,0.03); }
.sidebar a.active { opacity: 1; background: rgba(255, 159, 28, 0.1); color: var(--charcoal); font-weight: 600; }
/* --- MAIN CONTENT --- */
.docs-content {
margin-left: var(--sidebar-w);
flex: 1;
max-width: 820px;
padding: 3rem 3rem 6rem;
}
.docs-content h1 {
font-size: 2.2rem;
font-weight: 700;
margin-bottom: 0.5rem;
line-height: 1.2;
}
.docs-content .lead {
font-size: 1.15rem;
color: var(--slate);
margin-bottom: 3rem;
}
.docs-content h2 {
font-size: 1.55rem;
font-weight: 700;
margin-top: 3.5rem;
margin-bottom: 1rem;
padding-top: 1.5rem;
border-top: 1px solid var(--border);
}
.docs-content h2:first-of-type {
margin-top: 0;
border-top: none;
padding-top: 0;
}
.docs-content h3 {
font-size: 1.15rem;
font-weight: 600;
margin-top: 2rem;
margin-bottom: 0.75rem;
}
.docs-content h4 {
font-size: 1rem;
font-weight: 600;
margin-top: 1.5rem;
margin-bottom: 0.5rem;
}
.docs-content p {
margin-bottom: 1rem;
}
.docs-content ul, .docs-content ol {
margin-bottom: 1rem;
padding-left: 1.5rem;
}
.docs-content li {
margin-bottom: 0.35rem;
}
.docs-content a {
color: var(--orange);
text-decoration: none;
font-weight: 500;
}
.docs-content a:hover { text-decoration: underline; }
.docs-content code {
font-family: 'JetBrains Mono', ui-monospace, 'SF Mono', 'Cascadia Code', monospace;
font-size: 0.85em;
background: rgba(43, 45, 66, 0.06);
padding: 0.15em 0.4em;
border-radius: 4px;
}
.docs-content pre {
background: var(--charcoal);
color: #E8E9ED;
border-radius: 10px;
padding: 1.25rem 1.5rem;
overflow-x: auto;
margin-bottom: 1.25rem;
line-height: 1.55;
}
.docs-content pre code {
background: none;
padding: 0;
font-size: 0.85rem;
color: inherit;
}
.docs-content .token-kw { color: #c792ea; }
.docs-content .token-str { color: #c3e88d; }
.docs-content .token-cm { color: #6a7b8b; }
.docs-content .token-fn { color: #82aaff; }
.docs-content .token-type { color: #ffcb6b; }
.docs-content .token-num { color: #f78c6c; }
.docs-content table {
width: 100%;
border-collapse: collapse;
margin-bottom: 1.25rem;
font-size: 0.92rem;
}
.docs-content th, .docs-content td {
text-align: left;
padding: 0.6rem 1rem;
border-bottom: 1px solid var(--border);
}
.docs-content th {
font-weight: 600;
background: rgba(43, 45, 66, 0.03);
font-size: 0.8rem;
text-transform: uppercase;
letter-spacing: 0.04em;
color: var(--slate);
}
.callout {
border-left: 3px solid var(--orange);
background: rgba(255, 159, 28, 0.06);
padding: 1rem 1.25rem;
border-radius: 0 8px 8px 0;
margin-bottom: 1.25rem;
font-size: 0.95rem;
}
.callout-green {
border-left-color: var(--green);
background: rgba(46, 196, 182, 0.06);
}
.callout strong { font-weight: 600; }
.file-tree {
background: var(--surface);
border: 1px solid var(--border);
border-radius: 10px;
padding: 1.25rem 1.5rem;
margin-bottom: 1.25rem;
font-family: 'JetBrains Mono', monospace;
font-size: 0.85rem;
line-height: 1.7;
}
.file-tree .dir { color: var(--orange); font-weight: 500; }
.file-tree .file { color: var(--charcoal); }
.file-tree .desc { color: var(--slate); font-family: 'Rubik', sans-serif; font-size: 0.82rem; }
/* --- MOBILE SIDEBAR --- */
.sidebar-toggle {
display: none;
position: fixed;
bottom: 1.5rem;
right: 1.5rem;
z-index: 200;
width: 48px;
height: 48px;
border-radius: 50%;
background: var(--charcoal);
color: #fff;
border: none;
cursor: pointer;
box-shadow: 0 4px 16px rgba(0,0,0,0.2);
font-size: 1.2rem;
align-items: center;
justify-content: center;
}
@media (max-width: 900px) {
.sidebar {
transform: translateX(-100%);
transition: transform 0.25s ease;
z-index: 150;
box-shadow: 4px 0 16px rgba(0,0,0,0.08);
}
.sidebar.open { transform: translateX(0); }
.docs-content { margin-left: 0; padding: 2rem 1.5rem 4rem; }
.sidebar-toggle { display: flex; }
nav .links a.hide-mobile { display: none; }
}
</style>
</head>
<body>
<nav>
<a href="/"><img src="/logo.svg" alt="Mango" class="logo"></a>
<div class="links">
<a href="/#features" class="hide-mobile">Features</a>
<a href="/#platforms" class="hide-mobile">Platforms</a>
<a href="/docs.html" class="active">Docs</a>
<a href="https://github.com/MangoQuery/app" target="_blank" rel="noopener">GitHub</a>
<a href="/downloads/Mango.dmg" class="btn btn-primary" download>Download</a>
</div>
</nav>
<button class="sidebar-toggle" id="sidebarToggle" aria-label="Toggle docs navigation">
<svg width="20" height="20" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round"><line x1="3" y1="6" x2="21" y2="6"/><line x1="3" y1="12" x2="21" y2="12"/><line x1="3" y1="18" x2="21" y2="18"/></svg>
</button>
<div class="docs-layout">
<aside class="sidebar" id="sidebar">
<div class="sidebar-group">
<div class="sidebar-group-title">Getting Started</div>
<a href="#overview">Overview</a>
<a href="#architecture">Architecture</a>
<a href="#project-structure">Project Structure</a>
<a href="#building">Building & Running</a>
</div>
<div class="sidebar-group">
<div class="sidebar-group-title">Perry Framework</div>
<a href="#perry-overview">What is Perry?</a>
<a href="#perry-ui">UI Widgets</a>
<a href="#perry-styling">Styling & Layout</a>
<a href="#perry-platform">Platform Detection</a>
<a href="#perry-system">System APIs</a>
</div>
<div class="sidebar-group">
<div class="sidebar-group-title">UI Layer</div>
<a href="#app-ts">app.ts — The Main File</a>
<a href="#screens">Screens & Navigation</a>
<a href="#state-management">State Management</a>
<a href="#theming">Theme System</a>
</div>
<div class="sidebar-group">
<div class="sidebar-group-title">Data Layer</div>
<a href="#connection-store">ConnectionStore</a>
<a href="#mongo-client">MongoClient</a>
<a href="#preferences">PreferencesStore</a>
<a href="#web-client">Web Mode & WebSocket</a>
<a href="#telemetry">Telemetry</a>
</div>
<div class="sidebar-group">
<div class="sidebar-group-title">Extending Mango</div>
<a href="#adding-features">Adding Features</a>
<a href="#adding-screens">Adding Screens</a>
<a href="#new-data-ops">New Database Operations</a>
<a href="#custom-themes">Custom Themes</a>
<a href="#testing">Testing</a>
</div>
</aside>
<main class="docs-content">
<h1>Mango Developer Documentation</h1>
<p class="lead">Everything you need to understand, extend, and contribute to Mango — a native MongoDB GUI compiled from TypeScript to native code with Perry.</p>
<!-- ========== OVERVIEW ========== -->
<h2 id="overview">Overview</h2>
<p>Mango is a cross-platform MongoDB GUI that compiles TypeScript directly to native machine code. There is no Electron, no JVM, and no web view at runtime. The result is a ~7 MB binary that starts in under a second and uses less than 100 MB of RAM.</p>
<p>The key technologies behind Mango:</p>
<ul>
<li><strong>Perry</strong> — a TypeScript-to-native compiler that uses SWC for parsing and Cranelift for code generation</li>
<li><strong>TypeScript</strong> — the entire codebase is standard TypeScript (ES2022 target)</li>
<li><strong>MongoDB Driver</strong> — the official <code>mongodb</code> npm package (v7.1.0) for database connectivity</li>
<li><strong>SQLite</strong> — local storage for connection profiles and user preferences via <code>better-sqlite3</code></li>
<li><strong>Native UI</strong> — Perry compiles to AppKit (macOS), UIKit (iOS), Android Views, GTK4 (Linux), Win32 (Windows)</li>
</ul>
<!-- ========== ARCHITECTURE ========== -->
<h2 id="architecture">Architecture</h2>
<p>Mango follows a simple layered architecture with three distinct concerns:</p>
<pre><code><span class="token-cm">┌─────────────────────────────────────────────┐</span>
<span class="token-cm">│</span> <span class="token-type">UI Layer</span> <span class="token-cm">src/app.ts</span> <span class="token-cm">│</span>
<span class="token-cm">│</span> Perry widgets, screens, navigation, state <span class="token-cm">│</span>
<span class="token-cm">├─────────────────────────────────────────────┤</span>
<span class="token-cm">│</span> <span class="token-type">Theme Layer</span> <span class="token-cm">src/theme/</span> <span class="token-cm">│</span>
<span class="token-cm">│</span> Colors (light/dark), typography, spacing <span class="token-cm">│</span>
<span class="token-cm">├─────────────────────────────────────────────┤</span>
<span class="token-cm">│</span> <span class="token-type">Data Layer</span> <span class="token-cm">src/data/</span> <span class="token-cm">│</span>
<span class="token-cm">│</span> ConnectionStore, MongoClient, Preferences <span class="token-cm">│</span>
<span class="token-cm">├─────────────────────────────────────────────┤</span>
<span class="token-cm">│</span> <span class="token-type">Perry Runtime</span> <span class="token-cm">perry/ui, perry/system</span> <span class="token-cm">│</span>
<span class="token-cm">│</span> Native widgets, keychain, platform APIs <span class="token-cm">│</span>
<span class="token-cm">└─────────────────────────────────────────────┘</span></code></pre>
<p>On native platforms (macOS, iOS, Android, Linux, Windows), the app talks directly to MongoDB via the driver. On the web, a Fastify server proxies MongoDB operations over WebSocket:</p>
<pre><code><span class="token-cm">// Native platforms</span>
<span class="token-type">App.ts</span> → <span class="token-fn">MongoClient</span> → mongodb driver → TCP → MongoDB
<span class="token-cm">// Web platform</span>
<span class="token-type">Browser</span> → WebSocket → <span class="token-fn">Fastify</span> (serve.ts) → MongoClient → MongoDB</code></pre>
<!-- ========== PROJECT STRUCTURE ========== -->
<h2 id="project-structure">Project Structure</h2>
<div class="file-tree">
<span class="dir">src/</span><br>
<span class="file">app.ts</span> <span class="desc">— Main UI: all screens, navigation, state (1770 lines)</span><br>
<span class="file">serve.ts</span> <span class="desc">— Fastify web server + WebSocket proxy</span><br>
<span class="dir">data/</span><br>
<span class="file">connection-store.ts</span> <span class="desc">— SQLite CRUD for connection profiles</span><br>
<span class="file">mongo-client.ts</span> <span class="desc">— MongoDB driver wrapper</span><br>
<span class="file">web-mongo-client.ts</span> <span class="desc">— WebSocket client for web mode</span><br>
<span class="file">preferences.ts</span> <span class="desc">— User preferences with SQLite + in-memory cache</span><br>
<span class="file">database.ts</span> <span class="desc">— SQLite singleton factory</span><br>
<span class="file">telemetry.ts</span> <span class="desc">— Optional analytics events</span><br>
<span class="dir">theme/</span><br>
<span class="file">colors.ts</span> <span class="desc">— Light & dark theme color definitions</span><br>
<span class="file">typography.ts</span> <span class="desc">— Platform-specific font families & sizes</span><br>
<span class="dir">tests/</span><br>
<span class="file">preload.ts</span> <span class="desc">— Bun test mocks for Perry and MongoDB</span><br>
<span class="file">connection-store.test.ts</span><br>
<span class="file">mongo-client.test.ts</span><br>
<span class="file">preferences.test.ts</span><br>
<span class="file">perry.toml</span> <span class="desc">— Perry build config: targets, icons, entitlements</span><br>
<span class="file">package.json</span> <span class="desc">— Dependencies and scripts</span><br>
<span class="file">tsconfig.json</span> <span class="desc">— TypeScript config (ES2022, strict)</span><br>
<span class="file">bunfig.toml</span> <span class="desc">— Bun test runner config</span>
</div>
<!-- ========== BUILDING ========== -->
<h2 id="building">Building & Running</h2>
<h3>Prerequisites</h3>
<ul>
<li><a href="https://perryjs.com">Perry</a> compiler installed</li>
<li>Node.js / npm for dependency management</li>
<li><a href="https://bun.sh">Bun</a> for running tests</li>
</ul>
<h3>Install dependencies</h3>
<pre><code>npm install</code></pre>
<h3>Development (compile & run with hot reload)</h3>
<pre><code>perry compile src/app.ts -o Mango</code></pre>
<h3>Production build</h3>
<pre><code><span class="token-cm"># Build for the current platform</span>
perry build
<span class="token-cm"># Build for a specific target</span>
perry build --target macos
perry build --target ios
perry build --target android
perry build --target linux
perry build --target windows
perry build --target web</code></pre>
<h3>Type checking</h3>
<pre><code>perry check</code></pre>
<h3>Run tests</h3>
<pre><code><span class="token-cm"># All tests</span>
bun test
<span class="token-cm"># Single test file</span>
bun test tests/connection-store.test.ts</code></pre>
<h3>Web mode</h3>
<p>For the web target, Mango runs as a Fastify HTTP server that serves static assets and proxies MongoDB operations over WebSocket:</p>
<pre><code><span class="token-cm"># Start the web server</span>
perry compile src/serve.ts -o MangoWeb
./MangoWeb --host 0.0.0.0 --port 3000
<span class="token-cm"># Transient mode (demo, no persistence)</span>
./MangoWeb --transient</code></pre>
<!-- ========== PERRY OVERVIEW ========== -->
<h2 id="perry-overview">What is Perry?</h2>
<p>Perry is a TypeScript-to-native compiler. It parses TypeScript using <strong>SWC</strong> (Speedy Web Compiler), then generates native machine code via <strong>Cranelift</strong>. The result is a self-contained binary for each platform — no runtime, no interpreter, no bundled V8.</p>
<p>Perry handles:</p>
<ul>
<li><strong>Compilation:</strong> TypeScript → AST (SWC) → Machine code (Cranelift)</li>
<li><strong>Platform abstraction:</strong> A single widget API that maps to native controls per platform</li>
<li><strong>Dead code elimination:</strong> Platform-specific branches are stripped at compile time</li>
<li><strong>System APIs:</strong> Keychain access, dark mode detection, device idiom checks</li>
</ul>
<div class="callout">
<strong>Key insight:</strong> Perry is not a JavaScript runtime. Your TypeScript becomes native code — there is no event loop, no garbage collector, and no JIT compilation at runtime.
</div>
<h3>perry.toml configuration</h3>
<p>The <code>perry.toml</code> file at the project root controls all build settings:</p>
<pre><code><span class="token-cm">[project]</span>
<span class="token-kw">name</span> = <span class="token-str">"Mango"</span>
<span class="token-kw">entry</span> = <span class="token-str">"src/app.ts"</span>
<span class="token-kw">build_number</span> = <span class="token-num">57</span>
<span class="token-cm">[targets]</span>
<span class="token-kw">platforms</span> = [<span class="token-str">"macos"</span>, <span class="token-str">"ios"</span>, <span class="token-str">"android"</span>, <span class="token-str">"linux"</span>, <span class="token-str">"windows"</span>, <span class="token-str">"web"</span>]
<span class="token-cm">[macos]</span>
<span class="token-kw">distribution</span> = [<span class="token-str">"appstore"</span>, <span class="token-str">"direct"</span>]
<span class="token-kw">entitlements</span> = [<span class="token-str">"sandbox"</span>, <span class="token-str">"network-client"</span>]
<span class="token-cm">[build]</span>
<span class="token-kw">opt_level</span> = <span class="token-num">2</span></code></pre>
<!-- ========== PERRY UI ========== -->
<h2 id="perry-ui">UI Widgets</h2>
<p>Perry provides an imperative widget API. There is no JSX, no virtual DOM, and no declarative binding. You create widgets, configure them with function calls, and add them to layout stacks.</p>
<h3>Available widgets</h3>
<table>
<thead>
<tr><th>Widget</th><th>Import</th><th>Description</th></tr>
</thead>
<tbody>
<tr><td><code>VStack</code></td><td><code>perry/ui</code></td><td>Vertical stack layout</td></tr>
<tr><td><code>HStack</code></td><td><code>perry/ui</code></td><td>Horizontal stack layout</td></tr>
<tr><td><code>Text</code></td><td><code>perry/ui</code></td><td>Label / text display</td></tr>
<tr><td><code>TextField</code></td><td><code>perry/ui</code></td><td>Single-line text input</td></tr>
<tr><td><code>TextArea</code></td><td><code>perry/ui</code></td><td>Multi-line text input</td></tr>
<tr><td><code>Button</code></td><td><code>perry/ui</code></td><td>Clickable button</td></tr>
<tr><td><code>ScrollView</code></td><td><code>perry/ui</code></td><td>Scrollable container</td></tr>
<tr><td><code>ImageFile</code></td><td><code>perry/ui</code></td><td>Image display</td></tr>
<tr><td><code>Divider</code></td><td><code>perry/ui</code></td><td>Visual separator</td></tr>
<tr><td><code>Spacer</code></td><td><code>perry/ui</code></td><td>Flexible empty space</td></tr>
</tbody>
</table>
<h3>Creating widgets</h3>
<pre><code><span class="token-kw">import</span> { VStack, HStack, Text, Button, TextField } <span class="token-kw">from</span> <span class="token-str">"perry/ui"</span>;
<span class="token-cm">// Create a vertical layout</span>
<span class="token-kw">const</span> container = <span class="token-kw">new</span> <span class="token-type">VStack</span>();
<span class="token-cm">// Add a text label</span>
<span class="token-kw">const</span> title = <span class="token-kw">new</span> <span class="token-type">Text</span>(<span class="token-str">"Hello, Mango"</span>);
container.<span class="token-fn">addArrangedSubview</span>(title);
<span class="token-cm">// Add a button with a click handler</span>
<span class="token-kw">const</span> btn = <span class="token-kw">new</span> <span class="token-type">Button</span>(<span class="token-str">"Connect"</span>, () => {
<span class="token-fn">handleConnect</span>();
});
container.<span class="token-fn">addArrangedSubview</span>(btn);
<span class="token-cm">// Add a text field</span>
<span class="token-kw">const</span> input = <span class="token-kw">new</span> <span class="token-type">TextField</span>(<span class="token-str">"Enter hostname..."</span>);
container.<span class="token-fn">addArrangedSubview</span>(input);</code></pre>
<!-- ========== PERRY STYLING ========== -->
<h2 id="perry-styling">Styling & Layout</h2>
<p>All styling is done through imperative function calls — there is no CSS. Colors are RGBA values (0.0–1.0 range), and layout is controlled through stack distribution and alignment.</p>
<h3>Styling functions</h3>
<pre><code><span class="token-kw">import</span> {
<span class="token-fn">textSetFontSize</span>,
<span class="token-fn">widgetSetBackgroundColor</span>,
<span class="token-fn">setCornerRadius</span>,
<span class="token-fn">setPadding</span>,
<span class="token-fn">stackSetDistribution</span>,
<span class="token-fn">stackSetAlignment</span>,
<span class="token-fn">setSpacing</span>
} <span class="token-kw">from</span> <span class="token-str">"perry/ui"</span>;
<span class="token-cm">// Font sizing</span>
<span class="token-fn">textSetFontSize</span>(title, <span class="token-num">24</span>);
<span class="token-cm">// Background color (RGBA, 0.0–1.0)</span>
<span class="token-fn">widgetSetBackgroundColor</span>(card, <span class="token-num">1.0</span>, <span class="token-num">1.0</span>, <span class="token-num">1.0</span>, <span class="token-num">1.0</span>);
<span class="token-cm">// Rounded corners</span>
<span class="token-fn">setCornerRadius</span>(card, <span class="token-num">12</span>);
<span class="token-cm">// Padding (top, right, bottom, left)</span>
<span class="token-fn">setPadding</span>(card, <span class="token-num">16</span>, <span class="token-num">20</span>, <span class="token-num">16</span>, <span class="token-num">20</span>);
<span class="token-cm">// Stack layout</span>
<span class="token-fn">stackSetDistribution</span>(container, <span class="token-num">0</span>); <span class="token-cm">// 0 = fill</span>
<span class="token-fn">stackSetAlignment</span>(container, <span class="token-num">0</span>); <span class="token-cm">// 0 = leading</span>
<span class="token-fn">setSpacing</span>(container, <span class="token-num">8</span>);</code></pre>
<div class="callout">
<strong>No CSS, no DOM.</strong> If you're coming from a web background, think of Perry's styling as SwiftUI-style modifiers applied imperatively. Every visual property is set through a direct function call.
</div>
<!-- ========== PERRY PLATFORM ========== -->
<h2 id="perry-platform">Platform Detection</h2>
<p>Perry exposes a compile-time constant <code>__platform__</code> that resolves to an integer. Since this is a compile-time constant, Cranelift eliminates dead branches — native builds never include web-only code and vice versa.</p>
<pre><code><span class="token-cm">// __platform__ values</span>
<span class="token-num">0</span> = macOS
<span class="token-num">1</span> = iOS
<span class="token-num">2</span> = Android
<span class="token-num">3</span> = Windows
<span class="token-num">4</span> = Linux
<span class="token-num">5</span> = Web
<span class="token-cm">// Usage in code</span>
<span class="token-kw">declare const</span> __platform__: <span class="token-type">number</span>;
<span class="token-kw">if</span> (__platform__ === <span class="token-num">5</span>) {
<span class="token-cm">// Web-only code — stripped from native builds</span>
<span class="token-kw">import</span> { WebMongoClient } <span class="token-kw">from</span> <span class="token-str">"./data/web-mongo-client"</span>;
} <span class="token-kw">else</span> {
<span class="token-cm">// Native-only code — stripped from web builds</span>
<span class="token-kw">import</span> { MongoClient } <span class="token-kw">from</span> <span class="token-str">"./data/mongo-client"</span>;
}</code></pre>
<p>The <code>perry-styling</code> module also provides named constants:</p>
<pre><code><span class="token-kw">import</span> { isMacOS, isIOS, isAndroid, isWindows, isLinux, isWeb } <span class="token-kw">from</span> <span class="token-str">"perry-styling"</span>;</code></pre>
<!-- ========== PERRY SYSTEM ========== -->
<h2 id="perry-system">System APIs</h2>
<p>Perry provides platform-native system APIs through the <code>perry/system</code> module:</p>
<table>
<thead>
<tr><th>API</th><th>Description</th></tr>
</thead>
<tbody>
<tr><td><code>isDarkMode()</code></td><td>Returns <code>true</code> if the OS is in dark mode</td></tr>
<tr><td><code>keychainSave(key, value)</code></td><td>Store a secret in the platform keychain (macOS Keychain, Windows Credential Manager, Linux Secret Service)</td></tr>
<tr><td><code>keychainGet(key)</code></td><td>Retrieve a secret from the keychain</td></tr>
<tr><td><code>getDeviceIdiom()</code></td><td>Returns the device type (phone, tablet, desktop)</td></tr>
</tbody>
</table>
<pre><code><span class="token-kw">import</span> { isDarkMode, keychainSave, keychainGet } <span class="token-kw">from</span> <span class="token-str">"perry/system"</span>;
<span class="token-cm">// Determine theme</span>
<span class="token-kw">const</span> dark = <span class="token-fn">isDarkMode</span>();
<span class="token-kw">const</span> bg = dark ? colors.dark.background : colors.light.background;
<span class="token-cm">// Store password securely</span>
<span class="token-kw">await</span> <span class="token-fn">keychainSave</span>(<span class="token-str">"mango-conn-abc123"</span>, password);
<span class="token-cm">// Retrieve password</span>
<span class="token-kw">const</span> pw = <span class="token-kw">await</span> <span class="token-fn">keychainGet</span>(<span class="token-str">"mango-conn-abc123"</span>);</code></pre>
<!-- ========== APP.TS ========== -->
<h2 id="app-ts">app.ts — The Main File</h2>
<p><code>src/app.ts</code> is the single-file entry point for the entire UI. At ~1770 lines, it contains all screens, navigation logic, widget construction, and event handling. This is intentional — Perry apps favor flat, imperative code over deep component hierarchies.</p>
<h3>High-level structure</h3>
<pre><code><span class="token-cm">// 1. Imports</span>
<span class="token-kw">import</span> { VStack, HStack, ... } <span class="token-kw">from</span> <span class="token-str">"perry/ui"</span>;
<span class="token-kw">import</span> { ConnectionStore } <span class="token-kw">from</span> <span class="token-str">"./data/connection-store"</span>;
<span class="token-kw">import</span> { MongoClient } <span class="token-kw">from</span> <span class="token-str">"./data/mongo-client"</span>;
<span class="token-cm">// 2. Global state variables</span>
<span class="token-kw">let</span> connectionIds: <span class="token-type">string</span>[] = [];
<span class="token-kw">let</span> connectionNames: <span class="token-type">string</span>[] = [];
<span class="token-kw">let</span> currentScreen = <span class="token-num">0</span>;
<span class="token-cm">// 3. Screen builders</span>
<span class="token-kw">function</span> <span class="token-fn">buildConnectionList</span>() { ... }
<span class="token-kw">function</span> <span class="token-fn">buildBrowser</span>() { ... }
<span class="token-kw">function</span> <span class="token-fn">buildEditor</span>() { ... }
<span class="token-cm">// 4. Event handlers</span>
<span class="token-kw">function</span> <span class="token-fn">handleConnect</span>() { ... }
<span class="token-kw">function</span> <span class="token-fn">runQuery</span>() { ... }
<span class="token-cm">// 5. App initialization</span>
<span class="token-fn">buildConnectionList</span>();</code></pre>
<!-- ========== SCREENS ========== -->
<h2 id="screens">Screens & Navigation</h2>
<p>Mango uses indexed screen-based navigation. Each screen is a distinct view built by a dedicated function:</p>
<table>
<thead>
<tr><th>Screen</th><th>Function</th><th>Description</th></tr>
</thead>
<tbody>
<tr><td>Connection List</td><td><code>buildConnectionList()</code></td><td>Manage saved connections — create, edit, delete, connect</td></tr>
<tr><td>Database Browser</td><td><code>buildBrowser()</code></td><td>Tree navigation of databases and collections, query bar, results</td></tr>
<tr><td>Document Editor</td><td><code>buildEditor()</code></td><td>View/edit document JSON with syntax highlighting</td></tr>
<tr><td>Edit Modal</td><td><code>showEditView()</code></td><td>Full-screen modal for creating, editing, or duplicating documents</td></tr>
</tbody>
</table>
<p>Navigation between screens is done by toggling visibility of top-level containers and updating the <code>currentScreen</code> index.</p>
<!-- ========== STATE ========== -->
<h2 id="state-management">State Management</h2>
<p>Mango uses module-level variables for all state. There is no Redux, no signals, and no observable patterns — just plain TypeScript variables that are read and mutated directly.</p>
<pre><code><span class="token-cm">// Connection list state</span>
<span class="token-kw">let</span> connectionIds: <span class="token-type">string</span>[] = [];
<span class="token-kw">let</span> connectionNames: <span class="token-type">string</span>[] = [];
<span class="token-kw">let</span> connectionUris: <span class="token-type">string</span>[] = [];
<span class="token-cm">// Form state for connection editing</span>
<span class="token-kw">let</span> formName = <span class="token-str">""</span>;
<span class="token-kw">let</span> formHost = <span class="token-str">"localhost"</span>;
<span class="token-kw">let</span> formPort = <span class="token-str">"27017"</span>;
<span class="token-cm">// Query state</span>
<span class="token-kw">let</span> currentFilter = <span class="token-str">"{}"</span>;
<span class="token-kw">let</span> currentSort = <span class="token-str">"{}"</span>;
<span class="token-kw">let</span> currentProjection = <span class="token-str">"{}"</span>;</code></pre>
<p>When state changes, you manually call widget update functions to refresh the UI:</p>
<pre><code><span class="token-cm">// Update a text widget after state changes</span>
title.<span class="token-fn">setText</span>(<span class="token-str">`Documents (</span>${results.length}<span class="token-str">)`</span>);
<span class="token-cm">// Rebuild a list by removing and re-adding children</span>
listContainer.<span class="token-fn">removeAllArrangedSubviews</span>();
<span class="token-kw">for</span> (<span class="token-kw">const</span> doc <span class="token-kw">of</span> results) {
listContainer.<span class="token-fn">addArrangedSubview</span>(<span class="token-fn">buildDocRow</span>(doc));
}</code></pre>
<div class="callout">
<strong>Why no reactive framework?</strong> Perry compiles to native code, so the overhead of a virtual DOM or reactive system would add complexity without benefit. Direct widget manipulation is predictable and fast.
</div>
<!-- ========== THEMING ========== -->
<h2 id="theming">Theme System</h2>
<p>Mango's theme is defined in <code>src/theme/colors.ts</code> as two color palettes (light and dark) and in <code>src/theme/typography.ts</code> for platform-specific fonts.</p>
<h3>Color palette</h3>
<p>Colors use an RGBA interface with values from 0.0 to 1.0:</p>
<pre><code><span class="token-kw">interface</span> <span class="token-type">RGBA</span> {
r: <span class="token-type">number</span>; g: <span class="token-type">number</span>; b: <span class="token-type">number</span>; a: <span class="token-type">number</span>;
}
<span class="token-kw">const</span> light = {
background: { r: <span class="token-num">1.0</span>, g: <span class="token-num">0.973</span>, b: <span class="token-num">0.941</span>, a: <span class="token-num">1.0</span> }, <span class="token-cm">// #FFF8F0 Cream</span>
surface: { r: <span class="token-num">1.0</span>, g: <span class="token-num">1.0</span>, b: <span class="token-num">1.0</span>, a: <span class="token-num">1.0</span> }, <span class="token-cm">// White</span>
text: { r: <span class="token-num">0.169</span>, g: <span class="token-num">0.176</span>, b: <span class="token-num">0.259</span>, a: <span class="token-num">1.0</span> }, <span class="token-cm">// #2B2D42 Charcoal</span>
accent: { r: <span class="token-num">1.0</span>, g: <span class="token-num">0.624</span>, b: <span class="token-num">0.110</span>, a: <span class="token-num">1.0</span> }, <span class="token-cm">// #FF9F1C Mango Orange</span>
};
<span class="token-kw">const</span> dark = {
background: { r: <span class="token-num">0.169</span>, g: <span class="token-num">0.176</span>, b: <span class="token-num">0.259</span>, a: <span class="token-num">1.0</span> }, <span class="token-cm">// #2B2D42 Charcoal</span>
surface: { r: <span class="token-num">0.22</span>, g: <span class="token-num">0.23</span>, b: <span class="token-num">0.31</span>, a: <span class="token-num">1.0</span> }, <span class="token-cm">// Dark Gray</span>
text: { r: <span class="token-num">0.91</span>, g: <span class="token-num">0.91</span>, b: <span class="token-num">0.93</span>, a: <span class="token-num">1.0</span> }, <span class="token-cm">// Light Gray</span>
accent: { r: <span class="token-num">1.0</span>, g: <span class="token-num">0.624</span>, b: <span class="token-num">0.110</span>, a: <span class="token-num">1.0</span> }, <span class="token-cm">// Mango Orange (same)</span>
};</code></pre>
<h3>Typography</h3>
<p>Fonts are selected per platform at compile time:</p>
<table>
<thead>
<tr><th>Platform</th><th>UI Font</th><th>Mono Font</th></tr>
</thead>
<tbody>
<tr><td>macOS / iOS</td><td>.AppleSystemUIFont</td><td>SF Mono</td></tr>
<tr><td>Windows</td><td>Segoe UI</td><td>Cascadia Code</td></tr>
<tr><td>Android</td><td>Roboto</td><td>Roboto Mono</td></tr>
<tr><td>Linux</td><td>Ubuntu</td><td>JetBrains Mono</td></tr>
<tr><td>Web</td><td>system-ui</td><td>ui-monospace</td></tr>
</tbody>
</table>
<p>Font sizes are defined as named constants:</p>
<pre><code><span class="token-kw">const</span> FontSize = {
XS: <span class="token-num">11</span>,
Small: <span class="token-num">13</span>,
Body: <span class="token-num">15</span>,
Large: <span class="token-num">18</span>,
XL: <span class="token-num">32</span>,
};</code></pre>
<!-- ========== CONNECTION STORE ========== -->
<h2 id="connection-store">ConnectionStore</h2>
<p><code>src/data/connection-store.ts</code> manages saved connection profiles in SQLite. It handles creation, retrieval, updates, and deletion of connection configs, with secure password storage through the platform keychain.</p>
<h3>Connection model</h3>
<p>Each connection profile stores:</p>
<ul>
<li><strong>Name</strong> — user-friendly display label</li>
<li><strong>Mode</strong> — <code>host</code> (host + port) or <code>uri</code> (connection string)</li>
<li><strong>Host & Port</strong> — for host mode (defaults: <code>localhost:27017</code>)</li>
<li><strong>URI</strong> — full MongoDB connection string</li>
<li><strong>Auth mechanism</strong> — SCRAM-SHA-256, SCRAM-SHA-1, or X.509</li>
<li><strong>TLS/SSL</strong> — with optional custom CA certificate</li>
<li><strong>Default database</strong> — optional database to select on connect</li>
</ul>
<h3>Password storage</h3>
<p>Passwords are <strong>never</strong> stored in SQLite. On native platforms, they go into the OS keychain. On web, <code>localStorage</code> is used as a fallback.</p>
<pre><code><span class="token-cm">// Native: save to platform keychain</span>
<span class="token-kw">await</span> <span class="token-fn">keychainSave</span>(<span class="token-str">`mango-</span>${connectionId}<span class="token-str">`</span>, password);
<span class="token-cm">// Web fallback: localStorage</span>
localStorage.<span class="token-fn">setItem</span>(<span class="token-str">`mango-pw-</span>${connectionId}<span class="token-str">`</span>, password);</code></pre>
<h3>SQLite schema</h3>
<pre><code><span class="token-kw">CREATE TABLE</span> connections (
id <span class="token-type">TEXT PRIMARY KEY</span>,
name <span class="token-type">TEXT NOT NULL</span>,
mode <span class="token-type">TEXT DEFAULT</span> <span class="token-str">'host'</span>,
host <span class="token-type">TEXT DEFAULT</span> <span class="token-str">'localhost'</span>,
port <span class="token-type">INTEGER DEFAULT</span> <span class="token-num">27017</span>,
uri <span class="token-type">TEXT</span>,
auth <span class="token-type">TEXT</span>,
tls <span class="token-type">INTEGER DEFAULT</span> <span class="token-num">0</span>,
ca_cert <span class="token-type">TEXT</span>,
default_db <span class="token-type">TEXT</span>,
created_at <span class="token-type">TEXT</span>,
updated_at <span class="token-type">TEXT</span>
);
<span class="token-kw">CREATE TABLE</span> app_state (
key <span class="token-type">TEXT PRIMARY KEY</span>,
value <span class="token-type">TEXT</span>
);</code></pre>
<h3>Core API</h3>
<pre><code><span class="token-kw">import</span> { ConnectionStore } <span class="token-kw">from</span> <span class="token-str">"./data/connection-store"</span>;
<span class="token-kw">const</span> store = <span class="token-kw">new</span> <span class="token-type">ConnectionStore</span>();
<span class="token-cm">// Create</span>
<span class="token-kw">const</span> id = store.<span class="token-fn">createConnection</span>({ name, host, port, ... });
<span class="token-cm">// Read</span>
<span class="token-kw">const</span> all = store.<span class="token-fn">getAllConnections</span>();
<span class="token-kw">const</span> one = store.<span class="token-fn">getConnection</span>(id);
<span class="token-cm">// Update</span>
store.<span class="token-fn">updateConnection</span>(id, { name: <span class="token-str">"Production"</span> });
<span class="token-cm">// Delete</span>
store.<span class="token-fn">deleteConnection</span>(id);
<span class="token-cm">// Build a connection URI from a saved profile</span>
<span class="token-kw">const</span> uri = store.<span class="token-fn">buildConnectionUri</span>(id);</code></pre>
<!-- ========== MONGO CLIENT ========== -->
<h2 id="mongo-client">MongoClient</h2>
<p><code>src/data/mongo-client.ts</code> is a thin wrapper around the official MongoDB Node.js driver. It provides the core operations that Mango needs and tracks connection state and latency.</p>
<h3>Core methods</h3>
<table>
<thead>
<tr><th>Method</th><th>Description</th></tr>
</thead>
<tbody>
<tr><td><code>connect(uri)</code></td><td>Establish connection, validate with <code>ping</code></td></tr>
<tr><td><code>disconnect()</code></td><td>Close the connection</td></tr>
<tr><td><code>listDatabases()</code></td><td>List all databases with sizes</td></tr>
<tr><td><code>listCollections(db)</code></td><td>List all collections in a database</td></tr>
<tr><td><code>query(db, coll, opts)</code></td><td>Find documents with filter/sort/projection/limit/skip</td></tr>
<tr><td><code>insertDocument(db, coll, doc)</code></td><td>Insert a new document</td></tr>
<tr><td><code>updateDocument(db, coll, filter, update)</code></td><td>Update a document with <code>$set</code></td></tr>
<tr><td><code>deleteDocument(db, coll, filter)</code></td><td>Delete a single document by filter</td></tr>
<tr><td><code>duplicateDocument(db, coll, doc)</code></td><td>Clone a document (strips <code>_id</code>)</td></tr>
<tr><td><code>getCollectionStats(db, coll)</code></td><td>Collection metadata (count, size, avg doc size)</td></tr>
<tr><td><code>listIndexes(db, coll)</code></td><td>Index list with keys and sizes</td></tr>
</tbody>
</table>
<h3>Query options</h3>
<pre><code><span class="token-kw">interface</span> <span class="token-type">QueryOptions</span> {
filter?: <span class="token-type">object</span>; <span class="token-cm">// MongoDB filter document, e.g. { status: "active" }</span>
sort?: <span class="token-type">object</span>; <span class="token-cm">// Sort spec, e.g. { createdAt: -1 }</span>
projection?: <span class="token-type">object</span>; <span class="token-cm">// Field projection, e.g. { name: 1, email: 1 }</span>
limit?: <span class="token-type">number</span>; <span class="token-cm">// Max documents to return (default from preferences)</span>
skip?: <span class="token-type">number</span>; <span class="token-cm">// Pagination offset</span>
}</code></pre>
<h3>Usage</h3>
<pre><code><span class="token-kw">import</span> { MongoClient } <span class="token-kw">from</span> <span class="token-str">"./data/mongo-client"</span>;
<span class="token-kw">const</span> client = <span class="token-kw">new</span> <span class="token-type">MongoClient</span>();
<span class="token-cm">// Connect</span>
<span class="token-kw">await</span> client.<span class="token-fn">connect</span>(<span class="token-str">"mongodb://localhost:27017"</span>);
<span class="token-cm">// List databases</span>
<span class="token-kw">const</span> dbs = <span class="token-kw">await</span> client.<span class="token-fn">listDatabases</span>();
<span class="token-cm">// Query with filter and sort</span>
<span class="token-kw">const</span> docs = <span class="token-kw">await</span> client.<span class="token-fn">query</span>(<span class="token-str">"mydb"</span>, <span class="token-str">"users"</span>, {
filter: { active: <span class="token-kw">true</span> },
sort: { createdAt: -<span class="token-num">1</span> },
limit: <span class="token-num">50</span>
});
<span class="token-cm">// Insert a document</span>
<span class="token-kw">await</span> client.<span class="token-fn">insertDocument</span>(<span class="token-str">"mydb"</span>, <span class="token-str">"users"</span>, {
name: <span class="token-str">"Alice"</span>,
email: <span class="token-str">"alice@example.com"</span>
});</code></pre>
<!-- ========== PREFERENCES ========== -->
<h2 id="preferences">PreferencesStore</h2>
<p><code>src/data/preferences.ts</code> persists user settings in SQLite with an in-memory cache for fast reads.</p>
<h3>Available preferences</h3>
<table>
<thead>
<tr><th>Key</th><th>Type</th><th>Default</th><th>Description</th></tr>
</thead>
<tbody>
<tr><td><code>theme</code></td><td>string</td><td><code>"system"</code></td><td>Color theme: <code>"system"</code>, <code>"light"</code>, or <code>"dark"</code></td></tr>
<tr><td><code>pageSize</code></td><td>number</td><td><code>20</code></td><td>Documents per query page: 20, 50, 100, or 500</td></tr>
<tr><td><code>expandDocumentsByDefault</code></td><td>boolean</td><td><code>false</code></td><td>Auto-expand JSON documents in results</td></tr>
<tr><td><code>showCollectionStats</code></td><td>boolean</td><td><code>false</code></td><td>Show doc count & size in sidebar</td></tr>
<tr><td><code>analyticsEnabled</code></td><td>boolean</td><td><code>true</code></td><td>Opt-in/out of anonymous telemetry</td></tr>
<tr><td><code>lastConnectionId</code></td><td>string?</td><td><code>null</code></td><td>Auto-select last-used connection on launch</td></tr>
<tr><td><code>sidebarWidth</code></td><td>number</td><td><code>250</code></td><td>Width of the database sidebar in pixels</td></tr>
</tbody>
</table>
<h3>Usage</h3>
<pre><code><span class="token-kw">import</span> { PreferencesStore } <span class="token-kw">from</span> <span class="token-str">"./data/preferences"</span>;
<span class="token-kw">const</span> prefs = <span class="token-kw">new</span> <span class="token-type">PreferencesStore</span>();
<span class="token-cm">// Read (returns from in-memory cache)</span>
<span class="token-kw">const</span> theme = prefs.<span class="token-fn">get</span>(<span class="token-str">"theme"</span>); <span class="token-cm">// "system"</span>
<span class="token-kw">const</span> pageSize = prefs.<span class="token-fn">get</span>(<span class="token-str">"pageSize"</span>); <span class="token-cm">// 20</span>
<span class="token-cm">// Write (updates cache + SQLite)</span>
prefs.<span class="token-fn">set</span>(<span class="token-str">"theme"</span>, <span class="token-str">"dark"</span>);
prefs.<span class="token-fn">set</span>(<span class="token-str">"pageSize"</span>, <span class="token-num">100</span>);</code></pre>
<!-- ========== WEB CLIENT ========== -->
<h2 id="web-client">Web Mode & WebSocket Proxy</h2>
<p>When compiled for the web target, Mango can't use the native MongoDB driver directly (browsers lack TCP socket access). Instead, a Fastify server (<code>src/serve.ts</code>) acts as a proxy:</p>
<h3>Server (serve.ts)</h3>
<pre><code><span class="token-cm">// serve.ts starts a Fastify HTTP server</span>
<span class="token-cm">// Serves static assets (HTML, JS, CSS) over HTTP</span>
<span class="token-cm">// Proxies MongoDB operations over WebSocket at /ws</span>
<span class="token-cm">// Supported WebSocket messages:</span>
{
action: <span class="token-str">"connect"</span>, <span class="token-cm">// → MongoClient.connect(uri)</span>
action: <span class="token-str">"disconnect"</span>, <span class="token-cm">// → MongoClient.disconnect()</span>
action: <span class="token-str">"listDatabases"</span>, <span class="token-cm">// → MongoClient.listDatabases()</span>
action: <span class="token-str">"listCollections"</span>, <span class="token-cm">// → MongoClient.listCollections(db)</span>
action: <span class="token-str">"find"</span>, <span class="token-cm">// → MongoClient.query(db, coll, opts)</span>
action: <span class="token-str">"insertOne"</span>, <span class="token-cm">// → MongoClient.insertDocument(...)</span>
action: <span class="token-str">"updateOne"</span>, <span class="token-cm">// → MongoClient.updateDocument(...)</span>
action: <span class="token-str">"deleteOne"</span>, <span class="token-cm">// → MongoClient.deleteDocument(...)</span>
}</code></pre>
<h3>Client (web-mongo-client.ts)</h3>
<p>The web-side client mirrors the <code>MongoClient</code> API but sends operations over WebSocket instead of TCP:</p>
<pre><code><span class="token-kw">import</span> { WebMongoClient } <span class="token-kw">from</span> <span class="token-str">"./data/web-mongo-client"</span>;
<span class="token-cm">// Same API as MongoClient — the app code doesn't need to know</span>
<span class="token-cm">// whether it's running natively or in a browser</span>
<span class="token-kw">const</span> client = <span class="token-kw">new</span> <span class="token-type">WebMongoClient</span>();
<span class="token-kw">await</span> client.<span class="token-fn">connect</span>(uri);
<span class="token-kw">const</span> dbs = <span class="token-kw">await</span> client.<span class="token-fn">listDatabases</span>();</code></pre>
<h3>CLI options for serve.ts</h3>
<table>
<thead>
<tr><th>Flag</th><th>Default</th><th>Description</th></tr>
</thead>
<tbody>
<tr><td><code>--host</code></td><td><code>localhost</code></td><td>Bind address</td></tr>
<tr><td><code>--port</code></td><td><code>3000</code></td><td>Listen port</td></tr>
<tr><td><code>--transient</code></td><td><code>false</code></td><td>Demo mode — no data persistence</td></tr>
<tr><td><code>--html</code></td><td>(auto)</td><td>Path to static HTML assets</td></tr>
</tbody>
</table>
<!-- ========== TELEMETRY ========== -->
<h2 id="telemetry">Telemetry</h2>
<p><code>src/data/telemetry.ts</code> provides optional, anonymous event tracking via the Chirp API. It respects the user's <code>analyticsEnabled</code> preference and is fully try-catch wrapped — a telemetry failure will never crash the app.</p>
<h3>Tracked events</h3>
<table>