-
Notifications
You must be signed in to change notification settings - Fork 2
Expand file tree
/
Copy pathclass-wp-codebox-api.php
More file actions
698 lines (632 loc) · 37.3 KB
/
Copy pathclass-wp-codebox-api.php
File metadata and controls
698 lines (632 loc) · 37.3 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
<?php
/**
* Public PHP facade for WP Codebox consumers.
*
* @package WPCodebox
*/
defined( 'ABSPATH' ) || exit;
/**
* Stable PHP facade over WP Codebox consumer operations.
*/
final class WP_Codebox_API {
private const RUNTIME_DESCRIPTOR_SCHEMA = 'wp-codebox/runtime-descriptor/v1';
private const RUNTIME_CONTRACT_MANIFEST_SCHEMA = 'wp-codebox/runtime-contract-manifest/v1';
private const WORDPRESS_FUZZ_RUNTIME_CONTRACT_SCHEMA = 'wp-codebox/wordpress-fuzz-runtime-contract/v1';
/** @var string[] */
private const PUBLIC_RUNTIME_CAPABILITIES = array(
'agent-task:run',
'agent-task:batch',
'agent-task:fanout',
'runtime-package:run',
'runtime-requirements:resolve',
'wordpress-runtime:workload',
'wordpress-runtime:fuzz-suite',
'contract-manifest:read',
);
public const ABILITY_LIST_ARTIFACTS = 'wp-codebox/list-artifacts';
public const ABILITY_GET_ARTIFACT = 'wp-codebox/get-artifact';
public const ABILITY_INSPECT_ARTIFACT = 'wp-codebox/inspect-artifact';
public const ABILITY_APPLY_ARTIFACT_PREFLIGHT = 'wp-codebox/apply-artifact-preflight';
public const ABILITY_STAGE_ARTIFACT_APPLY = 'wp-codebox/stage-artifact-apply';
public const ABILITY_APPLY_APPROVED_ARTIFACT = 'wp-codebox/apply-approved-artifact';
public const ARTIFACT_SCHEMA = 'wp-codebox/artifact/v1';
public const ARTIFACT_INSPECTION_SCHEMA = 'wp-codebox/artifact-inspection/v1';
public const ARTIFACT_APPLY_PREFLIGHT_SCHEMA = 'wp-codebox/artifact-apply-preflight/v1';
public const ARTIFACT_APPLY_SCHEMA = 'wp-codebox/artifact-apply/v1';
public const ARTIFACT_APPLY_RESULT_SCHEMA = 'wp-codebox/apply-result/v1';
/** @var array<string,string> */
private const ABILITY_METHODS = array(
'wp-codebox/runtime-descriptor' => 'runtime_descriptor',
'wp-codebox/wordpress-fuzz-runtime-contract' => 'wordpress_fuzz_runtime_contract',
'wp-codebox/run-agent-task' => 'run_agent_task',
'wp-codebox/run-agent-task-batch' => 'run_agent_task_batch',
'wp-codebox/run-agent-task-fanout' => 'run_agent_task_fanout',
'wp-codebox/run-runtime-task' => 'run_runtime_task',
'wp-codebox/run-wordpress-workload' => 'run_wordpress_workload',
'wp-codebox/run-runtime-package' => 'run_runtime_package',
'wp-codebox/resolve-runtime-requirements' => 'resolve_runtime_requirements',
'wp-codebox/run-fuzz-suite' => 'run_fuzz_suite',
'wp-codebox/create-browser-playground-session' => 'create_browser_session',
'wp-codebox/create-browser-task-contract' => 'create_browser_task_contract',
'wp-codebox/create-browser-materializer-contract' => 'create_browser_materializer_contract',
'wp-codebox/create-browser-contained-site-session' => 'create_browser_contained_site_session',
'wp-codebox/get-browser-contained-site-status' => 'browser_contained_site_status',
'wp-codebox/preview-reuse-decision' => 'preview_reuse_decision',
'wp-codebox/open-browser-contained-site' => 'open_browser_session',
'wp-codebox/open-or-create-browser-contained-site' => 'open_or_create_browser_contained_site',
'wp-codebox/snapshot-browser-contained-site' => 'snapshot_browser_contained_site',
'wp-codebox/export-browser-contained-site' => 'export_browser_contained_site',
'wp-codebox/plan-browser-contained-site-apply' => 'plan_browser_contained_site_apply',
'wp-codebox/apply-browser-contained-site-plan' => 'apply_browser_contained_site_plan',
'wp-codebox/browser-contained-site-sync-delegation' => 'browser_contained_site_sync_delegation',
'wp-codebox/browser-contained-site-sync-source-connect' => 'browser_contained_site_sync_source_connect',
'wp-codebox/browser-contained-site-sync-manifest' => 'browser_contained_site_sync_manifest',
'wp-codebox/browser-contained-site-sync-export' => 'browser_contained_site_sync_export',
'wp-codebox/browser-contained-site-sync-apply-plan-generate' => 'browser_contained_site_sync_apply_plan_generate',
'wp-codebox/browser-contained-site-sync-apply-plan-validate' => 'browser_contained_site_sync_apply_plan_validate',
'wp-codebox/browser-contained-site-sync-apply' => 'browser_contained_site_sync_apply',
'wp-codebox/request-host-delegation' => 'request_host_delegation',
self::ABILITY_LIST_ARTIFACTS => 'list_artifacts',
self::ABILITY_GET_ARTIFACT => 'get_artifact',
self::ABILITY_INSPECT_ARTIFACT => 'inspect_artifact',
'wp-codebox/normalize-browser-artifact-bundle' => 'normalize_artifact_bundle',
'wp-codebox/persist-browser-artifact' => 'persist_artifact',
'wp-codebox/import-artifact-bundle' => 'import_artifact',
'wp-codebox/reimport-artifact-bundle' => 'reimport_artifact',
self::ABILITY_APPLY_ARTIFACT_PREFLIGHT => 'preflight_artifact_apply',
self::ABILITY_STAGE_ARTIFACT_APPLY => 'stage_artifact_apply',
self::ABILITY_APPLY_APPROVED_ARTIFACT => 'apply_approved_artifact',
'wp-codebox/runner-workspace-prepare' => 'prepare_runner_workspace',
'wp-codebox/runner-workspace-capture' => 'capture_runner_workspace',
'wp-codebox/runner-workspace-command' => 'run_runner_workspace_command',
'wp-codebox/runner-workspace-publish' => 'publish_runner_workspace',
);
/** @param array<string,mixed> $input Ignored descriptor input. @return array<string,mixed> */
public static function runtime_descriptor( array $input = array() ): array {
unset( $input );
return array(
'schema' => self::RUNTIME_DESCRIPTOR_SCHEMA,
'version' => 1,
'runtime' => array(
'id' => 'wp-codebox',
'name' => 'WP Codebox',
),
'readiness' => array(
'status' => 'available',
'publicApi' => true,
'contractManifest' => true,
),
'capabilities' => self::PUBLIC_RUNTIME_CAPABILITIES,
'abilities' => self::runtime_abilities(),
'wordpressFuzzRuntimeContract' => self::wordpress_fuzz_runtime_contract(),
'contractManifest' => self::runtime_contract_manifest(),
);
}
/** @param array<string,mixed> $input Ignored descriptor input. @return array<string,mixed> */
public static function wordpress_fuzz_runtime_contract( array $input = array() ): array {
unset( $input );
return array(
'schema' => self::WORDPRESS_FUZZ_RUNTIME_CONTRACT_SCHEMA,
'version' => 1,
'runtime' => array(
'id' => 'wp-codebox',
'environment' => 'wordpress',
),
'publicSurfaces' => array(
'phpFacade' => 'WP_Codebox_API::wordpress_fuzz_runtime_contract()',
'ability' => 'wp-codebox/run-fuzz-suite',
'wpCli' => 'wp codebox wordpress-fuzz-runtime-contract',
'nodeCli' => 'wp-codebox fuzz descriptor --format=json',
'typescript' => '@automattic/wp-codebox-core/contracts',
),
'actionFamilies' => array(
array(
'id' => 'ability-http-rest-read',
'label' => 'Ability, HTTP, and REST read coverage',
'targetKinds' => array( 'ability', 'http', 'rest' ),
'runtimeActionTypes' => array(),
'commands' => array( 'wordpress.ability', 'wordpress.http-request', 'wordpress.rest-request' ),
'mutationIntents' => array( 'read' ),
'supported' => true,
),
array(
'id' => 'runtime-browser-admin',
'label' => 'Runtime browser, admin page, editor, and page coverage',
'targetKinds' => array( 'runtime', 'runtime-action' ),
'runtimeActionTypes' => array( 'admin_page', 'browser', 'browser_probe', 'editor_open', 'page', 'random_walk', 'sequence' ),
'commands' => array( 'wordpress.browser-actions', 'wordpress.browser-page-load', 'wordpress.browser-probe', 'wordpress.editor-open', 'wordpress.fuzz-admin-pages', 'wordpress.page', 'wordpress.simulated-admin-page-load', 'wordpress.simulated-frontend-page-load' ),
'mutationIntents' => array( 'read', 'write' ),
'supported' => true,
),
array(
'id' => 'runtime-wordpress-operations',
'label' => 'WordPress CLI, PHP, REST, CRUD, and database operation coverage',
'targetKinds' => array( 'command', 'runtime', 'runtime-action' ),
'runtimeActionTypes' => array( 'crud_operation', 'db_operation', 'php', 'rest_request', 'wp_cli' ),
'commands' => array( 'wordpress.collect-workload-result', 'wordpress.crud-operation', 'wordpress.db-operation', 'wordpress.inventory-plugin-module-options-tables', 'wordpress.rest-performance-observation', 'wordpress.rest-request', 'wordpress.run-php', 'wordpress.run-workload', 'wordpress.wp-cli' ),
'mutationIntents' => array( 'read', 'write', 'delete', 'destructive' ),
'supported' => true,
),
),
'resetModes' => array(
array( 'id' => 'none', 'supported' => true, 'optionalForMutationIntents' => array( 'read', 'write', 'delete', 'destructive' ), 'artifactKinds' => array() ),
array( 'id' => 'checkpoint-per-case', 'supported' => true, 'optionalForMutationIntents' => array( 'write', 'delete', 'destructive' ), 'artifactKinds' => array( 'mutation-isolation-artifact', 'delete-boundary-artifact' ) ),
array( 'id' => 'restore-snapshot', 'supported' => false, 'optionalForMutationIntents' => array( 'write', 'delete', 'destructive' ), 'artifactKinds' => array() ),
),
'artifactExpectations' => array(
array( 'id' => 'fuzz-suite-result', 'required' => true, 'schema' => 'wp-codebox/fuzz-suite-result/v1', 'producedBy' => array( 'run-fuzz-suite' ), 'description' => 'Every fuzz run returns a structured suite result envelope with case summaries, diagnostics, and artifact references.' ),
array( 'id' => 'mutation-isolation-artifact', 'required' => true, 'schema' => 'wp-codebox/mutation-isolation-artifact/v1', 'producedBy' => array( 'rest-mutation:post', 'rest-mutation:put', 'rest-mutation:patch' ), 'description' => 'Mutating REST coverage records the explicit fixture or disposable sandbox boundary and artifact evidence for the mutation.' ),
array( 'id' => 'delete-boundary-artifact', 'required' => true, 'schema' => 'wp-codebox/delete-boundary-artifact/v1', 'producedBy' => array( 'rest-mutation:delete' ), 'description' => 'Delete coverage records the explicit delete boundary artifact inside a disposable sandbox instead of advertising unbounded raw delete support.' ),
),
'destructiveModeRequirements' => array(
'supported' => true,
'destructiveMutationIntent' => 'destructive',
'requiredSandboxBoundary' => array(
'disposable' => true,
'destructivePermission' => true,
'teardown' => 'discard',
),
'optionalResetModes' => array( 'checkpoint-per-case', 'restore-snapshot' ),
'requiredArtifacts' => array( 'mutation-isolation-artifact', 'delete-boundary-artifact' ),
'deleteBoundaryCapability' => 'delete-boundary-artifact',
'rawDeleteCapability' => null,
),
'unsupportedCapabilities' => array(
array( 'id' => 'raw-delete', 'reason' => 'WordPress fuzz runtime delete coverage is only supported through explicit delete-boundary artifacts.', 'replacement' => 'delete-boundary-artifact' ),
array( 'id' => 'restore-snapshot-reset', 'reason' => 'Snapshot restore is an optional reset convenience, not destructive fuzz correctness proof.', 'replacement' => 'disposable-sandbox-boundary' ),
array( 'id' => 'private-runtime-probing', 'reason' => 'Consumers must read this descriptor instead of probing private runtime commands or implementation capabilities.' ),
),
'hbex' => array(
'schemaIds' => array(
'descriptor' => self::WORDPRESS_FUZZ_RUNTIME_CONTRACT_SCHEMA,
'fuzzSuite' => 'wp-codebox/fuzz-suite/v1',
'fuzzSuiteResult' => 'wp-codebox/fuzz-suite-result/v1',
'fuzzRunnerCapabilities' => 'wp-codebox/fuzz-runner-capabilities/v1',
'fuzzRunnerReadiness' => 'wp-codebox/fuzz-runner-readiness/v1',
'fuzzCoveragePlan' => 'wp-codebox/fuzz-coverage-plan/v1',
'fuzzFixturePlan' => 'wp-codebox/fuzz-fixture-plan/v1',
'restMutationFixtureOptIn' => 'wp-codebox/rest-mutation-fixture-opt-in/v1',
'mutationIsolationArtifact' => 'wp-codebox/mutation-isolation-artifact/v1',
'deleteBoundaryArtifact' => 'wp-codebox/delete-boundary-artifact/v1',
'wordpressWorkloadRun' => 'wp-codebox/wordpress-workload-run/v1',
),
),
);
}
/** @return array<string,mixed> */
public static function runtime_contract_manifest(): array {
return array(
'schema' => self::RUNTIME_CONTRACT_MANIFEST_SCHEMA,
'version' => 1,
'schemas' => self::runtime_contract_schemas(),
'abilities' => self::runtime_abilities(),
'providerRuntime' => self::provider_runtime_contract(),
);
}
/** @return array<string,mixed> */
private static function runtime_contract_schemas(): array {
return array(
'agentTask' => array(
'runRequest' => 'wp-codebox/agent-task-run-request/v1',
'runResult' => 'wp-codebox/agent-task-run-result/v1',
'headlessRequest' => 'wp-codebox/headless-agent-task-request/v1',
'headlessResult' => 'wp-codebox/headless-agent-task-result/v1',
),
'runtimeBoundary' => array(
'profile' => 'wp-codebox/runtime-profile/v1',
'previewLease' => 'wp-codebox/preview-lease/v1',
'browserContainedSiteStatus' => 'wp-codebox/browser-contained-site-status/v1',
'browserContainedSiteOpen' => 'wp-codebox/browser-contained-site-open/v1',
'browserSessionProductDto' => 'wp-codebox/browser-session-product-dto/v1',
'browserPreviewBootConfig' => 'wp-codebox/browser-preview-boot-config/v1',
'runtimeAccess' => 'wp-codebox/runtime-access/v1',
),
'browserSession' => array(
'productDto' => 'wp-codebox/browser-session-product-dto/v1',
'containedSiteStatus' => 'wp-codebox/browser-contained-site-status/v1',
'containedSiteOpen' => 'wp-codebox/browser-contained-site-open/v1',
'previewBootConfig' => 'wp-codebox/browser-preview-boot-config/v1',
'containedSiteSnapshot' => 'wp-codebox/browser-contained-site-snapshot/v1',
'containedSiteExport' => 'wp-codebox/browser-contained-site-export/v1',
'containedSiteApplyPlan' => 'wp-codebox/browser-contained-site-apply-plan/v1',
'containedSiteApplyResult' => 'wp-codebox/browser-contained-site-apply-result/v1',
),
'preview' => array(
'lease' => 'wp-codebox/preview-lease/v1',
'reviewerAccess' => 'wp-codebox/preview-reviewer-access/v1',
'runtimeAccess' => 'wp-codebox/runtime-access/v1',
),
'artifact' => array(
'resultEnvelope' => 'wp-codebox/artifact-result-envelope/v1',
'typedArtifact' => 'wp-codebox/structured-artifact/v1',
'typedArtifactIndex' => 'wp-codebox/typed-artifacts-index/v1',
'runtimePackageDeclaration' => 'wp-codebox/runtime-package-artifact-declaration/v1',
'runtimePackageProjection' => 'wp-codebox/runtime-package-output-projection/v1',
'bundleFileManifest' => 'wp-codebox/artifact-bundle-file-manifest/v1',
'browserArtifactPersistenceRef' => 'wp-codebox/browser-artifact-persistence/ref/v1',
),
'artifactBundle' => array(
'resultEnvelope' => 'wp-codebox/artifact-result-envelope/v1',
'fileManifest' => 'wp-codebox/artifact-bundle-file-manifest/v1',
'browserPersistenceRef' => 'wp-codebox/browser-artifact-persistence/ref/v1',
),
'taskState' => array(
'agentTaskRunResult' => 'wp-codebox/agent-task-run-result/v1',
'runtimeRunResult' => 'wp-codebox/runtime-run-result/v1',
'agentRuntimeWorkload' => 'wp-codebox/agent-runtime-workload/v1',
),
'runtimeProvider' => array(
'invocationContract' => 'wp-codebox/provider-runtime-invocation-contract/v1',
'credentialRequirements' => 'wp-codebox/provider-credential-requirements/v1',
'credentialPreflight' => 'wp-codebox/provider-credential-preflight/v1',
'credentialResolution' => 'wp-codebox/provider-credential-resolution/v1',
),
'providerRuntime' => array(
'invocation' => 'wp-codebox/provider-runtime-invocation-contract/v1',
'invocationContract' => 'wp-codebox/provider-runtime-invocation-contract/v1',
'credentialRequirements' => 'wp-codebox/provider-credential-requirements/v1',
'credentialPreflight' => 'wp-codebox/provider-credential-preflight/v1',
'credentialResolution' => 'wp-codebox/provider-credential-resolution/v1',
),
'hostDelegation' => array(
'request' => 'wp-codebox/host-delegation-request/v1',
'result' => 'wp-codebox/host-delegation-result/v1',
'event' => 'wp-codebox/host-delegation-event/v1',
),
'runtimePackage' => array(
'task' => 'wp-codebox/runtime-package-task/v1',
'result' => 'wp-codebox/runtime-package-result/v1',
'diagnostic' => 'wp-codebox/runtime-package-diagnostic/v1',
'executionInput' => 'wp-codebox/runtime-package-execution-input/v1',
'executionResult' => 'wp-codebox/runtime-package-execution-result/v1',
),
'runnerWorkspace' => array(
'prepareRequest' => 'wp-codebox/runner-workspace-prepare-request/v1',
'prepareResult' => 'wp-codebox/runner-workspace-prepare-result/v1',
'captureRequest' => 'wp-codebox/runner-workspace-capture-request/v1',
'captureResult' => 'wp-codebox/runner-workspace-capture-result/v1',
'commandRequest' => 'wp-codebox/runner-workspace-command-request/v1',
'commandResult' => 'wp-codebox/runner-workspace-command-result/v1',
'publicationRequest' => 'wp-codebox/runner-workspace-publication-request/v1',
'publicationResult' => 'wp-codebox/runner-workspace-publication-result/v1',
),
'parentToolBridge' => array(
'bridge' => 'wp-codebox/parent-tool-bridge/v1',
'request' => 'wp-codebox/parent-tool-request/v1',
'result' => 'wp-codebox/parent-tool-result/v1',
),
'fanoutAggregation' => array(
'input' => 'wp-codebox/agent-fanout-aggregation-input/v1',
'output' => 'wp-codebox/agent-fanout-aggregation-output/v1',
),
'wordpressRuntimeDiscovery' => array(
'result' => 'wp-codebox/wordpress-runtime-discovery/v1',
'restRouteInventory' => 'wp-codebox/wordpress-rest-route-inventory/v1',
'adminPageInventory' => 'wp-codebox/wordpress-admin-page-inventory/v1',
'databaseInventory' => 'wp-codebox/wordpress-db-inventory/v1',
'frontendUrlInventory' => 'wp-codebox/wordpress-frontend-url-inventory/v1',
'restMatrix' => 'wp-codebox/wordpress-rest-matrix/v1',
'restMatrixResult' => 'wp-codebox/wordpress-rest-matrix-result/v1',
),
'wordpressDb' => array(
'operation' => 'wp-codebox/wordpress-db-operation/v1',
'result' => 'wp-codebox/wordpress-db-result/v1',
),
'wordpressRuntime' => array(
'workloadRun' => 'wp-codebox/wordpress-workload-run/v1',
'fuzzCoveragePlan' => 'wp-codebox/fuzz-coverage-plan/v1',
'fuzzSuite' => 'wp-codebox/fuzz-suite/v1',
'fuzzSuiteResult' => 'wp-codebox/fuzz-suite-result/v1',
'fuzzRunnerCapabilities' => 'wp-codebox/fuzz-runner-capabilities/v1',
'fuzzRunnerReadiness' => 'wp-codebox/fuzz-runner-readiness/v1',
'wordpressFuzzRuntimeContract' => self::WORDPRESS_FUZZ_RUNTIME_CONTRACT_SCHEMA,
'blockExerciseResult' => 'wp-codebox/wordpress-block-exercise-result/v1',
),
);
}
/** @return array<string,mixed> */
private static function provider_runtime_contract(): array {
return array(
'schema' => 'wp-codebox/provider-runtime-invocation-contract/v1',
'version' => 1,
'tasks' => array(
'workspacePrepare' => 'wp-codebox.runner-workspace.prepare',
'workspaceCapture' => 'wp-codebox.runner-workspace.capture',
'workspaceCommand' => 'wp-codebox.runner-workspace.command',
'workspacePublish' => 'wp-codebox.runner-workspace.publish',
'toolCallTranscriptRecord' => 'wp-codebox.tool-call-transcript.record',
'artifactHandoff' => 'wp-codebox.artifact-handoff',
),
'abilities' => array(
'workspacePrepare' => 'wp-codebox/runner-workspace-prepare',
'workspaceCapture' => 'wp-codebox/runner-workspace-capture',
'workspaceCommand' => 'wp-codebox/runner-workspace-command',
'workspacePublish' => 'wp-codebox/runner-workspace-publish',
'toolCallTranscriptRecord' => 'wp-codebox/record-tool-call-transcript',
'artifactHandoff' => 'wp-codebox/handoff-artifacts',
),
'result_schemas' => array(
'workspace_prepare' => 'wp-codebox/runner-workspace-prepare-result/v1',
'workspace_capture' => 'wp-codebox/runner-workspace-capture-result/v1',
'workspace_command' => 'wp-codebox/runner-workspace-command-result/v1',
'workspace_publication' => 'wp-codebox/runner-workspace-publication-result/v1',
'tool_call_transcript' => 'wp-codebox/tool-call-transcript/v1',
'evidence_artifact_envelope' => 'wp-codebox/evidence-artifact-envelope/v1',
'artifact_result_envelope' => 'wp-codebox/artifact-result-envelope/v1',
),
);
}
/** @return array<string,mixed> */
private static function runtime_abilities(): array {
return array(
'agentTask' => array(
'run' => 'wp-codebox/run-agent-task',
'batch' => 'wp-codebox/run-agent-task-batch',
'fanout' => 'wp-codebox/run-agent-task-fanout',
),
'runtimePackage' => array(
'run' => 'wp-codebox/run-runtime-package',
),
'runtimeRequirements' => array(
'resolve' => 'wp-codebox/resolve-runtime-requirements',
),
'wordpressRuntime' => array(
'runWorkload' => 'wp-codebox/run-wordpress-workload',
'runFuzzSuite' => 'wp-codebox/run-fuzz-suite',
),
);
}
/** @return array<string,string> Public Codebox ability id to facade method map. */
public static function public_abilities(): array {
return self::ABILITY_METHODS;
}
/** @return array<string,array<string,string>> Public schema ids grouped by Codebox primitive. */
public static function public_contract_schemas(): array {
$schemas = self::runtime_contract_schemas();
return array(
'runtimeSession' => array(
'access' => $schemas['runtimeBoundary']['runtimeAccess'],
'previewLease' => $schemas['runtimeBoundary']['previewLease'],
'previewReviewerAccess' => $schemas['preview']['reviewerAccess'],
'browserSessionProductDto' => $schemas['runtimeBoundary']['browserSessionProductDto'],
'browserPreviewBootConfig' => $schemas['runtimeBoundary']['browserPreviewBootConfig'],
'browserContainedSiteStatus' => $schemas['runtimeBoundary']['browserContainedSiteStatus'],
'browserContainedSiteOpen' => $schemas['runtimeBoundary']['browserContainedSiteOpen'],
),
'runtimeProfile' => array(
'profile' => $schemas['runtimeBoundary']['profile'],
),
'task' => array(
'input' => 'wp-codebox/task-input/v1',
'runRequest' => $schemas['agentTask']['runRequest'],
'runResult' => $schemas['agentTask']['runResult'],
'headlessRequest' => $schemas['agentTask']['headlessRequest'],
'headlessResult' => $schemas['agentTask']['headlessResult'],
),
'agent' => array(
'workload' => $schemas['taskState']['agentRuntimeWorkload'],
'runResult' => $schemas['taskState']['agentTaskRunResult'],
),
'artifact' => array(
'resultEnvelope' => $schemas['artifact']['resultEnvelope'],
'typedArtifact' => $schemas['artifact']['typedArtifact'],
'typedArtifactIndex' => $schemas['artifact']['typedArtifactIndex'],
'bundleFileManifest' => $schemas['artifact']['bundleFileManifest'],
'browserArtifactPersistenceRef' => $schemas['artifact']['browserArtifactPersistenceRef'],
),
'credential' => array(
'requirements' => $schemas['runtimeProvider']['credentialRequirements'],
'preflight' => $schemas['runtimeProvider']['credentialPreflight'],
'resolution' => $schemas['runtimeProvider']['credentialResolution'],
),
);
}
/** @return array<string,mixed> Public primitive map for PHP SDK consumers. */
public static function public_contract_primitives(): array {
$schemas = self::public_contract_schemas();
$abilities = self::runtime_abilities();
return array(
'runtimeSession' => array( 'schemas' => $schemas['runtimeSession'] ),
'runtimeProfile' => array( 'schemas' => $schemas['runtimeProfile'] ),
'task' => array(
'abilities' => $abilities['agentTask'],
'schemas' => $schemas['task'],
),
'agent' => array(
'abilities' => array(
'runTask' => $abilities['agentTask']['run'],
'runTaskBatch' => $abilities['agentTask']['batch'],
'runTaskFanout' => $abilities['agentTask']['fanout'],
),
'schemas' => $schemas['agent'],
),
'artifact' => array( 'schemas' => $schemas['artifact'] ),
'credential' => array( 'schemas' => $schemas['credential'], 'redacted' => true ),
);
}
/** @param array<string,mixed> $input Ability input. @return array<string,mixed>|WP_Error */
public static function execute_ability( string $ability_name, array $input = array() ): array|WP_Error {
$ability_name = trim( $ability_name );
$method = self::ABILITY_METHODS[ $ability_name ] ?? '';
if ( '' === $method ) {
return new WP_Error( 'wp_codebox_api_ability_not_supported', 'WP_Codebox_API only executes supported wp-codebox consumer operations.', array( 'status' => 400 ) );
}
return self::{$method}( $input );
}
/** @param array<string,mixed> $input Task input. @return array<string,mixed>|WP_Error */
public static function run_agent_task( array $input ): array|WP_Error {
return WP_Codebox_Abilities::run_agent_task( $input );
}
/** @param array<string,mixed> $input Batch input. @return array<string,mixed>|WP_Error */
public static function run_agent_task_batch( array $input ): array|WP_Error {
return WP_Codebox_Abilities::run_agent_task_batch( $input );
}
/** @param array<string,mixed> $input Fanout input. @return array<string,mixed>|WP_Error */
public static function run_agent_task_fanout( array $input ): array|WP_Error {
return WP_Codebox_Abilities::run_agent_task_fanout( $input );
}
/** @param array<string,mixed> $input Runtime task input. @return array<string,mixed>|WP_Error */
public static function run_runtime_task( array $input ): array|WP_Error {
return WP_Codebox_Abilities::run_runtime_task( $input );
}
/** @param array<string,mixed> $input WordPress workload input. @return array<string,mixed>|WP_Error */
public static function run_wordpress_workload( array $input ): array|WP_Error {
return WP_Codebox_Abilities::run_wordpress_workload( $input );
}
/** @param array<string,mixed> $input Runtime package input. @return array<string,mixed>|WP_Error */
public static function run_runtime_package( array $input ): array|WP_Error {
return WP_Codebox_Abilities::run_runtime_package( $input );
}
/** @param array<string,mixed> $input Runtime readiness input. @return array<string,mixed> */
public static function resolve_runtime_requirements( array $input ): array {
return WP_Codebox_Abilities::resolve_runtime_requirements( $input );
}
/** @param array<string,mixed> $input Fuzz suite input. @return array<string,mixed>|WP_Error */
public static function run_fuzz_suite( array $input ): array|WP_Error {
return WP_Codebox_Abilities::run_fuzz_suite( $input );
}
/** @param array<string,mixed> $input Browser session input. @return array<string,mixed>|WP_Error */
public static function create_browser_session( array $input ): array|WP_Error {
return WP_Codebox_Abilities::create_browser_playground_session( $input );
}
/** @param array<string,mixed> $input Browser task contract input. @return array<string,mixed>|WP_Error */
public static function create_browser_task_contract( array $input ): array|WP_Error {
return WP_Codebox_Abilities::create_browser_task_contract( $input );
}
/** @param array<string,mixed> $input Browser materializer contract input. @return array<string,mixed>|WP_Error */
public static function create_browser_materializer_contract( array $input ): array|WP_Error {
return WP_Codebox_Abilities::create_browser_materializer_contract( $input );
}
/** @param array<string,mixed> $input Browser contained-site session input. @return array<string,mixed>|WP_Error */
public static function create_browser_contained_site_session( array $input ): array|WP_Error {
return WP_Codebox_Abilities::create_browser_contained_site_session( $input );
}
/** @param array<string,mixed> $input Browser session lookup input. @return array<string,mixed>|WP_Error */
public static function get_browser_session_status( array $input ): array|WP_Error {
return self::browser_contained_site_status( $input );
}
/** @param array<string,mixed> $input Browser contained-site status input. @return array<string,mixed>|WP_Error */
public static function browser_contained_site_status( array $input ): array|WP_Error {
return WP_Codebox_Abilities::get_browser_contained_site_status( $input );
}
/** @param array<string,mixed> $input Browser session lookup input. @return array<string,mixed>|WP_Error */
public static function preview_reuse_decision( array $input ): array|WP_Error {
return WP_Codebox_Abilities::preview_reuse_decision( $input );
}
/** @param array<string,mixed> $input Browser session input. @return array<string,mixed>|WP_Error */
public static function open_browser_session( array $input ): array|WP_Error {
return WP_Codebox_Abilities::open_browser_contained_site( $input );
}
/** @param array<string,mixed> $input Browser session input. @return array<string,mixed>|WP_Error */
public static function open_or_create_browser_session( array $input ): array|WP_Error {
return self::open_or_create_browser_contained_site( $input );
}
/** @param array<string,mixed> $input Browser contained-site input. @return array<string,mixed>|WP_Error */
public static function open_or_create_browser_contained_site( array $input ): array|WP_Error {
return WP_Codebox_Abilities::open_or_create_browser_contained_site( $input );
}
/** @param array<string,mixed> $input Browser contained-site input. @return array<string,mixed>|WP_Error */
public static function snapshot_browser_contained_site( array $input ): array|WP_Error {
return WP_Codebox_Abilities::snapshot_browser_contained_site( $input );
}
/** @param array<string,mixed> $input Browser contained-site input. @return array<string,mixed>|WP_Error */
public static function export_browser_contained_site( array $input ): array|WP_Error {
return WP_Codebox_Abilities::export_browser_contained_site( $input );
}
/** @param array<string,mixed> $input Browser contained-site input. @return array<string,mixed>|WP_Error */
public static function plan_browser_contained_site_apply( array $input ): array|WP_Error {
return WP_Codebox_Abilities::plan_browser_contained_site_apply( $input );
}
/** @param array<string,mixed> $input Browser contained-site input. @return array<string,mixed>|WP_Error */
public static function apply_browser_contained_site_plan( array $input ): array|WP_Error {
return WP_Codebox_Abilities::apply_browser_contained_site_plan( $input );
}
/** @param array<string,mixed> $input Browser contained-site sync input. @return array<string,mixed>|WP_Error */
public static function browser_contained_site_sync_delegation( array $input ): array|WP_Error {
return WP_Codebox_Abilities::browser_contained_site_sync_delegation( $input );
}
/** @param array<string,mixed> $input Browser contained-site sync input. @return array<string,mixed>|WP_Error */
public static function browser_contained_site_sync_source_connect( array $input ): array|WP_Error {
return WP_Codebox_Abilities::browser_contained_site_sync_source_connect( $input );
}
/** @param array<string,mixed> $input Browser contained-site sync input. @return array<string,mixed>|WP_Error */
public static function browser_contained_site_sync_manifest( array $input ): array|WP_Error {
return WP_Codebox_Abilities::browser_contained_site_sync_manifest( $input );
}
/** @param array<string,mixed> $input Browser contained-site sync input. @return array<string,mixed>|WP_Error */
public static function browser_contained_site_sync_export( array $input ): array|WP_Error {
return WP_Codebox_Abilities::browser_contained_site_sync_export( $input );
}
/** @param array<string,mixed> $input Browser contained-site sync input. @return array<string,mixed>|WP_Error */
public static function browser_contained_site_sync_apply_plan_generate( array $input ): array|WP_Error {
return WP_Codebox_Abilities::browser_contained_site_sync_apply_plan_generate( $input );
}
/** @param array<string,mixed> $input Browser contained-site sync input. @return array<string,mixed>|WP_Error */
public static function browser_contained_site_sync_apply_plan_validate( array $input ): array|WP_Error {
return WP_Codebox_Abilities::browser_contained_site_sync_apply_plan_validate( $input );
}
/** @param array<string,mixed> $input Browser contained-site sync input. @return array<string,mixed>|WP_Error */
public static function browser_contained_site_sync_apply( array $input ): array|WP_Error {
return WP_Codebox_Abilities::browser_contained_site_sync_apply( $input );
}
/** @param array<string,mixed> $input Host delegation input. @return array<string,mixed>|WP_Error */
public static function request_host_delegation( array $input ): array|WP_Error {
return WP_Codebox_Abilities::request_host_delegation( $input );
}
/** @param array<string,mixed> $input Artifact list input. @return array<string,mixed>|WP_Error */
public static function list_artifacts( array $input = array() ): array|WP_Error {
return WP_Codebox_Abilities::list_artifacts( $input );
}
/** @param array<string,mixed> $input Artifact lookup input. @return array<string,mixed>|WP_Error */
public static function get_artifact( array $input ): array|WP_Error {
return WP_Codebox_Abilities::get_artifact( $input );
}
/** @param array<string,mixed> $input Artifact inspection input. @return array<string,mixed>|WP_Error */
public static function inspect_artifact( array $input ): array|WP_Error {
return WP_Codebox_Abilities::inspect_artifact( $input );
}
/** @param array<string,mixed> $input Artifact bundle normalization input. @return array<string,mixed>|WP_Error */
public static function normalize_artifact_bundle( array $input ): array|WP_Error {
return WP_Codebox_Abilities::normalize_browser_artifact_bundle( $input );
}
/** @param array<string,mixed> $input Browser artifact persistence input. @return array<string,mixed>|WP_Error */
public static function persist_artifact( array $input ): array|WP_Error {
return WP_Codebox_Abilities::persist_browser_artifact( $input );
}
/** @param array<string,mixed> $input Artifact bundle import input. @return array<string,mixed>|WP_Error */
public static function import_artifact( array $input ): array|WP_Error {
return WP_Codebox_Abilities::import_artifact_bundle( $input );
}
/** @param array<string,mixed> $input Artifact bundle reimport input. @return array<string,mixed>|WP_Error */
public static function reimport_artifact( array $input ): array|WP_Error {
return WP_Codebox_Abilities::reimport_artifact_bundle( $input );
}
/** @param array<string,mixed> $input Artifact apply input. @return array<string,mixed>|WP_Error */
public static function preflight_artifact_apply( array $input ): array|WP_Error {
return WP_Codebox_Abilities::apply_artifact_preflight( $input );
}
/** @param array<string,mixed> $input Artifact apply input. @return array<string,mixed>|WP_Error */
public static function stage_artifact_apply( array $input ): array|WP_Error {
return WP_Codebox_Abilities::stage_artifact_apply( $input );
}
/** @param array<string,mixed> $input Artifact apply input. @return array<string,mixed>|WP_Error */
public static function apply_approved_artifact( array $input ): array|WP_Error {
return WP_Codebox_Abilities::apply_approved_artifact( $input );
}
/** @param array<string,mixed> $input Runner workspace input. @return array<string,mixed> */
public static function prepare_runner_workspace( array $input ): array {
return WP_Codebox_Abilities::prepare_runner_workspace( $input );
}
/** @param array<string,mixed> $input Runner workspace input. @return array<string,mixed> */
public static function capture_runner_workspace( array $input ): array {
return WP_Codebox_Abilities::capture_runner_workspace( $input );
}
/** @param array<string,mixed> $input Runner workspace command input. @return array<string,mixed> */
public static function run_runner_workspace_command( array $input ): array {
return WP_Codebox_Abilities::run_runner_workspace_command( $input );
}
/** @param array<string,mixed> $input Runner workspace publication input. @return array<string,mixed> */
public static function publish_runner_workspace( array $input ): array {
return WP_Codebox_Abilities::publish_runner_workspace( $input );
}
}