@peasant-labs/schema 0.48.0 → 0.49.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.
@@ -103,6 +103,126 @@ export interface paths {
103
103
  patch?: never;
104
104
  trace?: never;
105
105
  };
106
+ "/api/v1/kickstart/sessions": {
107
+ parameters: {
108
+ query?: never;
109
+ header?: never;
110
+ path?: never;
111
+ cookie?: never;
112
+ };
113
+ get?: never;
114
+ put?: never;
115
+ /** @description Open or join the live session for scope. full is the wizard and selection is the selection page. The same scope returns the same id and revision; the other scope returns a different session and leaves the first untouched. The response is the reconnect snapshot, so the page needs no second read. A scope other than full or selection is 400 and changes nothing. Returns 403 with a JSON error, and changes nothing, when the request did not come from this local server: its Host header does not name a loopback address, or a browser sent it from another origin. */
116
+ post: operations["openKickstartSession"];
117
+ delete?: never;
118
+ options?: never;
119
+ head?: never;
120
+ patch?: never;
121
+ trace?: never;
122
+ };
123
+ "/api/v1/kickstart/sessions/{id}": {
124
+ parameters: {
125
+ query?: never;
126
+ header?: never;
127
+ path?: never;
128
+ cookie?: never;
129
+ };
130
+ /** @description Read one session snapshot for reconnect. The forest is not in this body; load it from the tree route. 404 when no session has this id. */
131
+ get: operations["getKickstartSession"];
132
+ put?: never;
133
+ post?: never;
134
+ delete?: never;
135
+ options?: never;
136
+ head?: never;
137
+ /** @description Apply one stop's answers, the tree's selected ids, conflict resolutions, or the connect offer. revision is the session revision the caller last rendered. A stale write is applied and reported in the body; it is not a separate status. A stale result may carry no overwritten entries when no answered field changed after that revision. 400 when the body is not valid, and 404 when no session has this id. Returns 403 with a JSON error, and changes nothing, when the request did not come from this local server: its Host header does not name a loopback address, or a browser sent it from another origin. */
138
+ patch: operations["patchKickstartSession"];
139
+ trace?: never;
140
+ };
141
+ "/api/v1/kickstart/sessions/{id}/commit": {
142
+ parameters: {
143
+ query?: never;
144
+ header?: never;
145
+ path?: never;
146
+ cookie?: never;
147
+ };
148
+ get?: never;
149
+ put?: never;
150
+ /** @description Recompute, merge, swap the configuration, write retention, and start the import. 409 returns the mine/theirs rows and writes nothing. The success body carries the finish actions and the ingest state; it does not install a hook and has no reset control. 404 when no session has this id. Returns 403 with a JSON error, and changes nothing, when the request did not come from this local server: its Host header does not name a loopback address, or a browser sent it from another origin. */
151
+ post: operations["commitKickstartSession"];
152
+ delete?: never;
153
+ options?: never;
154
+ head?: never;
155
+ patch?: never;
156
+ trace?: never;
157
+ };
158
+ "/api/v1/kickstart/sessions/{id}/scan": {
159
+ parameters: {
160
+ query?: never;
161
+ header?: never;
162
+ path?: never;
163
+ cookie?: never;
164
+ };
165
+ get?: never;
166
+ put?: never;
167
+ /** @description Rescan the filesystem for one session. Progress is pushed on the kickstart topic; this response is the scan state at accept. The forest is not in the response. 404 when no session has this id. Returns 403 with a JSON error, and changes nothing, when the request did not come from this local server: its Host header does not name a loopback address, or a browser sent it from another origin. */
168
+ post: operations["scanKickstartSession"];
169
+ delete?: never;
170
+ options?: never;
171
+ head?: never;
172
+ patch?: never;
173
+ trace?: never;
174
+ };
175
+ "/api/v1/kickstart/sessions/{id}/tree": {
176
+ parameters: {
177
+ query?: never;
178
+ header?: never;
179
+ path?: never;
180
+ cookie?: never;
181
+ };
182
+ /** @description Read the whole selection forest for one session. Each node carries the server-computed state. locked is a boolean, not a fourth state. The response has no page, cursor, or limit. 404 when no session has this id. */
183
+ get: operations["getKickstartTree"];
184
+ put?: never;
185
+ post?: never;
186
+ delete?: never;
187
+ options?: never;
188
+ head?: never;
189
+ patch?: never;
190
+ trace?: never;
191
+ };
192
+ "/api/v1/kickstart/sessions/{id}/tree/{nodeId}/preview": {
193
+ parameters: {
194
+ query?: never;
195
+ header?: never;
196
+ path?: never;
197
+ cookie?: never;
198
+ };
199
+ /** @description Read the bounded typed preview lines for one forest row. 404 when the session or the row does not exist. */
200
+ get: operations["getKickstartPreview"];
201
+ put?: never;
202
+ post?: never;
203
+ delete?: never;
204
+ options?: never;
205
+ head?: never;
206
+ patch?: never;
207
+ trace?: never;
208
+ };
209
+ "/api/v1/kickstart/status": {
210
+ parameters: {
211
+ query?: never;
212
+ header?: never;
213
+ path?: never;
214
+ cookie?: never;
215
+ };
216
+ /** @description Read the first-run redirect hook. configured is the only status flag. activeSessionId, when present, is the one full-scope session id; it is omitted when that session is not open. The response is not a session directory and has no per-scope map. */
217
+ get: operations["getKickstartStatus"];
218
+ put?: never;
219
+ post?: never;
220
+ delete?: never;
221
+ options?: never;
222
+ head?: never;
223
+ patch?: never;
224
+ trace?: never;
225
+ };
106
226
  "/api/v1/map/{projectHash}": {
107
227
  parameters: {
108
228
  query?: never;
@@ -733,6 +853,27 @@ export interface components {
733
853
  BestiaryHarness: Schema.Harness;
734
854
  ClientMessage: Schema.ClientMessage;
735
855
  DashboardPayload: Schema.DashboardPayload;
856
+ /**
857
+ * Kickstart Close Reason
858
+ * @description Why a kickstart session ended: committed or expired
859
+ * @example committed
860
+ * @example expired
861
+ * @enum {string}
862
+ */
863
+ LocalKickstartCloseReason: Schema.LocalKickstartCloseReason;
864
+ LocalKickstartEvent: Schema.LocalKickstartEvent;
865
+ /**
866
+ * Kickstart Event Kind
867
+ * @description Live kickstart topic discriminator. One event carries one session id
868
+ * @example session
869
+ * @example answers
870
+ * @example conflicts
871
+ * @example scan
872
+ * @example ingest
873
+ * @example closed
874
+ * @enum {string}
875
+ */
876
+ LocalKickstartEventKind: Schema.LocalKickstartEventKind;
736
877
  LocalSessionPage: Schema.LocalSessionPage;
737
878
  LocalSyncProjectOption: Schema.LocalSyncProjectOption;
738
879
  LocalSyncProjectOptions: Schema.LocalSyncProjectOptions;
@@ -872,6 +1013,7 @@ export interface components {
872
1013
  * @example quality
873
1014
  * @example annotations
874
1015
  * @example project_familiarity
1016
+ * @example kickstart
875
1017
  * @enum {string}
876
1018
  */
877
1019
  SchemaChannelTopic: Schema.ChannelTopic;
@@ -1175,6 +1317,146 @@ export interface components {
1175
1317
  SchemaLocalContributionHistoryResponse: Schema.LocalContributionHistoryResponse;
1176
1318
  SchemaLocalContributionTraversalConflict: Schema.LocalContributionTraversalConflict;
1177
1319
  SchemaLocalHelperMembersPayload: Schema.LocalHelperMembersPayload;
1320
+ SchemaLocalKickstartAnswers: Schema.LocalKickstartAnswers;
1321
+ SchemaLocalKickstartCommitRefusal: Schema.LocalKickstartCommitRefusal;
1322
+ SchemaLocalKickstartCommitted: Schema.LocalKickstartCommitted;
1323
+ SchemaLocalKickstartConflict: Schema.LocalKickstartConflict;
1324
+ SchemaLocalKickstartConnect: Schema.LocalKickstartConnect;
1325
+ /**
1326
+ * Kickstart Connect Answer
1327
+ * @description Boundary offer answer: accept or skip. accept requires village to be connected
1328
+ * @example accept
1329
+ * @example skip
1330
+ * @enum {string}
1331
+ */
1332
+ SchemaLocalKickstartConnectAnswer: Schema.LocalKickstartConnectAnswer;
1333
+ SchemaLocalKickstartDiff: Schema.LocalKickstartDiff;
1334
+ SchemaLocalKickstartDiffLine: Schema.LocalKickstartDiffLine;
1335
+ /**
1336
+ * Kickstart Diff Line Type
1337
+ * @description Structured config-diff line: add, del, or ctx
1338
+ * @example add
1339
+ * @example del
1340
+ * @example ctx
1341
+ * @enum {string}
1342
+ */
1343
+ SchemaLocalKickstartDiffLineType: Schema.LocalKickstartDiffLineType;
1344
+ SchemaLocalKickstartField: Schema.LocalKickstartField;
1345
+ /**
1346
+ * Kickstart Field Kind
1347
+ * @description Control shape of one kickstart field
1348
+ * @example toggle
1349
+ * @example choice
1350
+ * @example action
1351
+ * @example tree
1352
+ * @example notice
1353
+ * @enum {string}
1354
+ */
1355
+ SchemaLocalKickstartFieldKind: Schema.LocalKickstartFieldKind;
1356
+ SchemaLocalKickstartGuide: Schema.LocalKickstartGuide;
1357
+ SchemaLocalKickstartHunk: Schema.LocalKickstartHunk;
1358
+ SchemaLocalKickstartIngest: Schema.LocalKickstartIngest;
1359
+ /**
1360
+ * Kickstart Ingest State
1361
+ * @description Import state pushed on the kickstart topic
1362
+ * @example idle
1363
+ * @example running
1364
+ * @example busy
1365
+ * @example failed
1366
+ * @enum {string}
1367
+ */
1368
+ SchemaLocalKickstartIngestState: Schema.LocalKickstartIngestState;
1369
+ SchemaLocalKickstartLine: Schema.LocalKickstartLine;
1370
+ /**
1371
+ * Kickstart Line Kind
1372
+ * @description Typed preview or example line
1373
+ * @example text
1374
+ * @example label
1375
+ * @example before
1376
+ * @example after
1377
+ * @example spacer
1378
+ * @enum {string}
1379
+ */
1380
+ SchemaLocalKickstartLineKind: Schema.LocalKickstartLineKind;
1381
+ /**
1382
+ * Kickstart Next Step
1383
+ * @description One finish action. auto-publish-settings links to the settings section; it does not install a hook
1384
+ * @example config
1385
+ * @example web-start
1386
+ * @example village-login
1387
+ * @example village-push
1388
+ * @example auto-publish-settings
1389
+ * @enum {string}
1390
+ */
1391
+ SchemaLocalKickstartNextStep: Schema.LocalKickstartNextStep;
1392
+ SchemaLocalKickstartNode: Schema.LocalKickstartNode;
1393
+ /**
1394
+ * Kickstart Node Kind
1395
+ * @description Row kind in the selection forest
1396
+ * @example project
1397
+ * @example group
1398
+ * @example branch
1399
+ * @example session
1400
+ * @enum {string}
1401
+ */
1402
+ SchemaLocalKickstartNodeKind: Schema.LocalKickstartNodeKind;
1403
+ /**
1404
+ * Kickstart Node State
1405
+ * @description Server-computed selection of one forest row: none, some, or all. locked is a boolean, not a state
1406
+ * @example none
1407
+ * @example some
1408
+ * @example all
1409
+ * @enum {string}
1410
+ */
1411
+ SchemaLocalKickstartNodeState: Schema.LocalKickstartNodeState;
1412
+ SchemaLocalKickstartOpenRequest: Schema.LocalKickstartOpenRequest;
1413
+ SchemaLocalKickstartOption: Schema.LocalKickstartOption;
1414
+ SchemaLocalKickstartOverwrite: Schema.LocalKickstartOverwrite;
1415
+ SchemaLocalKickstartPatchResult: Schema.LocalKickstartPatchResult;
1416
+ SchemaLocalKickstartPreview: Schema.LocalKickstartPreview;
1417
+ /**
1418
+ * Kickstart Resolution
1419
+ * @description Which side of one conflict row to keep: mine is the draft, theirs is the file
1420
+ * @example mine
1421
+ * @example theirs
1422
+ * @enum {string}
1423
+ */
1424
+ SchemaLocalKickstartResolution: Schema.LocalKickstartResolution;
1425
+ SchemaLocalKickstartScan: Schema.LocalKickstartScan;
1426
+ /**
1427
+ * Kickstart Scan State
1428
+ * @description Discovery job state pushed on the kickstart topic
1429
+ * @example idle
1430
+ * @example running
1431
+ * @example done
1432
+ * @example error
1433
+ * @enum {string}
1434
+ */
1435
+ SchemaLocalKickstartScanState: Schema.LocalKickstartScanState;
1436
+ /**
1437
+ * Kickstart Scope
1438
+ * @description Answer set a kickstart session collects: the whole wizard, or the selection page
1439
+ * @example full
1440
+ * @example selection
1441
+ * @enum {string}
1442
+ */
1443
+ SchemaLocalKickstartScope: Schema.LocalKickstartScope;
1444
+ SchemaLocalKickstartSession: Schema.LocalKickstartSession;
1445
+ SchemaLocalKickstartStatus: Schema.LocalKickstartStatus;
1446
+ SchemaLocalKickstartStop: Schema.LocalKickstartStop;
1447
+ /**
1448
+ * Kickstart Stop Kind
1449
+ * @description Layout of one kickstart stop
1450
+ * @example connection
1451
+ * @example config
1452
+ * @example review
1453
+ * @example ingest
1454
+ * @enum {string}
1455
+ */
1456
+ SchemaLocalKickstartStopKind: Schema.LocalKickstartStopKind;
1457
+ SchemaLocalKickstartSummary: Schema.LocalKickstartSummary;
1458
+ SchemaLocalKickstartTree: Schema.LocalKickstartTree;
1459
+ SchemaLocalKickstartVillage: Schema.LocalKickstartVillage;
1178
1460
  SchemaLocalOperationDiagnostic: Schema.LocalOperationDiagnostic;
1179
1461
  /**
1180
1462
  * Local Operation Diagnostic Outcome
@@ -1266,6 +1548,7 @@ export interface components {
1266
1548
  * @example project_familiarity
1267
1549
  * @example connected
1268
1550
  * @example error
1551
+ * @example kickstart
1269
1552
  * @enum {string}
1270
1553
  */
1271
1554
  SchemaMessageType: Schema.MessageType;
@@ -2031,6 +2314,311 @@ export interface operations {
2031
2314
  };
2032
2315
  };
2033
2316
  };
2317
+ openKickstartSession: {
2318
+ parameters: {
2319
+ query?: never;
2320
+ header?: never;
2321
+ path?: never;
2322
+ cookie?: never;
2323
+ };
2324
+ requestBody: {
2325
+ content: {
2326
+ "application/json": components["schemas"]["SchemaLocalKickstartOpenRequest"];
2327
+ };
2328
+ };
2329
+ responses: {
2330
+ /** @description OK */
2331
+ 200: {
2332
+ headers: {
2333
+ [name: string]: unknown;
2334
+ };
2335
+ content: {
2336
+ "application/json": components["schemas"]["SchemaLocalKickstartSession"];
2337
+ };
2338
+ };
2339
+ /** @description Bad Request */
2340
+ 400: {
2341
+ headers: {
2342
+ [name: string]: unknown;
2343
+ };
2344
+ content: {
2345
+ "application/json": components["schemas"]["OpenapiLocalErrorResponse"];
2346
+ };
2347
+ };
2348
+ /** @description Forbidden */
2349
+ 403: {
2350
+ headers: {
2351
+ [name: string]: unknown;
2352
+ };
2353
+ content: {
2354
+ "application/json": components["schemas"]["OpenapiLocalErrorResponse"];
2355
+ };
2356
+ };
2357
+ };
2358
+ };
2359
+ getKickstartSession: {
2360
+ parameters: {
2361
+ query?: never;
2362
+ header?: never;
2363
+ path: {
2364
+ /** @description Kickstart session id */
2365
+ id: string;
2366
+ };
2367
+ cookie?: never;
2368
+ };
2369
+ requestBody?: never;
2370
+ responses: {
2371
+ /** @description OK */
2372
+ 200: {
2373
+ headers: {
2374
+ [name: string]: unknown;
2375
+ };
2376
+ content: {
2377
+ "application/json": components["schemas"]["SchemaLocalKickstartSession"];
2378
+ };
2379
+ };
2380
+ /** @description Not Found */
2381
+ 404: {
2382
+ headers: {
2383
+ [name: string]: unknown;
2384
+ };
2385
+ content: {
2386
+ "application/json": components["schemas"]["OpenapiLocalErrorResponse"];
2387
+ };
2388
+ };
2389
+ };
2390
+ };
2391
+ patchKickstartSession: {
2392
+ parameters: {
2393
+ query?: never;
2394
+ header?: never;
2395
+ path: {
2396
+ /** @description Kickstart session id */
2397
+ id: string;
2398
+ };
2399
+ cookie?: never;
2400
+ };
2401
+ requestBody: {
2402
+ content: {
2403
+ "application/json": components["schemas"]["SchemaLocalKickstartAnswers"];
2404
+ };
2405
+ };
2406
+ responses: {
2407
+ /** @description OK */
2408
+ 200: {
2409
+ headers: {
2410
+ [name: string]: unknown;
2411
+ };
2412
+ content: {
2413
+ "application/json": components["schemas"]["SchemaLocalKickstartPatchResult"];
2414
+ };
2415
+ };
2416
+ /** @description Bad Request */
2417
+ 400: {
2418
+ headers: {
2419
+ [name: string]: unknown;
2420
+ };
2421
+ content: {
2422
+ "application/json": components["schemas"]["OpenapiLocalErrorResponse"];
2423
+ };
2424
+ };
2425
+ /** @description Forbidden */
2426
+ 403: {
2427
+ headers: {
2428
+ [name: string]: unknown;
2429
+ };
2430
+ content: {
2431
+ "application/json": components["schemas"]["OpenapiLocalErrorResponse"];
2432
+ };
2433
+ };
2434
+ /** @description Not Found */
2435
+ 404: {
2436
+ headers: {
2437
+ [name: string]: unknown;
2438
+ };
2439
+ content: {
2440
+ "application/json": components["schemas"]["OpenapiLocalErrorResponse"];
2441
+ };
2442
+ };
2443
+ };
2444
+ };
2445
+ commitKickstartSession: {
2446
+ parameters: {
2447
+ query?: never;
2448
+ header?: never;
2449
+ path: {
2450
+ /** @description Kickstart session id */
2451
+ id: string;
2452
+ };
2453
+ cookie?: never;
2454
+ };
2455
+ requestBody?: never;
2456
+ responses: {
2457
+ /** @description OK */
2458
+ 200: {
2459
+ headers: {
2460
+ [name: string]: unknown;
2461
+ };
2462
+ content: {
2463
+ "application/json": components["schemas"]["SchemaLocalKickstartCommitted"];
2464
+ };
2465
+ };
2466
+ /** @description Forbidden */
2467
+ 403: {
2468
+ headers: {
2469
+ [name: string]: unknown;
2470
+ };
2471
+ content: {
2472
+ "application/json": components["schemas"]["OpenapiLocalErrorResponse"];
2473
+ };
2474
+ };
2475
+ /** @description Not Found */
2476
+ 404: {
2477
+ headers: {
2478
+ [name: string]: unknown;
2479
+ };
2480
+ content: {
2481
+ "application/json": components["schemas"]["OpenapiLocalErrorResponse"];
2482
+ };
2483
+ };
2484
+ /** @description Conflict */
2485
+ 409: {
2486
+ headers: {
2487
+ [name: string]: unknown;
2488
+ };
2489
+ content: {
2490
+ "application/json": components["schemas"]["SchemaLocalKickstartCommitRefusal"];
2491
+ };
2492
+ };
2493
+ };
2494
+ };
2495
+ scanKickstartSession: {
2496
+ parameters: {
2497
+ query?: never;
2498
+ header?: never;
2499
+ path: {
2500
+ /** @description Kickstart session id */
2501
+ id: string;
2502
+ };
2503
+ cookie?: never;
2504
+ };
2505
+ requestBody?: never;
2506
+ responses: {
2507
+ /** @description OK */
2508
+ 200: {
2509
+ headers: {
2510
+ [name: string]: unknown;
2511
+ };
2512
+ content: {
2513
+ "application/json": components["schemas"]["SchemaLocalKickstartScan"];
2514
+ };
2515
+ };
2516
+ /** @description Forbidden */
2517
+ 403: {
2518
+ headers: {
2519
+ [name: string]: unknown;
2520
+ };
2521
+ content: {
2522
+ "application/json": components["schemas"]["OpenapiLocalErrorResponse"];
2523
+ };
2524
+ };
2525
+ /** @description Not Found */
2526
+ 404: {
2527
+ headers: {
2528
+ [name: string]: unknown;
2529
+ };
2530
+ content: {
2531
+ "application/json": components["schemas"]["OpenapiLocalErrorResponse"];
2532
+ };
2533
+ };
2534
+ };
2535
+ };
2536
+ getKickstartTree: {
2537
+ parameters: {
2538
+ query?: never;
2539
+ header?: never;
2540
+ path: {
2541
+ /** @description Kickstart session id */
2542
+ id: string;
2543
+ };
2544
+ cookie?: never;
2545
+ };
2546
+ requestBody?: never;
2547
+ responses: {
2548
+ /** @description OK */
2549
+ 200: {
2550
+ headers: {
2551
+ [name: string]: unknown;
2552
+ };
2553
+ content: {
2554
+ "application/json": components["schemas"]["SchemaLocalKickstartTree"];
2555
+ };
2556
+ };
2557
+ /** @description Not Found */
2558
+ 404: {
2559
+ headers: {
2560
+ [name: string]: unknown;
2561
+ };
2562
+ content: {
2563
+ "application/json": components["schemas"]["OpenapiLocalErrorResponse"];
2564
+ };
2565
+ };
2566
+ };
2567
+ };
2568
+ getKickstartPreview: {
2569
+ parameters: {
2570
+ query?: never;
2571
+ header?: never;
2572
+ path: {
2573
+ /** @description Kickstart session id */
2574
+ id: string;
2575
+ /** @description Forest row id */
2576
+ nodeId: string;
2577
+ };
2578
+ cookie?: never;
2579
+ };
2580
+ requestBody?: never;
2581
+ responses: {
2582
+ /** @description OK */
2583
+ 200: {
2584
+ headers: {
2585
+ [name: string]: unknown;
2586
+ };
2587
+ content: {
2588
+ "application/json": components["schemas"]["SchemaLocalKickstartPreview"];
2589
+ };
2590
+ };
2591
+ /** @description Not Found */
2592
+ 404: {
2593
+ headers: {
2594
+ [name: string]: unknown;
2595
+ };
2596
+ content: {
2597
+ "application/json": components["schemas"]["OpenapiLocalErrorResponse"];
2598
+ };
2599
+ };
2600
+ };
2601
+ };
2602
+ getKickstartStatus: {
2603
+ parameters: {
2604
+ query?: never;
2605
+ header?: never;
2606
+ path?: never;
2607
+ cookie?: never;
2608
+ };
2609
+ requestBody?: never;
2610
+ responses: {
2611
+ /** @description OK */
2612
+ 200: {
2613
+ headers: {
2614
+ [name: string]: unknown;
2615
+ };
2616
+ content: {
2617
+ "application/json": components["schemas"]["SchemaLocalKickstartStatus"];
2618
+ };
2619
+ };
2620
+ };
2621
+ };
2034
2622
  getMapGraph: {
2035
2623
  parameters: {
2036
2624
  query?: {