@fungi.computer/oyster 0.31.2 → 0.33.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 (63) hide show
  1. package/README.md +59 -0
  2. package/dist/agent-computer-source.d.ts +1 -0
  3. package/dist/agent-computer-source.js +1 -0
  4. package/dist/app-test-copies.d.ts +87 -0
  5. package/dist/app-test-copies.js +170 -0
  6. package/dist/app-test-copy-page.d.ts +4 -0
  7. package/dist/app-test-copy-page.js +89 -0
  8. package/dist/apps/installation.js +19 -14
  9. package/dist/browser/operations.d.ts +1 -1
  10. package/dist/cloudflare.d.ts +68 -3
  11. package/dist/cloudflare.js +214 -3
  12. package/dist/embed-metafiles.js +2 -2
  13. package/dist/embed-scripts.js +2 -2
  14. package/dist/host.d.ts +16 -0
  15. package/dist/host.js +309 -1
  16. package/dist/installation-operations.d.ts +247 -8
  17. package/dist/installation-operations.js +145 -7
  18. package/dist/installation-recovery-page.d.ts +24 -0
  19. package/dist/installation-recovery-page.js +168 -0
  20. package/dist/older-oyster-store.d.ts +1 -1
  21. package/dist/older-oyster-store.js +2 -4
  22. package/dist/page/mount.d.ts +2 -101
  23. package/dist/page/mount.js +1 -22
  24. package/dist/page-config.d.ts +102 -0
  25. package/dist/page-config.js +24 -0
  26. package/dist/page-script.js +1 -1
  27. package/dist/platform-skills.generated.d.ts +11 -0
  28. package/dist/platform-skills.generated.js +16 -0
  29. package/dist/recovery-style.d.ts +5 -0
  30. package/dist/recovery-style.js +32 -0
  31. package/dist/standalone/agents.d.ts +1 -1
  32. package/dist/standalone/agents.js +1 -0
  33. package/dist/standalone/computer-skill-source.d.ts +13 -2
  34. package/dist/standalone/computer-skill-source.js +80 -6
  35. package/dist/standalone/workflow-host.d.ts +4 -4
  36. package/dist/standalone/workflows.d.ts +9 -9
  37. package/dist/storage-frame.d.ts +3 -3
  38. package/dist/upgrade/old-worker-http.d.ts +2 -0
  39. package/dist/upgrade/old-worker-http.js +22 -0
  40. package/dist/upgrade/old-worker-readonly.d.ts +14 -0
  41. package/dist/upgrade/old-worker-readonly.js +22 -0
  42. package/dist/upgrade/old-worker-sql.d.ts +10 -0
  43. package/dist/upgrade/old-worker-sql.js +68 -0
  44. package/dist/upgrade/old-worker-stream.d.ts +12 -0
  45. package/dist/upgrade/old-worker-stream.js +54 -0
  46. package/dist/upgrade/private-stage.d.ts +23 -0
  47. package/dist/upgrade/private-stage.js +109 -0
  48. package/dist/upgrade/standalone-001.d.ts +16 -0
  49. package/dist/upgrade/standalone-001.js +31 -0
  50. package/dist/upgrade/standalone-01.d.ts +37 -0
  51. package/dist/upgrade/standalone-01.js +55 -0
  52. package/dist/upgrade/standalone-02.d.ts +37 -0
  53. package/dist/upgrade/standalone-02.js +55 -0
  54. package/dist/workers.d.ts +16 -2
  55. package/dist/workers.js +117 -7
  56. package/docs/api/README.md +8 -3
  57. package/docs/api/apps.md +33 -33
  58. package/docs/api/cloudflare.md +57 -0
  59. package/docs/api/host.md +223 -14
  60. package/docs/api/page/mount.md +10 -78
  61. package/docs/api/workers-git.md +246 -1
  62. package/docs/api/workers.md +352 -14
  63. package/package.json +23 -10
@@ -517,6 +517,251 @@ new OysterGitInstance<Env>(ctx, env): OysterGitInstance<Env>;
517
517
 
518
518
  #### Methods
519
519
 
520
+ ##### openTestCopy()
521
+
522
+ ```ts
523
+ openTestCopy(
524
+ authority,
525
+ requestId,
526
+ tenantId?
527
+ ): Promise<InstanceResult<{
528
+ selection: {
529
+ instanceId: InstanceId;
530
+ owner: {
531
+ kind: "installation" | "deployment";
532
+ id: string;
533
+ };
534
+ appId: AppId;
535
+ releaseId: ReleaseId;
536
+ authorityVersion: number;
537
+ };
538
+ storeGeneration: string;
539
+ copyId: string;
540
+ expiresAt: number;
541
+ }>>;
542
+ ```
543
+
544
+ Open only under the existing Instance serialization and pinned tenant.
545
+
546
+ ###### Parameters
547
+
548
+ | Parameter | Type | Default value |
549
+ | -------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------- |
550
+ | `authority` | \{ `selection`: \{ `instanceId`: [`InstanceId`](index.md#instanceid); `owner`: \{ `kind`: `"installation"` \| `"deployment"`; `id`: `string`; \}; `appId`: `AppId`; `releaseId`: `ReleaseId`; `authorityVersion`: `number`; \}; `storeGeneration`: `string`; \} | `undefined` |
551
+ | `authority.selection` | \{ `instanceId`: [`InstanceId`](index.md#instanceid); `owner`: \{ `kind`: `"installation"` \| `"deployment"`; `id`: `string`; \}; `appId`: `AppId`; `releaseId`: `ReleaseId`; `authorityVersion`: `number`; \} | `...` |
552
+ | `authority.selection.instanceId` | [`InstanceId`](index.md#instanceid) | `instanceIdSchema` |
553
+ | `authority.selection.owner` | \{ `kind`: `"installation"` \| `"deployment"`; `id`: `string`; \} | `ownerSchema` |
554
+ | `authority.selection.owner.kind` | `"installation"` \| `"deployment"` | `...` |
555
+ | `authority.selection.owner.id` | `string` | `Schema.NonEmptyString` |
556
+ | `authority.selection.appId` | `AppId` | `appIdSchema` |
557
+ | `authority.selection.releaseId` | `ReleaseId` | `releaseIdSchema` |
558
+ | `authority.selection.authorityVersion` | `number` | `...` |
559
+ | `authority.storeGeneration` | `string` | `...` |
560
+ | `requestId` | `string` | `undefined` |
561
+ | `tenantId` | `string` & `Brand`\<`"OysterTenantId"`\> | `defaultTenant` |
562
+
563
+ ###### Returns
564
+
565
+ `Promise`\<[`InstanceResult`](host.md#instanceresult)\<\{ `selection`: \{
566
+ `instanceId`: [`InstanceId`](index.md#instanceid); `owner`: \{ `kind`:
567
+ `"installation"` \| `"deployment"`; `id`: `string`; \}; `appId`: `AppId`;
568
+ `releaseId`: `ReleaseId`; `authorityVersion`: `number`; \}; `storeGeneration`:
569
+ `string`; `copyId`: `string`; `expiresAt`: `number`; \}\>\>
570
+
571
+ ###### Inherited from
572
+
573
+ [`OysterInstance`](workers.md#oysterinstance).[`openTestCopy`](workers.md#opentestcopy)
574
+
575
+ ##### inspectTestCopy()
576
+
577
+ ```ts
578
+ inspectTestCopy(authority, tenantId?): Promise<InstanceResult<
579
+ | {
580
+ selection: {
581
+ instanceId: InstanceId;
582
+ owner: {
583
+ kind: "installation" | "deployment";
584
+ id: string;
585
+ };
586
+ appId: AppId;
587
+ releaseId: ReleaseId;
588
+ authorityVersion: number;
589
+ };
590
+ storeGeneration: string;
591
+ copyId: string;
592
+ expiresAt: number;
593
+ }
594
+ | null>>;
595
+ ```
596
+
597
+ Observation rechecks both applied selection and current registry incarnation.
598
+
599
+ ###### Parameters
600
+
601
+ | Parameter | Type | Default value |
602
+ | -------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------- |
603
+ | `authority` | \{ `selection`: \{ `instanceId`: [`InstanceId`](index.md#instanceid); `owner`: \{ `kind`: `"installation"` \| `"deployment"`; `id`: `string`; \}; `appId`: `AppId`; `releaseId`: `ReleaseId`; `authorityVersion`: `number`; \}; `storeGeneration`: `string`; \} | `undefined` |
604
+ | `authority.selection` | \{ `instanceId`: [`InstanceId`](index.md#instanceid); `owner`: \{ `kind`: `"installation"` \| `"deployment"`; `id`: `string`; \}; `appId`: `AppId`; `releaseId`: `ReleaseId`; `authorityVersion`: `number`; \} | `...` |
605
+ | `authority.selection.instanceId` | [`InstanceId`](index.md#instanceid) | `instanceIdSchema` |
606
+ | `authority.selection.owner` | \{ `kind`: `"installation"` \| `"deployment"`; `id`: `string`; \} | `ownerSchema` |
607
+ | `authority.selection.owner.kind` | `"installation"` \| `"deployment"` | `...` |
608
+ | `authority.selection.owner.id` | `string` | `Schema.NonEmptyString` |
609
+ | `authority.selection.appId` | `AppId` | `appIdSchema` |
610
+ | `authority.selection.releaseId` | `ReleaseId` | `releaseIdSchema` |
611
+ | `authority.selection.authorityVersion` | `number` | `...` |
612
+ | `authority.storeGeneration` | `string` | `...` |
613
+ | `tenantId` | `string` & `Brand`\<`"OysterTenantId"`\> | `defaultTenant` |
614
+
615
+ ###### Returns
616
+
617
+ `Promise`\<[`InstanceResult`](host.md#instanceresult)\< \| \{ `selection`: \{
618
+ `instanceId`: [`InstanceId`](index.md#instanceid); `owner`: \{ `kind`:
619
+ `"installation"` \| `"deployment"`; `id`: `string`; \}; `appId`: `AppId`;
620
+ `releaseId`: `ReleaseId`; `authorityVersion`: `number`; \}; `storeGeneration`:
621
+ `string`; `copyId`: `string`; `expiresAt`: `number`; \} \| `null`\>\>
622
+
623
+ ###### Inherited from
624
+
625
+ [`OysterInstance`](workers.md#oysterinstance).[`inspectTestCopy`](workers.md#inspecttestcopy)
626
+
627
+ ##### discardTestCopy()
628
+
629
+ ```ts
630
+ discardTestCopy(
631
+ authority,
632
+ copyId,
633
+ tenantId?
634
+ ): Promise<InstanceResult<boolean>>;
635
+ ```
636
+
637
+ A delayed discard cannot target a later sibling.
638
+
639
+ ###### Parameters
640
+
641
+ | Parameter | Type | Default value |
642
+ | -------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------- |
643
+ | `authority` | \{ `selection`: \{ `instanceId`: [`InstanceId`](index.md#instanceid); `owner`: \{ `kind`: `"installation"` \| `"deployment"`; `id`: `string`; \}; `appId`: `AppId`; `releaseId`: `ReleaseId`; `authorityVersion`: `number`; \}; `storeGeneration`: `string`; \} | `undefined` |
644
+ | `authority.selection` | \{ `instanceId`: [`InstanceId`](index.md#instanceid); `owner`: \{ `kind`: `"installation"` \| `"deployment"`; `id`: `string`; \}; `appId`: `AppId`; `releaseId`: `ReleaseId`; `authorityVersion`: `number`; \} | `...` |
645
+ | `authority.selection.instanceId` | [`InstanceId`](index.md#instanceid) | `instanceIdSchema` |
646
+ | `authority.selection.owner` | \{ `kind`: `"installation"` \| `"deployment"`; `id`: `string`; \} | `ownerSchema` |
647
+ | `authority.selection.owner.kind` | `"installation"` \| `"deployment"` | `...` |
648
+ | `authority.selection.owner.id` | `string` | `Schema.NonEmptyString` |
649
+ | `authority.selection.appId` | `AppId` | `appIdSchema` |
650
+ | `authority.selection.releaseId` | `ReleaseId` | `releaseIdSchema` |
651
+ | `authority.selection.authorityVersion` | `number` | `...` |
652
+ | `authority.storeGeneration` | `string` | `...` |
653
+ | `copyId` | `string` | `undefined` |
654
+ | `tenantId` | `string` & `Brand`\<`"OysterTenantId"`\> | `defaultTenant` |
655
+
656
+ ###### Returns
657
+
658
+ `Promise`\<[`InstanceResult`](host.md#instanceresult)\<`boolean`\>\>
659
+
660
+ ###### Inherited from
661
+
662
+ [`OysterInstance`](workers.md#oysterinstance).[`discardTestCopy`](workers.md#discardtestcopy)
663
+
664
+ ##### testCopyBackend()
665
+
666
+ ```ts
667
+ testCopyBackend(
668
+ authority,
669
+ copyId,
670
+ request,
671
+ limits?,
672
+ tenantId?
673
+ ): Promise<Response>;
674
+ ```
675
+
676
+ Uses the ordinary invocation facade, without live bindings or host context.
677
+
678
+ ###### Parameters
679
+
680
+ | Parameter | Type | Default value |
681
+ | --------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------- |
682
+ | `authority` | \{ `selection`: \{ `instanceId`: [`InstanceId`](index.md#instanceid); `owner`: \{ `kind`: `"installation"` \| `"deployment"`; `id`: `string`; \}; `appId`: `AppId`; `releaseId`: `ReleaseId`; `authorityVersion`: `number`; \}; `storeGeneration`: `string`; \} | `undefined` |
683
+ | `authority.selection` | \{ `instanceId`: [`InstanceId`](index.md#instanceid); `owner`: \{ `kind`: `"installation"` \| `"deployment"`; `id`: `string`; \}; `appId`: `AppId`; `releaseId`: `ReleaseId`; `authorityVersion`: `number`; \} | `...` |
684
+ | `authority.selection.instanceId` | [`InstanceId`](index.md#instanceid) | `instanceIdSchema` |
685
+ | `authority.selection.owner` | \{ `kind`: `"installation"` \| `"deployment"`; `id`: `string`; \} | `ownerSchema` |
686
+ | `authority.selection.owner.kind?` | `"installation"` \| `"deployment"` | `...` |
687
+ | `authority.selection.owner.id?` | `string` | `Schema.NonEmptyString` |
688
+ | `authority.selection.appId?` | `AppId` | `appIdSchema` |
689
+ | `authority.selection.releaseId?` | `ReleaseId` | `releaseIdSchema` |
690
+ | `authority.selection.authorityVersion?` | `number` | `...` |
691
+ | `authority.storeGeneration?` | `string` | `...` |
692
+ | `copyId?` | `string` | `undefined` |
693
+ | `request?` | `Request` | `undefined` |
694
+ | `limits?` | `Readonly`\<\{ `cpuMs`: `number`; `subRequests`: `number`; \}\> | `undefined` |
695
+ | `tenantId?` | `string` & `Brand`\<`"OysterTenantId"`\> | `defaultTenant` |
696
+
697
+ ###### Returns
698
+
699
+ `Promise`\<`Response`\>
700
+
701
+ ###### Inherited from
702
+
703
+ [`OysterInstance`](workers.md#oysterinstance).[`testCopyBackend`](workers.md#testcopybackend)
704
+
705
+ ##### callTestCopy()
706
+
707
+ ```ts
708
+ callTestCopy(
709
+ authority,
710
+ copyId,
711
+ name,
712
+ input,
713
+ caller,
714
+ limits?,
715
+ tenantId?
716
+ ): Promise<InstanceResult<unknown>>;
717
+ ```
718
+
719
+ Declared methods share copy isolation, never a live invocation frame or binding
720
+ env.
721
+
722
+ ###### Parameters
723
+
724
+ | Parameter | Type | Default value |
725
+ | --------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------- |
726
+ | `authority` | \{ `selection`: \{ `instanceId`: [`InstanceId`](index.md#instanceid); `owner`: \{ `kind`: `"installation"` \| `"deployment"`; `id`: `string`; \}; `appId`: `AppId`; `releaseId`: `ReleaseId`; `authorityVersion`: `number`; \}; `storeGeneration`: `string`; \} | `undefined` |
727
+ | `authority.selection` | \{ `instanceId`: [`InstanceId`](index.md#instanceid); `owner`: \{ `kind`: `"installation"` \| `"deployment"`; `id`: `string`; \}; `appId`: `AppId`; `releaseId`: `ReleaseId`; `authorityVersion`: `number`; \} | `...` |
728
+ | `authority.selection.instanceId` | [`InstanceId`](index.md#instanceid) | `instanceIdSchema` |
729
+ | `authority.selection.owner` | \{ `kind`: `"installation"` \| `"deployment"`; `id`: `string`; \} | `ownerSchema` |
730
+ | `authority.selection.owner.kind` | `"installation"` \| `"deployment"` | `...` |
731
+ | `authority.selection.owner.id` | `string` | `Schema.NonEmptyString` |
732
+ | `authority.selection.appId?` | `AppId` | `appIdSchema` |
733
+ | `authority.selection.releaseId?` | `ReleaseId` | `releaseIdSchema` |
734
+ | `authority.selection.authorityVersion?` | `number` | `...` |
735
+ | `authority.storeGeneration?` | `string` | `...` |
736
+ | `copyId?` | `string` | `undefined` |
737
+ | `name?` | `string` | `undefined` |
738
+ | `input?` | `Json` | `undefined` |
739
+ | `caller?` | \{ `computerId`: `string` \| `null`; `actor`: \| \{ `kind`: `"member"`; `memberId`: `string`; \} \| \{ `kind`: `"agent"`; `agentId`: `string`; \} \| \{ `kind`: `"team-key"`; `keyId`: `string`; \}; `backgroundLane?`: `string`; `backgroundOrigin?`: \{ `method`: `string`; `seal`: `string`; \}; `role?`: `"member"` \| `"owner"` \| `"admin"`; `soleMember?`: `true`; `workflow?`: \{ `workflowId`: `string`; `runId`: `string`; `nodeId`: `string`; `armedBy`: \| \{ `kind`: `"member"`; `memberId`: `string`; \} \| \{ `kind`: `"agent"`; `agentId`: `string`; \} \| \{ `kind`: `"team-key"`; `keyId`: `string`; \}; \}; `idempotencyKey?`: `string`; \} | `undefined` |
740
+ | `caller.computerId?` | `string` \| `null` | `undefined` |
741
+ | `caller.actor?` | \| \{ `kind`: `"member"`; `memberId`: `string`; \} \| \{ `kind`: `"agent"`; `agentId`: `string`; \} \| \{ `kind`: `"team-key"`; `keyId`: `string`; \} | `undefined` |
742
+ | `caller.backgroundLane?` | `string` | `undefined` |
743
+ | `caller.backgroundOrigin?` | \{ `method`: `string`; `seal`: `string`; \} | `undefined` |
744
+ | `caller.backgroundOrigin.method?` | `string` | `undefined` |
745
+ | `caller.backgroundOrigin.seal?` | `string` | `undefined` |
746
+ | `caller.role?` | `"member"` \| `"owner"` \| `"admin"` | `undefined` |
747
+ | `caller.soleMember?` | `true` | `undefined` |
748
+ | `caller.workflow?` | \{ `workflowId`: `string`; `runId`: `string`; `nodeId`: `string`; `armedBy`: \| \{ `kind`: `"member"`; `memberId`: `string`; \} \| \{ `kind`: `"agent"`; `agentId`: `string`; \} \| \{ `kind`: `"team-key"`; `keyId`: `string`; \}; \} | `undefined` |
749
+ | `caller.workflow.workflowId?` | `string` | `undefined` |
750
+ | `caller.workflow.runId?` | `string` | `undefined` |
751
+ | `caller.workflow.nodeId?` | `string` | `undefined` |
752
+ | `caller.workflow.armedBy?` | \| \{ `kind`: `"member"`; `memberId`: `string`; \} \| \{ `kind`: `"agent"`; `agentId`: `string`; \} \| \{ `kind`: `"team-key"`; `keyId`: `string`; \} | `undefined` |
753
+ | `caller.idempotencyKey?` | `string` | `undefined` |
754
+ | `limits?` | `Readonly`\<\{ `cpuMs`: `number`; `subRequests`: `number`; \}\> | `undefined` |
755
+ | `tenantId?` | `string` & `Brand`\<`"OysterTenantId"`\> | `defaultTenant` |
756
+
757
+ ###### Returns
758
+
759
+ `Promise`\<[`InstanceResult`](host.md#instanceresult)\<`unknown`\>\>
760
+
761
+ ###### Inherited from
762
+
763
+ [`OysterInstance`](workers.md#oysterinstance).[`callTestCopy`](workers.md#calltestcopy)
764
+
520
765
  ##### bindingCall()
521
766
 
522
767
  ```ts
@@ -1737,7 +1982,7 @@ both compose it here.
1737
1982
  | `env` | [`OysterGitEnv`](#oystergitenv) |
1738
1983
  | `scope` | [`TenantScope`](tenant.md#tenantscope) |
1739
1984
  | `hostOwnerRoutes` | \| [`Routes`](authorization.md#routes)\<[`OysterEnv`](host.md#oysterenv)\> \| `undefined` |
1740
- | `agents` | \| `Readonly`\<\{ `list`: `Promise`\<readonly `Readonly`\<\{ `agentId`: `string`; `name`: `string`; `avatar`: \{ `v`: `1`; `character`: `"mushroom"` \| `"cat"` \| `"burger"`; `appearance`: `z.ZodRecord`\<`z.ZodString`, `z.ZodUnion`\<readonly ...\>\>; `expression`: `string`; `renderStyle`: \| `"plain"` \| `"pencil"` \| `"manga"` \| `"riso"` \| `"halftone"` \| `"blueprint"` \| `"crt"` \| `"watercolor"`; \}; `sessionOperations`: readonly (`"agent.manage"` \| `"agent.read"` \| `"agent.send"`)[]; \}\>[]\>; `ensureStarter`: `Promise`\<[`StarterOutcome`](agents.md#starteroutcome)\>; `setArchived`: `Promise`\< \| `Readonly`\<\{ `archived`: `boolean`; `revision`: `number`; \}\> \| `Readonly`\<\{ `error`: \| `"archived"` \| `"pending"` \| `"not_found"` \| `"running"` \| `"not_granted"` \| `"self"` \| `"not_creator"` \| `"unreadable"`; `message?`: `string`; `archived?`: `boolean`; `revision?`: `number`; \}\>\>; `create`: `Promise`\<`Readonly`\<\{ `agentId`: `string`; `name`: `string`; `avatar`: \{ `v`: `1`; `character`: `"mushroom"` \| `"cat"` \| `"burger"`; `appearance`: `z.ZodRecord`\<`z.ZodString`, `z.ZodUnion`\<readonly \[..., ..., ...\]\>\>; `expression`: `string`; `renderStyle`: \| `"plain"` \| `"pencil"` \| `"manga"` \| `"riso"` \| `"halftone"` \| `"blueprint"` \| `"crt"` \| `"watercolor"`; \}; `sessionOperations`: readonly (`"agent.manage"` \| `"agent.read"` \| `"agent.send"`)[]; \}\>\>; `rename`: `Promise`\< \| `Readonly`\<\{ `agentId`: `string`; `name`: `string`; `avatar`: \{ `v`: `1`; `character`: `"mushroom"` \| `"cat"` \| `"burger"`; `appearance`: `z.ZodRecord`\<`z.ZodString`, `z.ZodUnion`\<readonly ...\>\>; `expression`: `string`; `renderStyle`: \| `"plain"` \| `"pencil"` \| `"manga"` \| `"riso"` \| `"halftone"` \| `"blueprint"` \| `"crt"` \| `"watercolor"`; \}; `sessionOperations`: readonly (`"agent.manage"` \| `"agent.read"` \| `"agent.send"`)[]; \}\> \| `Readonly`\<\{ `error`: `"not_found"` \| `"not_granted"` \| `"name_taken"`; \}\>\>; `setAvatar`: `Promise`\< \| `Readonly`\<\{ `agentId`: `string`; `name`: `string`; `avatar`: \{ `v`: `1`; `character`: `"mushroom"` \| `"cat"` \| `"burger"`; `appearance`: `z.ZodRecord`\<`z.ZodString`, `z.ZodUnion`\<readonly ...\>\>; `expression`: `string`; `renderStyle`: \| `"plain"` \| `"pencil"` \| `"manga"` \| `"riso"` \| `"halftone"` \| `"blueprint"` \| `"crt"` \| `"watercolor"`; \}; `sessionOperations`: readonly (`"agent.manage"` \| `"agent.read"` \| `"agent.send"`)[]; \}\> \| `Readonly`\<\{ `error`: `"not_found"` \| `"not_granted"`; \}\>\>; `readModelChoice`: `Promise`\< \| \{ `keySource`: `"workers-ai"` \| `"ai-gateway"` \| `"byok"`; `model`: \{ `providerId`: `string`; `modelId`: `string`; `reasoning?`: `"max"` \| `"low"` \| `"medium"` \| `"high"` \| `"minimal"` \| `"xhigh"`; \}; `keyId?`: `string`; \} \| `null`\>; `readInstructions`: `Promise`\< \| `Readonly`\<`object` & `Readonly`\<\{ `home`: `Readonly`\<...\> \| `null`; `content`: `string` \| `null`; `bytes`: `number`; `limit`: `number`; \}\>\> \| `Readonly`\<\{ `error`: `"not_found"` \| `"not_granted"`; \}\>\>; `setInstructions`: `Promise`\< \| `Readonly`\<`object` & `Readonly`\<\{ `home`: `Readonly`\<...\> \| `null`; `content`: `string` \| `null`; `bytes`: `number`; `limit`: `number`; \}\>\> \| `Readonly`\<\{ `error`: `"conflict"` \| `"not_found"` \| `"not_granted"` \| `"too_large"` \| `"no_home"`; \}\>\>; `decodeModelChoice`: \| \{ `keySource`: `"workers-ai"` \| `"ai-gateway"` \| `"byok"`; `model`: \{ `providerId`: `string`; `modelId`: `string`; `reasoning?`: `"max"` \| `"low"` \| `"medium"` \| `"high"` \| `"minimal"` \| `"xhigh"`; \}; `keyId?`: `string`; \} \| `null`; `setModelChoice`: `Promise`\< \| \{ `keySource`: `"workers-ai"` \| `"ai-gateway"` \| `"byok"`; `model`: \{ `providerId`: `string`; `modelId`: `string`; `reasoning?`: `"max"` \| `"low"` \| `"medium"` \| `"high"` \| `"minimal"` \| `"xhigh"`; \}; `keyId?`: `string`; \} \| `Readonly`\<\{ `error`: \| `"not_found"` \| `"not_granted"` \| [`AgentModelRefusal`](agents.md#agentmodelrefusal); \}\>\>; `policyStatus`: `Promise`\< \| `Readonly`\<\{ `status`: `"pending"` \| `"approved"`; `revision`: `string`; \}\> \| `null`\>; `appToolPolicy`: `Promise`\< \| \{ `level`: `"read"` \| `"write"`; `revision`: `string`; `grantedBy`: `string`; \} \| `null`\>; `policyRevision`: `Promise`\<`string` \| `null`\>; `approveAppToolPolicy`: `Promise`\< \| \{ `level`: `"read"` \| `"write"`; `revision`: `string`; `grantedBy`: `string`; \} \| `Readonly`\<\{ `status`: `"pending"`; `revision`: `string`; \}\> \| `Readonly`\<\{ `error`: `"not_found"` \| `"not_granted"` \| `"revision_conflict"`; \}\>\>; `setup`: `Promise`\<`Readonly`\<\{ `models`: `"ready"` \| `"missing"`; `media`: `"ready"` \| `"missing"`; \}\>\>; `modelKeys`: `Promise`\<readonly `Readonly`\<\{ `keyId`: `string`; `provider`: [`StandaloneModelKeyProvider`](agents.md#standalonemodelkeyprovider); `label`: `string`; `createdAt`: `number`; `validatedAt`: `number`; \}\>[]\>; `sealModelKey`: `Promise`\< \| `Readonly`\<\{ `keyId`: `string`; `provider`: [`StandaloneModelKeyProvider`](agents.md#standalonemodelkeyprovider); `label`: `string`; `createdAt`: `number`; `validatedAt`: `number`; \}\> \| `Readonly`\<\{ `error`: [`ModelKeyRefusal`](agents.md#modelkeyrefusal); \}\>\>; `removeModelKey`: `Promise`\<`"deleted"` \| `"absent"`\>; `connections`: `Promise`\<readonly `Readonly`\<\{ `connectionId`: `string`; `name`: `string`; `label`: `string`; `kind`: `"mcp"` \| `"openapi"`; `url`: `string`; `auth`: `"none"` \| `"token"` \| `"oauth"`; `state`: `"pending"` \| `"connected"` \| `"reconnect_required"`; `grants`: readonly `Readonly`\<\{ `agentId`: `string`; `access`: [`ConnectionAccess`](agents.md#connectionaccess); \}\>[]; \}\>[]\>; `addConnection`: `Promise`\< \| `Readonly`\<\{ `connectionId`: `string`; `authorizeUrl`: `string` \| `null`; \}\> \| `Readonly`\<\{ `error`: `"limit"` \| `"not_found"` \| `"duplicate_name"` \| `"invalid_endpoint"`; \}\>\>; `grantConnection`: `Promise`\< \| `Readonly`\<\{ `error`: `"limit"` \| `"not_found"` \| `"duplicate_name"` \| `"invalid_endpoint"`; \}\> \| `Readonly`\<\{ `ok`: `true`; \}\>\>; `ungrantConnection`: `Promise`\<`boolean`\>; `removeConnection`: `Promise`\<`boolean`\>; `connectionTools`: `Promise`\< \| readonly `string`[] \| `Readonly`\<\{ `error`: `"limit"` \| `"not_found"` \| `"duplicate_name"` \| `"invalid_endpoint"`; \}\>\>; `completeMcpConnection`: `Promise`\< \| `Readonly`\<\{ `ok`: `true`; \}\> \| `Readonly`\<\{ `error`: `string`; \}\>\>; `mcpCallbackUrl`: `string`; `fetch`: `Promise`\<`Response` \| `null`\>; `inbox`: `Promise`\<`Readonly`\<\{ `items`: readonly ( \| \{ `agentId`: `string`; `sessionId`: `string`; `title`: `string`; `triggerId?`: `string`; `createdAt`: `number`; `lastActivityAt`: `number`; `settledAt?`: `number`; `visitedAt?`: `number`; `state`: `"running"` \| `"done"` \| `"errored"` \| `"needs_you"`; \} \| \{ `agentId`: `string`; `sessionId`: `string`; `state`: `"unavailable"`; \} \| \{ `kind`: `"workflow-review"`; `key`: \{ `runId`: `string`; `nodeId`: `string`; `iteration`: `string`; \}; `installationId`: `string`; `workflowId`: `string` \| `null`; `workflowTitle`: `string`; `reviewTitle`: `string`; `reviewers`: `"owners"` \| `"runner"`; `show`: readonly `Json`[]; `choices?`: readonly ...[]; `openedAt`: `number`; `expiresAt`: `number`; `state`: `"pending"` \| `"delivered"` \| `"answered"` \| `"timed_out"` \| `"closed"`; \})[]; `revision`: `number`; \}\>\>; `revision`: `Promise`\<`number`\>; `visit`: `Promise`\<`boolean`\>; \}\> \| `undefined` |
1985
+ | `agents` | \| `Readonly`\<\{ `list`: `Promise`\<readonly `Readonly`\<\{ `agentId`: `string`; `name`: `string`; `avatar`: \{ `v`: `1`; `character`: `"mushroom"` \| `"cat"` \| `"burger"`; `appearance`: `z.ZodRecord`\<`z.ZodString`, `z.ZodUnion`\<readonly ...\>\>; `expression`: `string`; `renderStyle`: \| `"plain"` \| `"pencil"` \| `"manga"` \| `"riso"` \| `"halftone"` \| `"blueprint"` \| `"crt"` \| `"watercolor"`; \}; `sessionOperations`: readonly (`"agent.manage"` \| `"agent.read"` \| `"agent.send"`)[]; \}\>[]\>; `ensureStarter`: `Promise`\<[`StarterOutcome`](agents.md#starteroutcome)\>; `setArchived`: `Promise`\< \| `Readonly`\<\{ `archived`: `boolean`; `revision`: `number`; \}\> \| `Readonly`\<\{ `error`: \| `"archived"` \| `"pending"` \| `"not_found"` \| `"running"` \| `"not_granted"` \| `"self"` \| `"not_creator"` \| `"unreadable"`; `message?`: `string`; `archived?`: `boolean`; `revision?`: `number`; \}\>\>; `create`: `Promise`\<`Readonly`\<\{ `agentId`: `string`; `name`: `string`; `avatar`: \{ `v`: `1`; `character`: `"mushroom"` \| `"cat"` \| `"burger"`; `appearance`: `z.ZodRecord`\<`z.ZodString`, `z.ZodUnion`\<readonly \[..., ..., ...\]\>\>; `expression`: `string`; `renderStyle`: \| `"plain"` \| `"pencil"` \| `"manga"` \| `"riso"` \| `"halftone"` \| `"blueprint"` \| `"crt"` \| `"watercolor"`; \}; `sessionOperations`: readonly (`"agent.manage"` \| `"agent.read"` \| `"agent.send"`)[]; \}\>\>; `rename`: `Promise`\< \| `Readonly`\<\{ `agentId`: `string`; `name`: `string`; `avatar`: \{ `v`: `1`; `character`: `"mushroom"` \| `"cat"` \| `"burger"`; `appearance`: `z.ZodRecord`\<`z.ZodString`, `z.ZodUnion`\<readonly ...\>\>; `expression`: `string`; `renderStyle`: \| `"plain"` \| `"pencil"` \| `"manga"` \| `"riso"` \| `"halftone"` \| `"blueprint"` \| `"crt"` \| `"watercolor"`; \}; `sessionOperations`: readonly (`"agent.manage"` \| `"agent.read"` \| `"agent.send"`)[]; \}\> \| `Readonly`\<\{ `error`: `"not_found"` \| `"not_granted"` \| `"name_taken"`; \}\>\>; `setAvatar`: `Promise`\< \| `Readonly`\<\{ `agentId`: `string`; `name`: `string`; `avatar`: \{ `v`: `1`; `character`: `"mushroom"` \| `"cat"` \| `"burger"`; `appearance`: `z.ZodRecord`\<`z.ZodString`, `z.ZodUnion`\<readonly ...\>\>; `expression`: `string`; `renderStyle`: \| `"plain"` \| `"pencil"` \| `"manga"` \| `"riso"` \| `"halftone"` \| `"blueprint"` \| `"crt"` \| `"watercolor"`; \}; `sessionOperations`: readonly (`"agent.manage"` \| `"agent.read"` \| `"agent.send"`)[]; \}\> \| `Readonly`\<\{ `error`: `"not_found"` \| `"not_granted"`; \}\>\>; `readModelChoice`: `Promise`\< \| \{ `keySource`: `"workers-ai"` \| `"ai-gateway"` \| `"byok"`; `model`: \{ `providerId`: `string`; `modelId`: `string`; `reasoning?`: `"max"` \| `"low"` \| `"medium"` \| `"high"` \| `"minimal"` \| `"xhigh"`; \}; `keyId?`: `string`; \} \| `null`\>; `readInstructions`: `Promise`\< \| `Readonly`\<`object` & `Readonly`\<\{ `home`: `Readonly`\<...\> \| `null`; `content`: `string` \| `null`; `bytes`: `number`; `limit`: `number`; \}\>\> \| `Readonly`\<\{ `error`: `"not_found"` \| `"not_granted"`; \}\>\>; `setInstructions`: `Promise`\< \| `Readonly`\<`object` & `Readonly`\<\{ `home`: `Readonly`\<...\> \| `null`; `content`: `string` \| `null`; `bytes`: `number`; `limit`: `number`; \}\>\> \| `Readonly`\<\{ `error`: `"conflict"` \| `"not_found"` \| `"not_granted"` \| `"too_large"` \| `"no_home"`; \}\>\>; `decodeModelChoice`: \| \{ `keySource`: `"workers-ai"` \| `"ai-gateway"` \| `"byok"`; `model`: \{ `providerId`: `string`; `modelId`: `string`; `reasoning?`: `"max"` \| `"low"` \| `"medium"` \| `"high"` \| `"minimal"` \| `"xhigh"`; \}; `keyId?`: `string`; \} \| `null`; `setModelChoice`: `Promise`\< \| \{ `keySource`: `"workers-ai"` \| `"ai-gateway"` \| `"byok"`; `model`: \{ `providerId`: `string`; `modelId`: `string`; `reasoning?`: `"max"` \| `"low"` \| `"medium"` \| `"high"` \| `"minimal"` \| `"xhigh"`; \}; `keyId?`: `string`; \} \| `Readonly`\<\{ `error`: \| `"not_found"` \| `"not_granted"` \| [`AgentModelRefusal`](agents.md#agentmodelrefusal); \}\>\>; `policyStatus`: `Promise`\< \| `Readonly`\<\{ `status`: `"pending"` \| `"approved"`; `revision`: `string`; \}\> \| `null`\>; `appToolPolicy`: `Promise`\< \| \{ `level`: `"read"` \| `"write"`; `revision`: `string`; `grantedBy`: `string`; \} \| `null`\>; `policyRevision`: `Promise`\<`string` \| `null`\>; `approveAppToolPolicy`: `Promise`\< \| \{ `level`: `"read"` \| `"write"`; `revision`: `string`; `grantedBy`: `string`; \} \| `Readonly`\<\{ `status`: `"pending"`; `revision`: `string`; \}\> \| `Readonly`\<\{ `error`: `"not_found"` \| `"not_granted"` \| `"revision_conflict"`; \}\>\>; `setup`: `Promise`\<`Readonly`\<\{ `models`: `"ready"` \| `"missing"`; `media`: `"ready"` \| `"missing"`; \}\>\>; `modelKeys`: `Promise`\<readonly `Readonly`\<\{ `keyId`: `string`; `provider`: [`StandaloneModelKeyProvider`](agents.md#standalonemodelkeyprovider); `label`: `string`; `createdAt`: `number`; `validatedAt`: `number`; \}\>[]\>; `sealModelKey`: `Promise`\< \| `Readonly`\<\{ `keyId`: `string`; `provider`: [`StandaloneModelKeyProvider`](agents.md#standalonemodelkeyprovider); `label`: `string`; `createdAt`: `number`; `validatedAt`: `number`; \}\> \| `Readonly`\<\{ `error`: [`ModelKeyRefusal`](agents.md#modelkeyrefusal); \}\>\>; `removeModelKey`: `Promise`\<`"deleted"` \| `"absent"`\>; `connections`: `Promise`\<readonly `Readonly`\<\{ `connectionId`: `string`; `name`: `string`; `label`: `string`; `kind`: `"mcp"` \| `"openapi"`; `url`: `string`; `auth`: `"none"` \| `"token"` \| `"oauth"`; `state`: `"pending"` \| `"connected"` \| `"reconnect_required"`; `grants`: readonly `Readonly`\<\{ `agentId`: `string`; `access`: [`ConnectionAccess`](agents.md#connectionaccess); \}\>[]; \}\>[]\>; `addConnection`: `Promise`\< \| `Readonly`\<\{ `connectionId`: `string`; `authorizeUrl`: `string` \| `null`; \}\> \| `Readonly`\<\{ `error`: `"limit"` \| `"not_found"` \| `"duplicate_name"` \| `"invalid_endpoint"`; \}\>\>; `grantConnection`: `Promise`\< \| `Readonly`\<\{ `error`: `"limit"` \| `"not_found"` \| `"duplicate_name"` \| `"invalid_endpoint"`; \}\> \| `Readonly`\<\{ `ok`: `true`; \}\>\>; `ungrantConnection`: `Promise`\<`boolean`\>; `removeConnection`: `Promise`\<`boolean`\>; `connectionTools`: `Promise`\< \| readonly `string`[] \| `Readonly`\<\{ `error`: `"limit"` \| `"not_found"` \| `"duplicate_name"` \| `"invalid_endpoint"`; \}\>\>; `completeMcpConnection`: `Promise`\< \| `Readonly`\<\{ `ok`: `true`; \}\> \| `Readonly`\<\{ `error`: `string`; \}\>\>; `mcpCallbackUrl`: `string`; `fetch`: `Promise`\<`Response` \| `null`\>; `inbox`: `Promise`\<`Readonly`\<\{ `items`: readonly ( \| \{ `agentId`: `string`; `sessionId`: `string`; `title`: `string`; `triggerId?`: `string`; `createdAt`: `number`; `lastActivityAt`: `number`; `settledAt?`: `number`; `visitedAt?`: `number`; `state`: `"running"` \| `"done"` \| `"errored"` \| `"needs_you"`; \} \| \{ `agentId`: `string`; `sessionId`: `string`; `state`: `"unavailable"`; \} \| \{ `kind`: `"workflow-review"`; `key`: \{ `runId`: `string`; `nodeId`: `string`; `iteration`: `string`; \}; `installationId`: `string`; `workflowId`: `string` \| `null`; `workflowTitle`: `string`; `reviewTitle`: `string`; `reviewers`: `"owners"` \| `"runner"`; `show`: readonly `Json`[]; `choices?`: readonly ...[]; `openedAt`: `number`; `expiresAt`: `number`; `state`: `"pending"` \| `"closed"` \| `"delivered"` \| `"answered"` \| `"timed_out"`; \})[]; `revision`: `number`; \}\>\>; `revision`: `Promise`\<`number`\>; `visit`: `Promise`\<`boolean`\>; \}\> \| `undefined` |
1741
1986
  | `computerSetup?` | () => `Promise`\<`Pick`\<`Readonly`\<\{ `models`: `SetupState`; `media`: `SetupState`; `git`: `SetupState`; `terminal`: `"unknown"` \| `"ready"` \| `"missing"` \| `"exec-only"`; `terminalReason?`: `string`; \}\>, `"terminal"` \| `"terminalReason"`\>\> |
1742
1987
 
1743
1988
  #### Returns