@haystackeditor/cli 0.27.3 → 0.28.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.
Files changed (11) hide show
  1. package/README.md +4 -3
  2. package/dist/commands/capture-brief.js +2 -2
  3. package/dist/commands/init.js +2 -2
  4. package/dist/commands/verify.js +85 -77
  5. package/dist/index.js +21 -41
  6. package/dist/schema.js +2 -3
  7. package/package.json +1 -1
  8. package/schemas/verify-raw.v1.json +672 -2
  9. package/schemas/verify.v2.json +672 -2
  10. package/schemas/pre-verify.v1.json +0 -235
  11. package/schemas/pre-verify.v2.json +0 -240
package/schemas/verify.v2.json CHANGED
@@ -2,7 +2,7 @@
2
2
  "$schema": "https://json-schema.org/draft/2020-12/schema",
3
3
  "$id": "https://docs.haystackeditor.com/cli/schemas/verify.v2.json",
4
4
  "title": "Haystack verify: the report on the current change",
5
- "description": "Machine-readable output of `haystack verify --json`: what the text report says, as data. `crawl` is null when there was nothing to verify or no crawl could be started; `onboarding` is set when onboarding stood in the way. The service's whole crawl record is `haystack verify --raw` (`haystack schema verify-raw`).",
5
+ "description": "Machine-readable output of `haystack verify --json`: what the text report says, as data. `crawl` is null when there was nothing to verify or no crawl could be started; `onboarding` is set when onboarding stood in the way. The service's whole crawl record is `haystack verify --raw` (`haystack schema verify-raw`). With no --intent on a change no crawl has started for, `crawl` is null and `handshake` holds the brief.",
6
6
  "type": "object",
7
7
  "additionalProperties": false,
8
8
  "required": [
@@ -11,7 +11,7 @@
11
11
  ],
12
12
  "properties": {
13
13
  "schema_version": {
14
- "const": "2.0.0"
14
+ "const": "2.1.0"
15
15
  },
16
16
  "change": {
17
17
  "description": "Schema 1.0.2: what this verify checked: the capture's base commit (where HEAD meets origin's default branch), its work commit (committed and uncommitted changes), and the files that differ between them.",
@@ -371,6 +371,79 @@
371
371
  }
372
372
  }
373
373
  ]
374
+ },
375
+ "handshake": {
376
+ "description": "Present only for the handshake (a plain `haystack verify` on a change no crawl has started for, exit 4): what the change touches and Haystack's ideas, then `next`, the command to steer the crawl with.",
377
+ "type": "object",
378
+ "additionalProperties": false,
379
+ "required": [
380
+ "run",
381
+ "brief",
382
+ "capture",
383
+ "next"
384
+ ],
385
+ "properties": {
386
+ "run": {
387
+ "oneOf": [
388
+ {
389
+ "type": "null"
390
+ },
391
+ {
392
+ "type": "object",
393
+ "required": [
394
+ "runId",
395
+ "status"
396
+ ],
397
+ "properties": {
398
+ "runId": {
399
+ "type": "string",
400
+ "pattern": "^cv_[0-9a-f]{48}$"
401
+ },
402
+ "status": {
403
+ "enum": [
404
+ "queued",
405
+ "preparing",
406
+ "crawling",
407
+ "draining",
408
+ "completed",
409
+ "prepared",
410
+ "incomplete",
411
+ "cancelled"
412
+ ]
413
+ }
414
+ }
415
+ }
416
+ ]
417
+ },
418
+ "brief": {
419
+ "oneOf": [
420
+ {
421
+ "type": "null"
422
+ },
423
+ {
424
+ "$ref": "#/$defs/brief"
425
+ }
426
+ ]
427
+ },
428
+ "capture": {
429
+ "description": "CAPTURE-V1 rule 7b (2.0.0): what consenting real users do on the routes this change touches, from Haystack's capture tag, one section per app whose .haystack/capture.json records it (`haystack init` writes it in the app's directory, such as apps/web in a monorepo; `app` is that directory, '.' for the root); null when the checkout has none (capture not set up). The change's files (the brief's function files and the changed files) are joined to routes through each app's route manifest source entries; shares are of distinct captured sessions over the window; sessions on pages no route names are `unmapped`, never counted as zero. A read that fails is `unavailable` and never fails the command.",
430
+ "oneOf": [
431
+ {
432
+ "type": "null"
433
+ },
434
+ {
435
+ "type": "array",
436
+ "minItems": 1,
437
+ "items": {
438
+ "$ref": "#/$defs/captureSection"
439
+ }
440
+ }
441
+ ]
442
+ },
443
+ "next": {
444
+ "type": "string"
445
+ }
446
+ }
374
447
  }
375
448
  },
376
449
  "$defs": {
@@ -650,6 +723,603 @@
650
723
  "items": {
651
724
  "type": "string"
652
725
  }
726
+ },
727
+ "captureSection": {
728
+ "oneOf": [
729
+ {
730
+ "type": "object",
731
+ "additionalProperties": false,
732
+ "required": [
733
+ "app",
734
+ "applicationId",
735
+ "state",
736
+ "window"
737
+ ],
738
+ "properties": {
739
+ "app": {
740
+ "type": "string"
741
+ },
742
+ "applicationId": {
743
+ "type": "string"
744
+ },
745
+ "state": {
746
+ "const": "ready"
747
+ },
748
+ "window": {
749
+ "$ref": "#/$defs/captureWindow"
750
+ }
751
+ }
752
+ },
753
+ {
754
+ "type": "object",
755
+ "additionalProperties": false,
756
+ "required": [
757
+ "app",
758
+ "applicationId",
759
+ "state"
760
+ ],
761
+ "properties": {
762
+ "app": {
763
+ "type": "string"
764
+ },
765
+ "applicationId": {
766
+ "type": "string"
767
+ },
768
+ "state": {
769
+ "const": "no-data"
770
+ }
771
+ }
772
+ },
773
+ {
774
+ "type": "object",
775
+ "additionalProperties": false,
776
+ "required": [
777
+ "app",
778
+ "applicationId",
779
+ "state",
780
+ "reason"
781
+ ],
782
+ "properties": {
783
+ "app": {
784
+ "type": "string"
785
+ },
786
+ "applicationId": {
787
+ "oneOf": [
788
+ {
789
+ "type": "null"
790
+ },
791
+ {
792
+ "type": "string"
793
+ }
794
+ ]
795
+ },
796
+ "state": {
797
+ "const": "unavailable"
798
+ },
799
+ "reason": {
800
+ "type": "string"
801
+ }
802
+ }
803
+ }
804
+ ]
805
+ },
806
+ "brief": {
807
+ "type": "object",
808
+ "required": [
809
+ "functions",
810
+ "leftOut",
811
+ "planning"
812
+ ],
813
+ "properties": {
814
+ "functions": {
815
+ "description": "Every affected function the front half listed (at most 2000), nearest first. distance 0 is edited by the change; 1 is one engine edge away.",
816
+ "type": "array",
817
+ "maxItems": 2000,
818
+ "items": {
819
+ "type": "object",
820
+ "required": [
821
+ "file",
822
+ "name",
823
+ "lines",
824
+ "distance",
825
+ "direction"
826
+ ],
827
+ "properties": {
828
+ "file": {
829
+ "type": "string"
830
+ },
831
+ "name": {
832
+ "type": "string"
833
+ },
834
+ "lines": {
835
+ "type": "array",
836
+ "minItems": 2,
837
+ "maxItems": 2,
838
+ "items": {
839
+ "type": "integer",
840
+ "minimum": 0
841
+ }
842
+ },
843
+ "distance": {
844
+ "type": "integer",
845
+ "minimum": 0
846
+ },
847
+ "direction": {
848
+ "enum": [
849
+ "changed",
850
+ "upstream",
851
+ "downstream"
852
+ ]
853
+ }
854
+ }
855
+ }
856
+ },
857
+ "leftOut": {
858
+ "description": "Functions the blast radius found but did not list, counted with why.",
859
+ "type": "array",
860
+ "items": {
861
+ "type": "object",
862
+ "required": [
863
+ "reason",
864
+ "count"
865
+ ],
866
+ "properties": {
867
+ "reason": {
868
+ "type": "string"
869
+ },
870
+ "count": {
871
+ "type": "integer",
872
+ "minimum": 0
873
+ }
874
+ }
875
+ }
876
+ },
877
+ "production": {
878
+ "description": "CRAWL-V1 amendment 19, only when the repository's own Haystack telemetry holds data in the last 7 days: how the brief's functions ran in production, by their index in `functions` (production runs the code before the change; lines are moved through the change's diff). A function with no row is unknown, not unused.",
879
+ "type": "object",
880
+ "required": [
881
+ "windowDays",
882
+ "payloads",
883
+ "newestAt",
884
+ "partial",
885
+ "functions"
886
+ ],
887
+ "properties": {
888
+ "windowDays": {
889
+ "type": "integer",
890
+ "minimum": 1
891
+ },
892
+ "payloads": {
893
+ "type": "integer",
894
+ "minimum": 1
895
+ },
896
+ "newestAt": {
897
+ "type": "string"
898
+ },
899
+ "partial": {
900
+ "type": "boolean",
901
+ "description": "The read stopped at its byte budget: every count is a lower bound."
902
+ },
903
+ "functions": {
904
+ "type": "array",
905
+ "items": {
906
+ "type": "object",
907
+ "required": [
908
+ "index",
909
+ "branches",
910
+ "branchesOmitted",
911
+ "values",
912
+ "valuesOmitted"
913
+ ],
914
+ "properties": {
915
+ "index": {
916
+ "type": "integer",
917
+ "minimum": 0
918
+ },
919
+ "branches": {
920
+ "type": "array",
921
+ "maxItems": 100,
922
+ "items": {
923
+ "type": "object",
924
+ "required": [
925
+ "line",
926
+ "whenTrue",
927
+ "whenFalse",
928
+ "capped"
929
+ ],
930
+ "properties": {
931
+ "line": {
932
+ "type": "integer",
933
+ "minimum": 1
934
+ },
935
+ "whenTrue": {
936
+ "type": "integer",
937
+ "minimum": 0
938
+ },
939
+ "whenFalse": {
940
+ "type": "integer",
941
+ "minimum": 0
942
+ },
943
+ "capped": {
944
+ "type": "boolean",
945
+ "description": "A counter hit its cap: the counts are lower bounds."
946
+ }
947
+ }
948
+ }
949
+ },
950
+ "branchesOmitted": {
951
+ "type": "integer",
952
+ "minimum": 0
953
+ },
954
+ "values": {
955
+ "type": "array",
956
+ "maxItems": 100,
957
+ "items": {
958
+ "type": "object",
959
+ "required": [
960
+ "line",
961
+ "what",
962
+ "shapes"
963
+ ],
964
+ "properties": {
965
+ "line": {
966
+ "type": "integer",
967
+ "minimum": 1
968
+ },
969
+ "what": {
970
+ "type": "string",
971
+ "description": "The value observed, e.g. parameter:email or binding:options."
972
+ },
973
+ "shapes": {
974
+ "type": "array",
975
+ "items": {
976
+ "type": "object",
977
+ "required": [
978
+ "shape",
979
+ "count"
980
+ ],
981
+ "properties": {
982
+ "shape": {
983
+ "type": "string",
984
+ "description": "A value-free category, e.g. undefined, string:empty:empty, array:few."
985
+ },
986
+ "count": {
987
+ "type": "integer",
988
+ "minimum": 0
989
+ }
990
+ }
991
+ }
992
+ }
993
+ }
994
+ }
995
+ },
996
+ "valuesOmitted": {
997
+ "type": "integer",
998
+ "minimum": 0
999
+ }
1000
+ }
1001
+ }
1002
+ }
1003
+ }
1004
+ },
1005
+ "planning": {
1006
+ "description": "Incident planning; null when it did not run for this change.",
1007
+ "oneOf": [
1008
+ {
1009
+ "type": "null"
1010
+ },
1011
+ {
1012
+ "type": "object",
1013
+ "required": [
1014
+ "groups",
1015
+ "unresolved",
1016
+ "ideas"
1017
+ ],
1018
+ "properties": {
1019
+ "groups": {
1020
+ "description": "Behavior groups of the change, each with the failure patterns selected for it.",
1021
+ "type": "array",
1022
+ "items": {
1023
+ "type": "object",
1024
+ "required": [
1025
+ "id",
1026
+ "changeKeys",
1027
+ "patterns"
1028
+ ],
1029
+ "properties": {
1030
+ "id": {
1031
+ "type": "string"
1032
+ },
1033
+ "changeKeys": {
1034
+ "type": "array",
1035
+ "items": {
1036
+ "type": "string"
1037
+ }
1038
+ },
1039
+ "patterns": {
1040
+ "type": "array",
1041
+ "items": {
1042
+ "type": "object",
1043
+ "required": [
1044
+ "entryId",
1045
+ "mechanism",
1046
+ "symptom"
1047
+ ],
1048
+ "properties": {
1049
+ "entryId": {
1050
+ "type": "string"
1051
+ },
1052
+ "mechanism": {
1053
+ "type": "string"
1054
+ },
1055
+ "symptom": {
1056
+ "type": "string"
1057
+ }
1058
+ }
1059
+ }
1060
+ }
1061
+ }
1062
+ }
1063
+ },
1064
+ "unresolved": {
1065
+ "description": "Changes no behavior group holds, and why.",
1066
+ "type": "array",
1067
+ "items": {
1068
+ "type": "object",
1069
+ "required": [
1070
+ "changeKey",
1071
+ "reason"
1072
+ ],
1073
+ "properties": {
1074
+ "changeKey": {
1075
+ "type": "string"
1076
+ },
1077
+ "reason": {
1078
+ "type": "string"
1079
+ }
1080
+ }
1081
+ }
1082
+ },
1083
+ "ideas": {
1084
+ "description": "Haystack's own ideas: the selected situations, in plan order (at most 64). Every crawl explores them; pass the ones you want first, and your own, to `haystack verify --idea`.",
1085
+ "type": "array",
1086
+ "maxItems": 64,
1087
+ "items": {
1088
+ "type": "object",
1089
+ "required": [
1090
+ "id",
1091
+ "groupId",
1092
+ "pattern",
1093
+ "why",
1094
+ "failure",
1095
+ "setup",
1096
+ "exercise",
1097
+ "watch",
1098
+ "start"
1099
+ ],
1100
+ "properties": {
1101
+ "id": {
1102
+ "type": "string"
1103
+ },
1104
+ "groupId": {
1105
+ "type": "string"
1106
+ },
1107
+ "pattern": {
1108
+ "type": "string",
1109
+ "description": "The failure pattern's library id."
1110
+ },
1111
+ "why": {
1112
+ "type": "string",
1113
+ "description": "How that pattern could arise in this code."
1114
+ },
1115
+ "failure": {
1116
+ "type": "string",
1117
+ "description": "What would go wrong."
1118
+ },
1119
+ "setup": {
1120
+ "type": "array",
1121
+ "items": {
1122
+ "type": "string"
1123
+ },
1124
+ "description": "What must be set up or true first."
1125
+ },
1126
+ "exercise": {
1127
+ "type": "string",
1128
+ "description": "What to do."
1129
+ },
1130
+ "watch": {
1131
+ "type": "string",
1132
+ "description": "What to watch."
1133
+ },
1134
+ "start": {
1135
+ "type": "string",
1136
+ "description": "Where it starts: the start screen, or a prepared start."
1137
+ }
1138
+ }
1139
+ }
1140
+ }
1141
+ }
1142
+ }
1143
+ ]
1144
+ }
1145
+ }
1146
+ },
1147
+ "captureWindow": {
1148
+ "type": "object",
1149
+ "required": [
1150
+ "applicationId",
1151
+ "days",
1152
+ "newestHour",
1153
+ "ageHours",
1154
+ "stale",
1155
+ "sessions",
1156
+ "routes",
1157
+ "union",
1158
+ "unmapped",
1159
+ "releasesWithoutManifest",
1160
+ "dropped"
1161
+ ],
1162
+ "properties": {
1163
+ "applicationId": {
1164
+ "type": "string"
1165
+ },
1166
+ "days": {
1167
+ "description": "The UTC days the window covers, oldest first.",
1168
+ "type": "array",
1169
+ "items": {
1170
+ "type": "string"
1171
+ }
1172
+ },
1173
+ "newestHour": {
1174
+ "description": "The newest receipt hour holding events, yyyy-mm-ddThh (UTC).",
1175
+ "oneOf": [
1176
+ {
1177
+ "type": "null"
1178
+ },
1179
+ {
1180
+ "type": "string"
1181
+ }
1182
+ ]
1183
+ },
1184
+ "ageHours": {
1185
+ "oneOf": [
1186
+ {
1187
+ "type": "null"
1188
+ },
1189
+ {
1190
+ "type": "number",
1191
+ "minimum": 0
1192
+ }
1193
+ ]
1194
+ },
1195
+ "stale": {
1196
+ "description": "Older than 24 hours, or no data.",
1197
+ "type": "boolean"
1198
+ },
1199
+ "sessions": {
1200
+ "description": "Distinct captured sessions in the window.",
1201
+ "type": "integer",
1202
+ "minimum": 0
1203
+ },
1204
+ "routes": {
1205
+ "description": "The changed routes, most sessions first.",
1206
+ "type": "array",
1207
+ "items": {
1208
+ "type": "object",
1209
+ "required": [
1210
+ "route",
1211
+ "match",
1212
+ "source",
1213
+ "sessions",
1214
+ "share"
1215
+ ],
1216
+ "properties": {
1217
+ "route": {
1218
+ "description": "The route id from the app's route manifest.",
1219
+ "type": "string"
1220
+ },
1221
+ "match": {
1222
+ "description": "Its match rule, in the framework adapter's syntax.",
1223
+ "type": "string"
1224
+ },
1225
+ "source": {
1226
+ "description": "The repository file that defines it.",
1227
+ "type": "string"
1228
+ },
1229
+ "sessions": {
1230
+ "type": "integer",
1231
+ "minimum": 0
1232
+ },
1233
+ "share": {
1234
+ "oneOf": [
1235
+ {
1236
+ "type": "null"
1237
+ },
1238
+ {
1239
+ "type": "number",
1240
+ "minimum": 0,
1241
+ "maximum": 1
1242
+ }
1243
+ ]
1244
+ }
1245
+ }
1246
+ }
1247
+ },
1248
+ "union": {
1249
+ "description": "Sessions that visited at least one changed route (exact, not a sum).",
1250
+ "type": "object",
1251
+ "required": [
1252
+ "sessions",
1253
+ "share"
1254
+ ],
1255
+ "properties": {
1256
+ "sessions": {
1257
+ "type": "integer",
1258
+ "minimum": 0
1259
+ },
1260
+ "share": {
1261
+ "oneOf": [
1262
+ {
1263
+ "type": "null"
1264
+ },
1265
+ {
1266
+ "type": "number",
1267
+ "minimum": 0,
1268
+ "maximum": 1
1269
+ }
1270
+ ]
1271
+ }
1272
+ }
1273
+ },
1274
+ "unmapped": {
1275
+ "description": "Sessions on pages no route names: unknown whether they reach the change.",
1276
+ "oneOf": [
1277
+ {
1278
+ "type": "null"
1279
+ },
1280
+ {
1281
+ "type": "object",
1282
+ "required": [
1283
+ "sessions",
1284
+ "share"
1285
+ ],
1286
+ "properties": {
1287
+ "sessions": {
1288
+ "type": "integer",
1289
+ "minimum": 0
1290
+ },
1291
+ "share": {
1292
+ "oneOf": [
1293
+ {
1294
+ "type": "null"
1295
+ },
1296
+ {
1297
+ "type": "number",
1298
+ "minimum": 0,
1299
+ "maximum": 1
1300
+ }
1301
+ ]
1302
+ }
1303
+ }
1304
+ }
1305
+ ]
1306
+ },
1307
+ "releasesWithoutManifest": {
1308
+ "description": "Releases whose route manifest Haystack does not hold; their pages are unmapped.",
1309
+ "type": "array",
1310
+ "items": {
1311
+ "type": "string"
1312
+ }
1313
+ },
1314
+ "dropped": {
1315
+ "description": "Events dropped at ingest in the window, per reason.",
1316
+ "type": "object",
1317
+ "additionalProperties": {
1318
+ "type": "integer",
1319
+ "minimum": 0
1320
+ }
1321
+ }
1322
+ }
653
1323
  }
654
1324
  }
655
1325
  }