modelith-plugin-protocol 0.1.0

Contract between Modelith and its plugins: manifest, registry entry, rule set, edit and message types
Documentation
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
//! 利用状況の送信(modelith の ADR-0026)。アプリ・サーバ・受け口が同じ一覧を使う(ADR-0026 の 4)。
//!
//! 送る本文は `kind` で区別する 4 種類で、1 回の要求に 1 つ送る。どれも `schemaVersion` に [`USAGE_SCHEMA_VERSION`] を載せる。
//! 値は、決まった語(列挙)・区分(境目を doc に書いた列挙)・上限つきの回数([`Count`])のどれかで、自由な文字列は受けない
//! (例外は、形と長さを正規表現で決めた版・四半期・ID・コードの場所)。プラグインの名前は送らない。
//! モデルの中身・要素やファイルの名前・エラーの文・端末に残す ID・日時は、どの本文にも入らない(ADR-0026 の 2)。
//! 受け口は受け取った日(UTC)で足し込む。
//!
//! JSON Schema の注記:
//! - 各本文: いつ送るか(`x-modelith-when`)、どの段階で送るか(`x-modelith-level`: `all` は「すべて送る」のときだけ、
//!   `error` は「エラーだけ」でも送る)、本文の大きさの上限(`x-modelith-max-bytes`)。
//! - 項目: `x-modelith-dimension: true` の項目(版・系列・送り手)だけを、受け口はほかの項目と掛け合わせて数える。
//!   それ以外の項目は互いに掛け合わせず 1 つずつ数える(組み合わせが端末を見分ける手がかりにならないように)。
//!   掛け合わせて見たい組は、[`ParseTime`] のように 1 つの項目にまとめる。
//!
//! 受け手は知らない項目を捨てる(版の違う送り手が項目を足しても、本文全体は拒まない)。
//! この型とスキーマは送り手に向けて厳しく、必須の項目が欠けた本文や知らない列挙の値を拒む。
//! 受け口は、軸(`kind`・`schemaVersion`・`client`・`appVersion`・`channel`)だけを必須とし、
//! それ以外の項目は欠けていても、形や値が違っていても、その項目だけを捨てて残りを受ける。

use serde::{Deserialize, Serialize};

/// 利用状況の本文の形の版。項目の意味・区分の境目・値の一覧を変える(消す・改名する)ときに 1 つ上げる。
/// 項目や列挙の値を足すだけなら上げない(受け手は知らないものを捨てるので、古い受け手も壊れない)。
pub const USAGE_SCHEMA_VERSION: u32 = 1;

/// [`Count`] の上限(1 回の本文・1 項目あたり)。送り手はこれで頭打ちにし([`Count::capped`])、受け手は超える値を受けない。
pub const COUNT_MAX: u32 = 10_000;

/// 送る本文。
#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
#[cfg_attr(feature = "codegen", derive(schemars::JsonSchema, ts_rs::TS))]
#[serde(tag = "kind", rename_all = "camelCase")]
#[cfg_attr(feature = "codegen", schemars(title = "Modelith usage report"))]
pub enum UsageReport {
    /// ブラウザのアプリを起動したとき。
    #[cfg_attr(
        feature = "codegen",
        schemars(extend(
            "x-modelith-when" = "startup",
            "x-modelith-level" = "all",
            "x-modelith-max-bytes" = 1024
        ))
    )]
    Startup(StartupReport),
    /// ブラウザのアプリの、日に 1 回のまとめ(手元で足し込んだ回数。送れたら手元の足し込みを消す)。
    #[cfg_attr(
        feature = "codegen",
        schemars(extend(
            "x-modelith-when" = "daily",
            "x-modelith-level" = "all",
            "x-modelith-max-bytes" = 8192
        ))
    )]
    Daily(Box<DailyReport>),
    /// ブラウザのアプリでエラーが起きたとき(すぐ送る)。
    #[cfg_attr(
        feature = "codegen",
        schemars(extend(
            "x-modelith-when" = "error",
            "x-modelith-level" = "error",
            "x-modelith-max-bytes" = 4096
        ))
    )]
    Error(ErrorReport),
    /// 自分で動かすサーバの、日に 1 回のまとめ。
    #[cfg_attr(
        feature = "codegen",
        schemars(extend(
            "x-modelith-when" = "daily",
            "x-modelith-level" = "all",
            "x-modelith-max-bytes" = 2048
        ))
    )]
    ServerDaily(ServerDailyReport),
}

/// 起動の報告。
#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
#[cfg_attr(feature = "codegen", derive(schemars::JsonSchema, ts_rs::TS))]
#[serde(rename_all = "camelCase")]
pub struct StartupReport {
    pub schema_version: u32,
    #[serde(flatten)]
    pub sender: Sender,
    /// 環境(任意)。環境は日に 1 回のまとめ([`DailyReport`])で送り、起動の報告では送らなくてよい。
    #[serde(default, skip_serializing_if = "Option::is_none")]
    #[cfg_attr(feature = "codegen", ts(optional))]
    pub browser: Option<Browser>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    #[cfg_attr(feature = "codegen", ts(optional))]
    pub os: Option<Os>,
    /// 画面の幅の区分。
    #[serde(default, skip_serializing_if = "Option::is_none")]
    #[cfg_attr(feature = "codegen", ts(optional))]
    pub screen: Option<ScreenClass>,
    /// 画面の表示の言語(BCP 47 の言語の部分)。
    #[serde(default, skip_serializing_if = "Option::is_none")]
    #[cfg_attr(feature = "codegen", ts(optional))]
    pub language: Option<Language>,
    /// 手元のフォルダを開けるブラウザか(File System Access)。
    #[serde(default, skip_serializing_if = "Option::is_none")]
    #[cfg_attr(feature = "codegen", ts(optional))]
    pub folder_access: Option<bool>,
    /// 起動にかかった時間の区分。
    pub startup_time: DurationClass,
}

/// 日に 1 回のまとめ。
#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
#[cfg_attr(feature = "codegen", derive(schemars::JsonSchema, ts_rs::TS))]
#[serde(rename_all = "camelCase")]
pub struct DailyReport {
    pub schema_version: u32,
    #[serde(flatten)]
    pub sender: Sender,
    /// 環境。日に 1 回なので、起動の回数ではなく使われた端末の数に近い分母になる(環境はここで送る)。
    /// 型の上では任意(受け口は欠けた項目を読み飛ばす)。
    #[serde(default, skip_serializing_if = "Option::is_none")]
    #[cfg_attr(feature = "codegen", ts(optional))]
    pub browser: Option<Browser>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    #[cfg_attr(feature = "codegen", ts(optional))]
    pub os: Option<Os>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    #[cfg_attr(feature = "codegen", ts(optional))]
    pub screen: Option<ScreenClass>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    #[cfg_attr(feature = "codegen", ts(optional))]
    pub language: Option<Language>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    #[cfg_attr(feature = "codegen", ts(optional))]
    pub folder_access: Option<bool>,
    /// その日に初めて起きた、使い始めの段階(同じ段階は 1 回だけ)。
    #[serde(default)]
    #[cfg_attr(
        feature = "codegen",
        schemars(length(max = 7), extend("uniqueItems" = true))
    )]
    pub onboarding: Vec<OnboardingStep>,
    /// 自動の図の種類ごとの表示の回数。表示の回数は、図のタブを開いた・切り替えた回数(描き直しのたびではない)。
    #[serde(default)]
    pub auto_views: AutoViews,
    /// 作成した図(テキストの view)の種類ごとの表示の回数。数え方は `auto_views` と同じ。view の名前は送らない。
    #[serde(default)]
    pub created_views: CreatedViews,
    /// 編集の意図(modelith-core の `Intent` の op)ごとの回数と、元に戻す・やり直す。
    #[serde(default)]
    pub edits: Edits,
    /// 図の見た目だけを変える操作の回数(モデルは変わらない)。
    #[serde(default)]
    pub layout: Layout,
    /// 保存先ごとの保存の回数。
    #[serde(default)]
    pub saves: Saves,
    /// エクスポートの形式ごとの回数。
    #[serde(default)]
    pub exports: Exports,
    /// チェックの実行。
    #[serde(default)]
    pub checks: Checks,
    /// プラグインの機能(チェック・コマンド・エクスポートなど)を使った回数。どのプラグインかは送らない
    /// (公開の登録簿ができるまで名前を入れない。入れるときは任意の項目として足す)。
    #[serde(default)]
    pub plugin_uses: Count,
    /// AI による書き換え(MCP)の回数。アプリが数えられるのは modelith 0.4.0 から。
    #[serde(default)]
    pub ai_rewrites: Count,
    /// 解析にかかった時間の区分ごとの回数(ファイルの大きさの区分ごと)。同じ組が 2 度あれば、受け口は足し合わせる。
    #[serde(default)]
    #[cfg_attr(feature = "codegen", schemars(length(max = 20)))]
    pub parse_times: Vec<ParseTime>,
    /// wasm を読み込めなかった回数。
    #[serde(default)]
    pub wasm_load_failures: Count,
    /// コアを動かす Worker が止まり、作り直した回数。
    #[serde(default)]
    pub worker_restarts: Count,
    /// このブラウザで使った週の数の区分(ID を持たずに、続けて使われているかを測る)。
    #[serde(default, skip_serializing_if = "Option::is_none")]
    #[cfg_attr(feature = "codegen", ts(optional))]
    pub weeks_used: Option<WeeksClass>,
    /// このブラウザで初めて使った四半期(`YYYY-Qn`。例: `2026-Q4`)。端末の手がかりにならないよう、月より粗くする。
    #[serde(default, skip_serializing_if = "Option::is_none")]
    #[cfg_attr(feature = "codegen", schemars(regex(pattern = r"^\d{4}-Q[1-4]$")))]
    #[cfg_attr(feature = "codegen", ts(optional))]
    pub first_quarter: Option<String>,
}

/// エラーの報告。エラーの文と利用者の文字は含めず、種類と自分たちのコードの場所だけを送る。
#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
#[cfg_attr(feature = "codegen", derive(schemars::JsonSchema, ts_rs::TS))]
#[serde(rename_all = "camelCase")]
pub struct ErrorReport {
    pub schema_version: u32,
    #[serde(flatten)]
    pub sender: Sender,
    /// 送る段階(「すべて送る」と「エラーだけ」の比を数える)。
    pub level: SendLevel,
    pub error_kind: ErrorKind,
    /// 例外の種類(JS のエラーの名前、DOMException の名前)。
    pub error_name: ErrorName,
    /// スタックトレース(内側から外側へ)。送り手は、自分たちの配信物(アプリの `assets/` の JS と wasm)の段だけを入れ、
    /// プラグインやブラウザの拡張など、ほかのコードの段は送らない(受け口は `module` の形しか確かめられない)。
    #[cfg_attr(feature = "codegen", schemars(length(max = 30)))]
    pub frames: Vec<StackFrame>,
}

/// スタックトレースの 1 段。
#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
#[cfg_attr(feature = "codegen", derive(schemars::JsonSchema, ts_rs::TS))]
#[serde(rename_all = "camelCase")]
pub struct StackFrame {
    /// 配信しているアプリのファイル(例: `assets/index-3f2a.js`)。利用者のファイルの名前は入らない。
    #[cfg_attr(
        feature = "codegen",
        schemars(regex(pattern = r"^[A-Za-z0-9_][A-Za-z0-9_./-]{0,119}$"))
    )]
    pub module: String,
    /// 関数の名前(wasm の中のコアの関数。例: `modelith_core::edit::ops::rename`)。縮めた JS の関数名は送らない。
    #[serde(default, skip_serializing_if = "Option::is_none")]
    #[cfg_attr(
        feature = "codegen",
        schemars(regex(pattern = r"^[A-Za-z0-9_:<>$.]{1,200}$"))
    )]
    #[cfg_attr(feature = "codegen", ts(optional))]
    pub function: Option<String>,
    /// 行(取れないときは省く)。
    #[serde(default, skip_serializing_if = "Option::is_none")]
    #[cfg_attr(feature = "codegen", schemars(range(max = 10_000_000)))]
    #[cfg_attr(feature = "codegen", ts(optional))]
    pub line: Option<u32>,
    /// 列(取れないときは省く)。
    #[serde(default, skip_serializing_if = "Option::is_none")]
    #[cfg_attr(feature = "codegen", schemars(range(max = 10_000_000)))]
    #[cfg_attr(feature = "codegen", ts(optional))]
    pub column: Option<u32>,
}

/// サーバの日に 1 回のまとめ。
#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
#[cfg_attr(feature = "codegen", derive(schemars::JsonSchema, ts_rs::TS))]
#[serde(rename_all = "camelCase")]
pub struct ServerDailyReport {
    pub schema_version: u32,
    #[serde(flatten)]
    pub sender: Sender,
    /// 起動ごとに作るランダムな ID(UUID)。サーバに残す ID ではない。
    #[cfg_attr(
        feature = "codegen",
        schemars(regex(
            pattern = r"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"
        ))
    )]
    pub instance_id: String,
    pub os: Os,
    pub deployment: Deployment,
    /// 有効なログインの方式(両方を有効にできる)。
    pub login: LoginMethods,
    /// 利用者の数の区分。
    pub users: AmountClass,
    /// 7 日以内に使った人の数の区分。
    pub active_users_7d: AmountClass,
    /// プロジェクトの数の区分。
    pub projects: AmountClass,
    /// 保存容量の区分。
    pub storage: StorageClass,
    /// プラグインの数の区分。
    pub plugins: AmountClass,
}

/// 送り手(どの本文にも入る)。受け口はこの 3 つだけを、ほかの項目と掛け合わせて数える。
#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
#[cfg_attr(feature = "codegen", derive(schemars::JsonSchema, ts_rs::TS))]
#[serde(rename_all = "camelCase")]
pub struct Sender {
    #[cfg_attr(feature = "codegen", schemars(extend("x-modelith-dimension" = true)))]
    pub client: Client,
    /// 送り手の版(SemVer。例: `0.2.0-rc.1`)。
    #[cfg_attr(
        feature = "codegen",
        schemars(
            regex(pattern = r"^\d+\.\d+\.\d+(-[0-9A-Za-z.-]+)?$"),
            length(max = 32),
            extend("x-modelith-dimension" = true)
        )
    )]
    pub app_version: String,
    #[cfg_attr(feature = "codegen", schemars(extend("x-modelith-dimension" = true)))]
    pub channel: Channel,
}

/// 送り手のプログラム。
#[derive(Debug, Clone, Copy, PartialEq, Eq, Serialize, Deserialize)]
#[cfg_attr(feature = "codegen", derive(schemars::JsonSchema, ts_rs::TS))]
#[serde(rename_all = "camelCase")]
pub enum Client {
    /// ブラウザのアプリ。
    Web,
    /// 自分で動かすサーバ。
    Server,
}

/// アプリの公開の系列(modelith の ADR-0022)。
#[derive(Debug, Clone, Copy, PartialEq, Eq, Serialize, Deserialize)]
#[cfg_attr(feature = "codegen", derive(schemars::JsonSchema, ts_rs::TS))]
#[serde(rename_all = "camelCase")]
pub enum Channel {
    Stable,
    Rc,
    Preview,
}

/// 自動の図の種類ごとの回数(アプリの自動の図の id ごと)。
#[derive(Debug, Clone, PartialEq, Eq, Default, Serialize, Deserialize)]
#[cfg_attr(feature = "codegen", derive(schemars::JsonSchema, ts_rs::TS))]
#[serde(rename_all = "camelCase", default)]
pub struct AutoViews {
    /// トレーサビリティ。
    pub trace: Count,
    /// ブロック定義図。
    pub structure: Count,
    /// 制御ループ。
    pub control: Count,
    /// 内部ブロック図。
    pub ibd: Count,
    /// 振る舞い。
    pub behavior: Count,
    /// シーケンス図。
    pub seq: Count,
    /// アクティビティ図。
    pub afv: Count,
    /// 状態遷移図。
    pub stm: Count,
    /// すべて。
    pub all: Count,
}

/// 作成した図(SysML v2 の view の種類)ごとの回数。
#[derive(Debug, Clone, PartialEq, Eq, Default, Serialize, Deserialize)]
#[cfg_attr(feature = "codegen", derive(schemars::JsonSchema, ts_rs::TS))]
#[serde(rename_all = "camelCase", default)]
pub struct CreatedViews {
    /// GeneralView。
    pub general: Count,
    /// InterconnectionView(内部ブロック図)。
    pub interconnection: Count,
    /// ActionFlowView(アクティビティ図)。
    pub action_flow: Count,
    /// StateTransitionView(状態遷移図)。
    pub state_transition: Count,
    /// SequenceView(シーケンス図)。
    pub sequence: Count,
    /// そのほかの view。
    pub other: Count,
}

/// 編集の回数。名前は modelith-core の `Intent` の op と同じ。
#[derive(Debug, Clone, PartialEq, Eq, Default, Serialize, Deserialize)]
#[cfg_attr(feature = "codegen", derive(schemars::JsonSchema, ts_rs::TS))]
#[serde(rename_all = "camelCase", default)]
pub struct Edits {
    pub add_node: Count,
    pub add_usage: Count,
    pub rename: Count,
    pub delete: Count,
    pub delete_edge: Count,
    pub connect: Count,
    pub add_message: Count,
    pub update_message: Count,
    pub move_message: Count,
    pub set_phase: Count,
    pub init_phases: Count,
    pub make_port: Count,
    pub set_port_dir: Count,
    pub delete_port: Count,
    pub save_view: Count,
    pub add_to_view: Count,
    pub remove_from_view: Count,
    pub rename_view: Count,
    pub delete_view: Count,
    pub set_attribute: Count,
    pub remove_attribute: Count,
    pub set_doc: Count,
    pub undo: Count,
    pub redo: Count,
}

/// 図の見た目だけを変える操作の回数。
#[derive(Debug, Clone, PartialEq, Eq, Default, Serialize, Deserialize)]
#[cfg_attr(feature = "codegen", derive(schemars::JsonSchema, ts_rs::TS))]
#[serde(rename_all = "camelCase", default)]
pub struct Layout {
    /// 要素の移動。
    pub r#move: Count,
    /// 線の調整。
    pub adjust_edge: Count,
    /// 整列。
    pub align: Count,
}

/// 保存先ごとの回数。
#[derive(Debug, Clone, PartialEq, Eq, Default, Serialize, Deserialize)]
#[cfg_attr(feature = "codegen", derive(schemars::JsonSchema, ts_rs::TS))]
#[serde(rename_all = "camelCase", default)]
pub struct Saves {
    /// ブラウザの下書き。
    pub draft: Count,
    /// ダウンロード。
    pub download: Count,
    /// 手元のフォルダ(File System Access)。
    pub folder: Count,
}

/// エクスポートの形式ごとの回数。
#[derive(Debug, Clone, PartialEq, Eq, Default, Serialize, Deserialize)]
#[cfg_attr(feature = "codegen", derive(schemars::JsonSchema, ts_rs::TS))]
#[serde(rename_all = "camelCase", default)]
pub struct Exports {
    pub svg: Count,
    pub png: Count,
    pub jpeg: Count,
    pub drawio: Count,
    /// 画像のコピー。
    pub clipboard: Count,
}

/// チェックの実行の回数と、1 回で見つかった問題の数の区分ごとの回数。
#[derive(Debug, Clone, PartialEq, Eq, Default, Serialize, Deserialize)]
#[cfg_attr(feature = "codegen", derive(schemars::JsonSchema, ts_rs::TS))]
#[serde(rename_all = "camelCase", default)]
pub struct Checks {
    pub runs: Count,
    /// 問題が 0 件だった回数。
    pub no_problems: Count,
    /// 1〜9 件だった回数。
    pub problems_1_to_9: Count,
    /// 10〜99 件だった回数。
    pub problems_10_to_99: Count,
    /// 100 件以上だった回数。
    pub problems_100_or_more: Count,
}

/// 解析の時間の区分ごとの回数(ファイルの大きさ × 時間を 1 つの項目として数える)。
#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
#[cfg_attr(feature = "codegen", derive(schemars::JsonSchema, ts_rs::TS))]
#[serde(rename_all = "camelCase")]
pub struct ParseTime {
    pub file_size: SizeClass,
    pub duration: ParseDurationClass,
    pub count: Count,
}

/// 上限つきの回数(0 以上 [`COUNT_MAX`] 以下)。
#[derive(Debug, Clone, Copy, PartialEq, Eq, PartialOrd, Ord, Default, Serialize)]
#[cfg_attr(feature = "codegen", derive(ts_rs::TS))]
pub struct Count(u32);

impl Count {
    /// 上限で頭打ちにした回数。送り手が手元で足し込んだ数を本文に入れるときに使う。
    pub fn capped(n: u64) -> Self {
        Self(u32::try_from(n.min(u64::from(COUNT_MAX))).unwrap_or(COUNT_MAX))
    }

    pub fn get(self) -> u32 {
        self.0
    }
}

impl TryFrom<u32> for Count {
    type Error = String;
    fn try_from(n: u32) -> Result<Self, Self::Error> {
        if n <= COUNT_MAX {
            Ok(Self(n))
        } else {
            Err(format!("count {n} exceeds the maximum {COUNT_MAX}"))
        }
    }
}

impl<'de> Deserialize<'de> for Count {
    fn deserialize<D: serde::Deserializer<'de>>(d: D) -> Result<Self, D::Error> {
        Self::try_from(u32::deserialize(d)?).map_err(serde::de::Error::custom)
    }
}

#[cfg(feature = "codegen")]
impl schemars::JsonSchema for Count {
    fn schema_name() -> std::borrow::Cow<'static, str> {
        "Count".into()
    }

    fn json_schema(_: &mut schemars::SchemaGenerator) -> schemars::Schema {
        schemars::json_schema!({
            "type": "integer",
            "minimum": 0,
            "maximum": COUNT_MAX,
            "description": "A count from 0 up to the maximum. Senders cap larger counts at the maximum."
        })
    }
}

/// 送る段階(modelith の ADR-0026 の 1)。「送らない」の人の分は届かない。
#[derive(Debug, Clone, Copy, PartialEq, Eq, Serialize, Deserialize)]
#[cfg_attr(feature = "codegen", derive(schemars::JsonSchema, ts_rs::TS))]
#[serde(rename_all = "camelCase")]
pub enum SendLevel {
    /// すべて送る。
    All,
    /// エラーだけ送る。
    ErrorsOnly,
}

#[derive(Debug, Clone, Copy, PartialEq, Eq, Serialize, Deserialize)]
#[cfg_attr(feature = "codegen", derive(schemars::JsonSchema, ts_rs::TS))]
#[serde(rename_all = "camelCase")]
pub enum Browser {
    Chrome,
    Edge,
    Firefox,
    Safari,
    Other,
}

#[derive(Debug, Clone, Copy, PartialEq, Eq, Serialize, Deserialize)]
#[cfg_attr(feature = "codegen", derive(schemars::JsonSchema, ts_rs::TS))]
#[serde(rename_all = "camelCase")]
pub enum Os {
    Windows,
    Macos,
    Linux,
    Android,
    Ios,
    Other,
}

/// 画面の幅の区分(760px は modelith の狭い画面の境目)。
#[derive(Debug, Clone, Copy, PartialEq, Eq, Serialize, Deserialize)]
#[cfg_attr(feature = "codegen", derive(schemars::JsonSchema, ts_rs::TS))]
#[serde(rename_all = "camelCase")]
pub enum ScreenClass {
    /// 760px 以下。
    Phone,
    /// 760px より広く 1024px 以下。
    Tablet,
    /// 1024px より広い。
    Desktop,
}

/// 画面の表示の言語(modelith の ADR-0027)。
#[derive(Debug, Clone, Copy, PartialEq, Eq, Serialize, Deserialize)]
#[cfg_attr(feature = "codegen", derive(schemars::JsonSchema, ts_rs::TS))]
#[serde(rename_all = "camelCase")]
pub enum Language {
    Ja,
    En,
    Other,
}

/// 使い始めの段階。
#[derive(Debug, Clone, Copy, PartialEq, Eq, Serialize, Deserialize)]
#[cfg_attr(feature = "codegen", derive(schemars::JsonSchema, ts_rs::TS))]
#[serde(rename_all = "camelCase")]
pub enum OnboardingStep {
    /// 「サンプルを開く」か、起動時のサンプルを開いた。
    SampleOpened,
    /// テキストを初めて書き換えた。
    TextWritten,
    /// 図のタブを初めて切り替えた(起動直後の自動の表示は数えない)。
    DiagramOpened,
    /// 図から初めて編集した。
    Edited,
    /// 図(view)を初めて作った。
    ViewCreated,
    /// ダウンロード・名前を付けて保存・上書き保存のどれか。
    Saved,
    /// フォルダを開いた。
    FolderOpened,
}

/// かかった時間の区分。
#[derive(Debug, Clone, Copy, PartialEq, Eq, Serialize, Deserialize)]
#[cfg_attr(feature = "codegen", derive(schemars::JsonSchema, ts_rs::TS))]
pub enum DurationClass {
    /// 1 秒未満。
    #[serde(rename = "lt1s")]
    Under1s,
    /// 1 秒以上 3 秒未満。
    #[serde(rename = "1to3s")]
    From1To3s,
    /// 3 秒以上 10 秒未満。
    #[serde(rename = "3to10s")]
    From3To10s,
    /// 10 秒以上。
    #[serde(rename = "ge10s")]
    Over10s,
}

/// 解析にかかった時間の区分(解析は速いので、起動より細かい)。
#[derive(Debug, Clone, Copy, PartialEq, Eq, Serialize, Deserialize)]
#[cfg_attr(feature = "codegen", derive(schemars::JsonSchema, ts_rs::TS))]
pub enum ParseDurationClass {
    /// 100 ミリ秒未満。
    #[serde(rename = "lt100ms")]
    Under100Ms,
    /// 100 ミリ秒以上 300 ミリ秒未満。
    #[serde(rename = "100to300ms")]
    From100To300Ms,
    /// 300 ミリ秒以上 1 秒未満。
    #[serde(rename = "300msTo1s")]
    From300MsTo1s,
    /// 1 秒以上 3 秒未満。
    #[serde(rename = "1to3s")]
    From1To3s,
    /// 3 秒以上。
    #[serde(rename = "ge3s")]
    Over3s,
}

/// ファイルの大きさの区分(UTF-8 のバイト数)。
#[derive(Debug, Clone, Copy, PartialEq, Eq, Serialize, Deserialize)]
#[cfg_attr(feature = "codegen", derive(schemars::JsonSchema, ts_rs::TS))]
pub enum SizeClass {
    /// 10 KB 未満。
    #[serde(rename = "lt10kb")]
    Under10Kb,
    /// 10 KB 以上 100 KB 未満。
    #[serde(rename = "10to100kb")]
    From10To100Kb,
    /// 100 KB 以上 1 MB 未満。
    #[serde(rename = "100kbTo1mb")]
    From100KbTo1Mb,
    /// 1 MB 以上。
    #[serde(rename = "ge1mb")]
    Over1Mb,
}

/// このブラウザで使った週の数の区分。
#[derive(Debug, Clone, Copy, PartialEq, Eq, Serialize, Deserialize)]
#[cfg_attr(feature = "codegen", derive(schemars::JsonSchema, ts_rs::TS))]
pub enum WeeksClass {
    /// 1 週。
    #[serde(rename = "1")]
    One,
    /// 2〜4 週。
    #[serde(rename = "2to4")]
    From2To4,
    /// 5〜12 週。
    #[serde(rename = "5to12")]
    From5To12,
    /// 13 週以上。
    #[serde(rename = "ge13")]
    Over13,
}

/// 数の区分(サーバの利用者・プロジェクト・プラグインの数)。
#[derive(Debug, Clone, Copy, PartialEq, Eq, Serialize, Deserialize)]
#[cfg_attr(feature = "codegen", derive(schemars::JsonSchema, ts_rs::TS))]
pub enum AmountClass {
    #[serde(rename = "0")]
    Zero,
    #[serde(rename = "1")]
    One,
    /// 2〜10。
    #[serde(rename = "2to10")]
    From2To10,
    /// 11〜100。
    #[serde(rename = "11to100")]
    From11To100,
    /// 101〜1000。
    #[serde(rename = "101to1000")]
    From101To1000,
    /// 1001 以上。
    #[serde(rename = "ge1001")]
    Over1000,
}

/// 保存容量の区分。
#[derive(Debug, Clone, Copy, PartialEq, Eq, Serialize, Deserialize)]
#[cfg_attr(feature = "codegen", derive(schemars::JsonSchema, ts_rs::TS))]
pub enum StorageClass {
    /// 100 MB 未満。
    #[serde(rename = "lt100mb")]
    Under100Mb,
    /// 100 MB 以上 1 GB 未満。
    #[serde(rename = "100mbTo1gb")]
    From100MbTo1Gb,
    /// 1 GB 以上 10 GB 未満。
    #[serde(rename = "1to10gb")]
    From1To10Gb,
    /// 10 GB 以上。
    #[serde(rename = "ge10gb")]
    Over10Gb,
}

/// サーバの動かし方。
#[derive(Debug, Clone, Copy, PartialEq, Eq, Serialize, Deserialize)]
#[cfg_attr(feature = "codegen", derive(schemars::JsonSchema, ts_rs::TS))]
#[serde(rename_all = "camelCase")]
pub enum Deployment {
    Docker,
    Binary,
}

/// サーバの有効なログインの方式。
#[derive(Debug, Clone, Copy, PartialEq, Eq, Serialize, Deserialize)]
#[cfg_attr(feature = "codegen", derive(schemars::JsonSchema, ts_rs::TS))]
#[serde(rename_all = "camelCase")]
pub struct LoginMethods {
    /// 管理者が作るアカウント(OIDC と併せた非常用の管理者を含む)。
    pub accounts: bool,
    pub oidc: bool,
}

/// エラーの種類。
#[derive(Debug, Clone, Copy, PartialEq, Eq, Serialize, Deserialize)]
#[cfg_attr(feature = "codegen", derive(schemars::JsonSchema, ts_rs::TS))]
#[serde(rename_all = "camelCase")]
pub enum ErrorKind {
    /// 捕まえられなかった例外。
    UncaughtError,
    /// 処理されなかった Promise の拒否。
    UnhandledRejection,
    /// wasm(コア)の中の panic。
    WasmPanic,
}

/// 例外の種類。決まった一覧に無いものは `other`。
#[derive(Debug, Clone, Copy, PartialEq, Eq, Serialize, Deserialize)]
#[cfg_attr(feature = "codegen", derive(schemars::JsonSchema, ts_rs::TS))]
#[serde(rename_all = "camelCase")]
pub enum ErrorName {
    Error,
    TypeError,
    RangeError,
    ReferenceError,
    SyntaxError,
    /// DOMException の NotAllowedError(クリップボード・フォルダの許可など)。
    NotAllowedError,
    /// DOMException の QuotaExceededError(保存領域の不足)。
    QuotaExceededError,
    /// DOMException の AbortError。
    AbortError,
    /// DOMException の SecurityError。
    SecurityError,
    /// DOMException の NotFoundError。
    NotFoundError,
    /// そのほかの DOMException。
    OtherDomException,
    /// wasm の panic など、名前の無いもの。
    Panic,
    Other,
}

#[cfg(test)]
mod tests {
    use serde_json::json;

    use super::*;

    fn startup() -> serde_json::Value {
        json!({
            "kind": "startup", "schemaVersion": 1, "client": "web", "appVersion": "0.2.0-rc.1",
            "channel": "rc", "browser": "chrome", "os": "macos", "screen": "desktop", "language": "ja",
            "folderAccess": true, "startupTime": "1to3s"
        })
    }

    fn with(mut base: serde_json::Value, key: &str, value: serde_json::Value) -> serde_json::Value {
        base[key] = value;
        base
    }

    // --- 正常系 ---

    #[test]
    fn startup_report_uses_kind_tag_and_flat_sender() {
        // Arrange
        let json = startup();
        // Act
        let report: UsageReport = serde_json::from_value(json).unwrap();
        // Assert
        let UsageReport::Startup(s) = report else {
            panic!("not startup")
        };
        assert_eq!(
            (s.sender.client, s.sender.channel, s.startup_time),
            (Client::Web, Channel::Rc, DurationClass::From1To3s)
        );
    }

    #[test]
    fn startup_report_needs_no_environment() {
        // Arrange(境界値: 環境の項目をすべて省く)
        let mut json = startup();
        for key in ["browser", "os", "screen", "language", "folderAccess"] {
            json.as_object_mut().unwrap().remove(key);
        }
        // Act
        let report: UsageReport = serde_json::from_value(json).unwrap();
        // Assert
        let UsageReport::Startup(s) = report else {
            panic!("not startup")
        };
        assert_eq!(
            (s.browser, s.startup_time),
            (None, DurationClass::From1To3s)
        );
    }

    #[test]
    fn daily_report_counts_default_to_zero() {
        // Arrange(境界値: 必須の項目だけ。回数の項目はすべて省く)
        let json = json!({
            "kind": "daily", "schemaVersion": 1, "client": "web", "appVersion": "0.2.0",
            "channel": "stable"
        });
        // Act
        let report: UsageReport = serde_json::from_value(json).unwrap();
        // Assert
        let UsageReport::Daily(daily) = report else {
            panic!("not daily")
        };
        assert_eq!(
            (daily.edits, daily.exports.clipboard, daily.plugin_uses),
            (Edits::default(), Count::default(), Count::default())
        );
    }

    #[test]
    fn ignores_unknown_fields() {
        // Arrange(新しい版の送り手が項目を足した場合)
        let json = with(startup(), "newField", json!(1));
        // Act
        let result = serde_json::from_value::<UsageReport>(json);
        // Assert
        assert!(result.is_ok(), "{result:?}");
    }

    #[test]
    fn accepts_count_at_the_maximum() {
        // Arrange(境界値: 上限ちょうど)
        let n = COUNT_MAX;
        // Act
        let count = serde_json::from_value::<Count>(json!(n));
        // Assert
        assert_eq!(count.unwrap().get(), COUNT_MAX);
    }

    #[test]
    fn capped_stops_at_the_maximum() {
        // Arrange(境界値: 上限ちょうど・上限 + 1・u64 の最大)
        let inputs = [u64::from(COUNT_MAX), u64::from(COUNT_MAX) + 1, u64::MAX, 3];
        // Act
        let counts = inputs.map(|n| Count::capped(n).get());
        // Assert
        assert_eq!(counts, [COUNT_MAX, COUNT_MAX, COUNT_MAX, 3]);
    }

    #[test]
    fn class_names_are_the_documented_words() {
        // Arrange
        let values = (
            DurationClass::Under1s,
            SizeClass::From100KbTo1Mb,
            WeeksClass::Over13,
            AmountClass::Zero,
            SendLevel::ErrorsOnly,
        );
        // Act
        let json = serde_json::to_value(values).unwrap();
        // Assert
        assert_eq!(
            json,
            json!(["lt1s", "100kbTo1mb", "ge13", "0", "errorsOnly"])
        );
    }

    #[test]
    fn frame_function_is_omitted_when_absent() {
        // Arrange
        let frame = StackFrame {
            module: "assets/index.js".into(),
            function: None,
            line: Some(1),
            column: Some(2),
        };
        // Act
        let json = serde_json::to_value(frame).unwrap();
        // Assert
        assert_eq!(
            json,
            json!({ "module": "assets/index.js", "line": 1, "column": 2 })
        );
    }

    // --- 異常系 ---

    #[test]
    fn rejects_count_over_the_maximum() {
        // Arrange(境界値: 上限 + 1)
        let n = COUNT_MAX + 1;
        // Act
        let result = serde_json::from_value::<Count>(json!(n));
        // Assert
        assert!(result.is_err());
    }

    #[test]
    fn rejects_negative_count() {
        // Arrange(境界値: -1)
        let n = -1;
        // Act
        let result = serde_json::from_value::<Count>(json!(n));
        // Assert
        assert!(result.is_err());
    }

    #[test]
    fn rejects_free_text_in_a_class() {
        // Arrange(区分に決まった語以外を入れる)
        let json = with(startup(), "startupTime", json!("2.3 seconds"));
        // Act
        let result = serde_json::from_value::<UsageReport>(json);
        // Assert
        assert!(result.is_err());
    }

    #[test]
    fn rejects_a_missing_sender_field() {
        // Arrange(必須の送り手の項目 client が無い)
        let mut json = startup();
        json.as_object_mut().unwrap().remove("client");
        // Act
        let result = serde_json::from_value::<UsageReport>(json);
        // Assert
        assert!(result.is_err());
    }

    #[test]
    fn rejects_unknown_kind() {
        // Arrange
        let json = with(startup(), "kind", json!("pageView"));
        // Act
        let result = serde_json::from_value::<UsageReport>(json);
        // Assert
        assert!(result.is_err());
    }
}