@fungi.computer/agar 0.2.0 → 0.3.1
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.
- package/README.md +34 -18
- package/dist/agent-message-meta.d.ts +6 -1
- package/dist/agent-message-meta.js +12 -1
- package/dist/approvals.d.ts +5 -0
- package/dist/approvals.js +36 -0
- package/dist/backend-refusal.d.ts +1 -0
- package/dist/backend-refusal.js +1 -0
- package/dist/computer-contracts.d.ts +0 -17
- package/dist/computer-contracts.js +0 -19
- package/dist/connect.d.ts +3 -3
- package/dist/connect.js +7 -17
- package/dist/errors.d.ts +39 -1
- package/dist/errors.js +62 -5
- package/dist/index.d.ts +3 -0
- package/dist/index.js +2 -0
- package/dist/internal/media-diagnostic.d.ts +11 -0
- package/dist/internal/media-diagnostic.js +21 -0
- package/dist/internal/schemas.d.ts +7 -0
- package/dist/internal/schemas.js +17 -21
- package/dist/media-json.d.ts +14 -0
- package/dist/media-json.js +1 -0
- package/dist/media.d.ts +11 -0
- package/dist/media.js +6 -0
- package/dist/query.d.ts +2 -2
- package/dist/react-mount.d.ts +7 -1
- package/dist/react-mount.js +28 -8
- package/dist/window.d.ts +4 -0
- package/docs/api/README.md +15 -15
- package/docs/api/backend-definition.md +3 -3
- package/docs/api/backend.md +1 -0
- package/docs/api/errors.md +104 -0
- package/docs/api/index.md +87 -26
- package/docs/api/media-json.md +32 -59
- package/docs/api/query.md +1 -1
- package/docs/api/react.md +13 -6
- package/package.json +12 -7
package/docs/api/index.md
CHANGED
|
@@ -62,7 +62,9 @@ Any JSON value, as Shiitake returns a message's metadata.
|
|
|
62
62
|
|
|
63
63
|
```ts
|
|
64
64
|
type AuthorMeta = Readonly<{
|
|
65
|
-
author: Readonly<
|
|
65
|
+
author: Readonly<{
|
|
66
|
+
[K in keyof FungiAuthor]: Exclude<FungiAuthor[K], undefined>;
|
|
67
|
+
}>;
|
|
66
68
|
}>;
|
|
67
69
|
```
|
|
68
70
|
|
|
@@ -734,17 +736,17 @@ accepts it. Call the returned Disposer to unregister.
|
|
|
734
736
|
|
|
735
737
|
###### Parameters
|
|
736
738
|
|
|
737
|
-
| Parameter | Type
|
|
738
|
-
| ----------------------- |
|
|
739
|
-
| `command` | \{ `id`: `z.ZodLazy`\<`z.ZodString`\>; `title`: `z.ZodLazy`\<`z.ZodString`\>; `category`: `z.ZodLazy`\<`z.ZodString`\>; `description?`: `z.ZodOptional`\<`z.ZodLazy`\<`z.ZodString`\>\>; `projections?`: `z.ZodOptional`\<`z.ZodLazy`\<`z.ZodObject`\<\{ `bindings`: `z.ZodOptional`\<`z.ZodObject`\<\{ `order`: `z.ZodOptional`\<`z.ZodLazy`\<...\>\>; `values`: `z.ZodArray`\<`z.ZodLazy`\<...\>\>; \}, `z.core.$strict`\>\>; `agent`: `z.ZodOptional`\<`z.ZodObject`\<\{ `keybind`: `z.ZodOptional`\<`z.ZodLazy`\<...\>\>; `order`: `z.ZodOptional`\<`z.ZodLazy`\<...\>\>; \}, `z.core.$strict`\>\>; `help`: `z.ZodOptional`\<`z.ZodLazy`\<`z.ZodObject`\<\{ `order`: `z.ZodOptional`\<...\>; \}, `z.core.$strict`\>\>\>; `menu`: `z.ZodOptional`\<`z.ZodLazy`\<`z.ZodObject`\<\{ `order`: `z.ZodOptional`\<...\>; \}, `z.core.$strict`\>\>\>; `palette`: `z.ZodOptional`\<`z.ZodLazy`\<`z.ZodObject`\<\{ `order`: `z.ZodOptional`\<...\>; \}, `z.core.$strict`\>\>\>; `slash`: `z.ZodOptional`\<`z.ZodObject`\<\{ `aliases`: `z.ZodArray`\<`z.ZodLazy`\<...\>\>; `order`: `z.ZodOptional`\<`z.ZodLazy`\<...\>\>; `arguments`: `z.ZodOptional`\<`z.ZodLazy`\<...\>\>; \}, `z.core.$strict`\>\>; \}, `z.core.$strict`\>\>\>; `action?`: `z.ZodOptional`\<`z.ZodLazy`\<`z.ZodObject`\<\{ `inputSchema`: `z.ZodOptional`\<`z.ZodLazy`\<`z.ZodRecord`\<`z.ZodString`, `z.ZodJSONSchema`\>\>\>; `outputSchema`: `z.ZodOptional`\<`z.ZodLazy`\<`z.ZodRecord`\<`z.ZodString`, `z.ZodJSONSchema`\>\>\>; `presentation`: `z.ZodOptional`\<`z.ZodLazy`\<`z.ZodUnion`\<readonly \[..., ..., ..., ..., ...\]\>\>\>; \}, `z.core.$strict`\>\>\>; `availability?`: `z.ZodOptional`\<`z.ZodLazy`\<`z.ZodDiscriminatedUnion`\<\[`z.ZodObject`\<\{ `status`: `z.ZodLiteral`\<`"available"`\>; \}, `z.core.$strict`\>, `z.ZodObject`\<\{ `status`: `z.ZodLiteral`\<`"unavailable"`\>; `reason`: `z.ZodString`; \}, `z.core.$strict`\>\], `"status"`\>\>\>; \} |
|
|
740
|
-
| `command.id` | `z.ZodLazy`\<`z.ZodString`\>
|
|
741
|
-
| `command.title` | `z.ZodLazy`\<`z.ZodString`\>
|
|
742
|
-
| `command.category` | `z.ZodLazy`\<`z.ZodString`\>
|
|
743
|
-
| `command.description?` | `z.ZodOptional`\<`z.ZodLazy`\<`z.ZodString`\>\>
|
|
744
|
-
| `command.projections?` | `z.ZodOptional`\<`z.ZodLazy`\<`z.ZodObject`\<\{ `bindings`: `z.ZodOptional`\<`z.ZodObject`\<\{ `order`: `z.ZodOptional`\<`z.ZodLazy`\<...\>\>; `values`: `z.ZodArray`\<`z.ZodLazy`\<...\>\>; \}, `z.core.$strict`\>\>; `agent`: `z.ZodOptional`\<`z.ZodObject`\<\{ `keybind`: `z.ZodOptional`\<`z.ZodLazy`\<...\>\>; `order`: `z.ZodOptional`\<`z.ZodLazy`\<...\>\>; \}, `z.core.$strict`\>\>; `help`: `z.ZodOptional`\<`z.ZodLazy`\<`z.ZodObject`\<\{ `order`: `z.ZodOptional`\<...\>; \}, `z.core.$strict`\>\>\>; `menu`: `z.ZodOptional`\<`z.ZodLazy`\<`z.ZodObject`\<\{ `order`: `z.ZodOptional`\<...\>; \}, `z.core.$strict`\>\>\>; `palette`: `z.ZodOptional`\<`z.ZodLazy`\<`z.ZodObject`\<\{ `order`: `z.ZodOptional`\<...\>; \}, `z.core.$strict`\>\>\>; `slash`: `z.ZodOptional`\<`z.ZodObject`\<\{ `aliases`: `z.ZodArray`\<`z.ZodLazy`\<...\>\>; `order`: `z.ZodOptional`\<`z.ZodLazy`\<...\>\>; `arguments`: `z.ZodOptional`\<`z.ZodLazy`\<...\>\>; \}, `z.core.$strict`\>\>; \}, `z.core.$strict`\>\>\> |
|
|
745
|
-
| `command.action?` | `z.ZodOptional`\<`z.ZodLazy`\<`z.ZodObject`\<\{ `inputSchema`: `z.ZodOptional`\<`z.ZodLazy`\<`z.ZodRecord`\<`z.ZodString`, `z.ZodJSONSchema`\>\>\>; `outputSchema`: `z.ZodOptional`\<`z.ZodLazy`\<`z.ZodRecord`\<`z.ZodString`, `z.ZodJSONSchema`\>\>\>; `presentation`: `z.ZodOptional`\<`z.ZodLazy`\<`z.ZodUnion`\<readonly \[..., ..., ..., ..., ...\]\>\>\>; \}, `z.core.$strict`\>\>\>
|
|
746
|
-
| `command.availability?` | `z.ZodOptional`\<`z.ZodLazy`\<`z.ZodDiscriminatedUnion`\<\[`z.ZodObject`\<\{ `status`: `z.ZodLiteral`\<`"available"`\>; \}, `z.core.$strict`\>, `z.ZodObject`\<\{ `status`: `z.ZodLiteral`\<`"unavailable"`\>; `reason`: `z.ZodString`; \}, `z.core.$strict`\>\], `"status"`\>\>\>
|
|
747
|
-
| `handler` | [`AppCommandHandler`](#appcommandhandler)
|
|
739
|
+
| Parameter | Type |
|
|
740
|
+
| ----------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
741
|
+
| `command` | \{ `id`: `z.ZodLazy`\<`z.ZodString`\>; `title`: `z.ZodLazy`\<`z.ZodString`\>; `category`: `z.ZodLazy`\<`z.ZodString`\>; `description?`: `z.ZodOptional`\<`z.ZodLazy`\<`z.ZodString`\>\>; `projections?`: `z.ZodOptional`\<`z.ZodLazy`\<`z.ZodObject`\<\{ `bindings`: `z.ZodOptional`\<`z.ZodObject`\<\{ `order`: `z.ZodOptional`\<`z.ZodLazy`\<...\>\>; `values`: `z.ZodArray`\<`z.ZodLazy`\<...\>\>; \}, `z.core.$strict`\>\>; `agent`: `z.ZodOptional`\<`z.ZodObject`\<\{ `keybind`: `z.ZodOptional`\<`z.ZodLazy`\<...\>\>; `order`: `z.ZodOptional`\<`z.ZodLazy`\<...\>\>; \}, `z.core.$strict`\>\>; `help`: `z.ZodOptional`\<`z.ZodLazy`\<`z.ZodObject`\<\{ `order`: `z.ZodOptional`\<...\>; \}, `z.core.$strict`\>\>\>; `menu`: `z.ZodOptional`\<`z.ZodLazy`\<`z.ZodObject`\<\{ `order`: `z.ZodOptional`\<...\>; \}, `z.core.$strict`\>\>\>; `palette`: `z.ZodOptional`\<`z.ZodLazy`\<`z.ZodObject`\<\{ `order`: `z.ZodOptional`\<...\>; \}, `z.core.$strict`\>\>\>; `slash`: `z.ZodOptional`\<`z.ZodObject`\<\{ `aliases`: `z.ZodArray`\<`z.ZodLazy`\<...\>\>; `consumesDraft`: `z.ZodOptional`\<`z.ZodBoolean`\>; `order`: `z.ZodOptional`\<`z.ZodLazy`\<...\>\>; `arguments`: `z.ZodOptional`\<`z.ZodLazy`\<...\>\>; \}, `z.core.$strict`\>\>; \}, `z.core.$strict`\>\>\>; `action?`: `z.ZodOptional`\<`z.ZodLazy`\<`z.ZodObject`\<\{ `inputSchema`: `z.ZodOptional`\<`z.ZodLazy`\<`z.ZodRecord`\<`z.ZodString`, `z.ZodJSONSchema`\>\>\>; `outputSchema`: `z.ZodOptional`\<`z.ZodLazy`\<`z.ZodRecord`\<`z.ZodString`, `z.ZodJSONSchema`\>\>\>; `presentation`: `z.ZodOptional`\<`z.ZodLazy`\<`z.ZodUnion`\<readonly \[..., ..., ..., ..., ...\]\>\>\>; \}, `z.core.$strict`\>\>\>; `availability?`: `z.ZodOptional`\<`z.ZodLazy`\<`z.ZodDiscriminatedUnion`\<\[`z.ZodObject`\<\{ `status`: `z.ZodLiteral`\<`"available"`\>; \}, `z.core.$strict`\>, `z.ZodObject`\<\{ `status`: `z.ZodLiteral`\<`"unavailable"`\>; `reason`: `z.ZodString`; \}, `z.core.$strict`\>\], `"status"`\>\>\>; \} |
|
|
742
|
+
| `command.id` | `z.ZodLazy`\<`z.ZodString`\> |
|
|
743
|
+
| `command.title` | `z.ZodLazy`\<`z.ZodString`\> |
|
|
744
|
+
| `command.category` | `z.ZodLazy`\<`z.ZodString`\> |
|
|
745
|
+
| `command.description?` | `z.ZodOptional`\<`z.ZodLazy`\<`z.ZodString`\>\> |
|
|
746
|
+
| `command.projections?` | `z.ZodOptional`\<`z.ZodLazy`\<`z.ZodObject`\<\{ `bindings`: `z.ZodOptional`\<`z.ZodObject`\<\{ `order`: `z.ZodOptional`\<`z.ZodLazy`\<...\>\>; `values`: `z.ZodArray`\<`z.ZodLazy`\<...\>\>; \}, `z.core.$strict`\>\>; `agent`: `z.ZodOptional`\<`z.ZodObject`\<\{ `keybind`: `z.ZodOptional`\<`z.ZodLazy`\<...\>\>; `order`: `z.ZodOptional`\<`z.ZodLazy`\<...\>\>; \}, `z.core.$strict`\>\>; `help`: `z.ZodOptional`\<`z.ZodLazy`\<`z.ZodObject`\<\{ `order`: `z.ZodOptional`\<...\>; \}, `z.core.$strict`\>\>\>; `menu`: `z.ZodOptional`\<`z.ZodLazy`\<`z.ZodObject`\<\{ `order`: `z.ZodOptional`\<...\>; \}, `z.core.$strict`\>\>\>; `palette`: `z.ZodOptional`\<`z.ZodLazy`\<`z.ZodObject`\<\{ `order`: `z.ZodOptional`\<...\>; \}, `z.core.$strict`\>\>\>; `slash`: `z.ZodOptional`\<`z.ZodObject`\<\{ `aliases`: `z.ZodArray`\<`z.ZodLazy`\<...\>\>; `consumesDraft`: `z.ZodOptional`\<`z.ZodBoolean`\>; `order`: `z.ZodOptional`\<`z.ZodLazy`\<...\>\>; `arguments`: `z.ZodOptional`\<`z.ZodLazy`\<...\>\>; \}, `z.core.$strict`\>\>; \}, `z.core.$strict`\>\>\> |
|
|
747
|
+
| `command.action?` | `z.ZodOptional`\<`z.ZodLazy`\<`z.ZodObject`\<\{ `inputSchema`: `z.ZodOptional`\<`z.ZodLazy`\<`z.ZodRecord`\<`z.ZodString`, `z.ZodJSONSchema`\>\>\>; `outputSchema`: `z.ZodOptional`\<`z.ZodLazy`\<`z.ZodRecord`\<`z.ZodString`, `z.ZodJSONSchema`\>\>\>; `presentation`: `z.ZodOptional`\<`z.ZodLazy`\<`z.ZodUnion`\<readonly \[..., ..., ..., ..., ...\]\>\>\>; \}, `z.core.$strict`\>\>\> |
|
|
748
|
+
| `command.availability?` | `z.ZodOptional`\<`z.ZodLazy`\<`z.ZodDiscriminatedUnion`\<\[`z.ZodObject`\<\{ `status`: `z.ZodLiteral`\<`"available"`\>; \}, `z.core.$strict`\>, `z.ZodObject`\<\{ `status`: `z.ZodLiteral`\<`"unavailable"`\>; `reason`: `z.ZodString`; \}, `z.core.$strict`\>\], `"status"`\>\>\> |
|
|
749
|
+
| `handler` | [`AppCommandHandler`](#appcommandhandler) |
|
|
748
750
|
|
|
749
751
|
###### Returns
|
|
750
752
|
|
|
@@ -762,14 +764,14 @@ Options for connecting this iframe page to its authenticated host.
|
|
|
762
764
|
|
|
763
765
|
#### Properties
|
|
764
766
|
|
|
765
|
-
#####
|
|
767
|
+
##### host
|
|
766
768
|
|
|
767
769
|
```ts
|
|
768
|
-
readonly
|
|
770
|
+
readonly host: "parent";
|
|
769
771
|
```
|
|
770
772
|
|
|
771
|
-
The
|
|
772
|
-
|
|
773
|
+
The parent is the host. Serve the App with CSP `frame-ancestors` pinned to its
|
|
774
|
+
allowed host so an unrelated site cannot become its parent.
|
|
773
775
|
|
|
774
776
|
##### signal?
|
|
775
777
|
|
|
@@ -1897,6 +1899,7 @@ One place in the App's path; `siblings` makes it a switcher.
|
|
|
1897
1899
|
type AppHeaderCommand = Readonly<{
|
|
1898
1900
|
id: string;
|
|
1899
1901
|
label: string;
|
|
1902
|
+
icon?: "play";
|
|
1900
1903
|
variant?: "primary" | "outline" | "ghost";
|
|
1901
1904
|
tone?: "destructive";
|
|
1902
1905
|
disabled?: boolean;
|
|
@@ -1913,6 +1916,7 @@ A command the App offers in its window header; the App owns its effect.
|
|
|
1913
1916
|
type AppHeaderStatus = Readonly<{
|
|
1914
1917
|
id: string;
|
|
1915
1918
|
label: string;
|
|
1919
|
+
presentation?: "bead";
|
|
1916
1920
|
tone?: "neutral" | "info" | "warning" | "success" | "error";
|
|
1917
1921
|
}>;
|
|
1918
1922
|
```
|
|
@@ -2039,6 +2043,7 @@ const FungiAuthorSchema: ZodLazy<
|
|
|
2039
2043
|
{
|
|
2040
2044
|
id: ZodString;
|
|
2041
2045
|
name: ZodString;
|
|
2046
|
+
kind: ZodOptional<ZodLiteral<"agent">>;
|
|
2042
2047
|
},
|
|
2043
2048
|
$strict
|
|
2044
2049
|
>
|
|
@@ -2085,7 +2090,9 @@ const FungiMessageMetaSchema: ZodObject<{
|
|
|
2085
2090
|
author: ZodOptional<ZodLazy<ZodObject<{
|
|
2086
2091
|
id: ZodString;
|
|
2087
2092
|
name: ZodString;
|
|
2093
|
+
kind: ZodOptional<ZodLiteral<"agent">>;
|
|
2088
2094
|
}, $strict>>>;
|
|
2095
|
+
sourceRequestId: ZodOptional<ZodLazy<ZodString>>;
|
|
2089
2096
|
delegation: ZodOptional<ZodObject<{
|
|
2090
2097
|
ancestors: ZodArray<ZodLazy<ZodString>>;
|
|
2091
2098
|
maxDepth: ZodNumber;
|
|
@@ -2483,6 +2490,17 @@ and send to it, including the member's inbox feed.
|
|
|
2483
2490
|
|
|
2484
2491
|
---
|
|
2485
2492
|
|
|
2493
|
+
### approvals
|
|
2494
|
+
|
|
2495
|
+
```ts
|
|
2496
|
+
const approvals: CapabilityContract<Approvals>;
|
|
2497
|
+
```
|
|
2498
|
+
|
|
2499
|
+
Member-bound approval view. Authentication and current rights belong to the
|
|
2500
|
+
host.
|
|
2501
|
+
|
|
2502
|
+
---
|
|
2503
|
+
|
|
2486
2504
|
### APP\_PROTOCOL\_VERSION
|
|
2487
2505
|
|
|
2488
2506
|
```ts
|
|
@@ -2698,6 +2716,29 @@ const mediaGenerationFailureSchema: Struct<{
|
|
|
2698
2716
|
]
|
|
2699
2717
|
>
|
|
2700
2718
|
>;
|
|
2719
|
+
provider: optional<
|
|
2720
|
+
Union<
|
|
2721
|
+
readonly [
|
|
2722
|
+
Struct<{
|
|
2723
|
+
category: Literals<
|
|
2724
|
+
readonly [
|
|
2725
|
+
"InferenceUpstreamError",
|
|
2726
|
+
"AiInternalError",
|
|
2727
|
+
"TypeError",
|
|
2728
|
+
"AbortError",
|
|
2729
|
+
"TimeoutError",
|
|
2730
|
+
"Error",
|
|
2731
|
+
]
|
|
2732
|
+
>;
|
|
2733
|
+
code: NullOr<Int>;
|
|
2734
|
+
}>,
|
|
2735
|
+
Struct<{
|
|
2736
|
+
category: Literal<"result_download">;
|
|
2737
|
+
status: Int;
|
|
2738
|
+
}>,
|
|
2739
|
+
]
|
|
2740
|
+
>
|
|
2741
|
+
>;
|
|
2701
2742
|
code: Literals<
|
|
2702
2743
|
readonly [
|
|
2703
2744
|
"CANCELLED",
|
|
@@ -2950,6 +2991,7 @@ function messageAuthor(meta):
|
|
|
2950
2991
|
| {
|
|
2951
2992
|
id: string;
|
|
2952
2993
|
name: string;
|
|
2994
|
+
kind?: "agent";
|
|
2953
2995
|
}
|
|
2954
2996
|
| undefined;
|
|
2955
2997
|
```
|
|
@@ -2964,7 +3006,25 @@ The author a message's metadata names; none for anything else.
|
|
|
2964
3006
|
|
|
2965
3007
|
#### Returns
|
|
2966
3008
|
|
|
2967
|
-
|
|
3009
|
+
##### Type Literal
|
|
3010
|
+
|
|
3011
|
+
```ts
|
|
3012
|
+
{
|
|
3013
|
+
id: string;
|
|
3014
|
+
name: string;
|
|
3015
|
+
kind?: "agent";
|
|
3016
|
+
}
|
|
3017
|
+
```
|
|
3018
|
+
|
|
3019
|
+
| Name | Type | Description |
|
|
3020
|
+
| ------- | --------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
3021
|
+
| `id` | `string` | - |
|
|
3022
|
+
| `name` | `string` | - |
|
|
3023
|
+
| `kind?` | `"agent"` | Present only when the author is another Agent the host admitted a delegated send or reply from; a line's text never sets it. Human authors carry no kind. |
|
|
3024
|
+
|
|
3025
|
+
---
|
|
3026
|
+
|
|
3027
|
+
`undefined`
|
|
2968
3028
|
|
|
2969
3029
|
---
|
|
2970
3030
|
|
|
@@ -3034,11 +3094,12 @@ The metadata the host attaches for one authenticated author.
|
|
|
3034
3094
|
|
|
3035
3095
|
#### Parameters
|
|
3036
3096
|
|
|
3037
|
-
| Parameter
|
|
3038
|
-
|
|
|
3039
|
-
| `author`
|
|
3040
|
-
| `author.id`
|
|
3041
|
-
| `author.name`
|
|
3097
|
+
| Parameter | Type | Description |
|
|
3098
|
+
| -------------- | ----------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
3099
|
+
| `author` | \{ `id`: `string`; `name`: `string`; `kind?`: `"agent"`; \} | - |
|
|
3100
|
+
| `author.id` | `string` | - |
|
|
3101
|
+
| `author.name` | `string` | - |
|
|
3102
|
+
| `author.kind?` | `"agent"` | Present only when the author is another Agent the host admitted a delegated send or reply from; a line's text never sets it. Human authors carry no kind. |
|
|
3042
3103
|
|
|
3043
3104
|
#### Returns
|
|
3044
3105
|
|
|
@@ -3315,10 +3376,10 @@ register again to publish a change.
|
|
|
3315
3376
|
|
|
3316
3377
|
#### Parameters
|
|
3317
3378
|
|
|
3318
|
-
| Parameter | Type
|
|
3319
|
-
| ---------- |
|
|
3320
|
-
| `commands` | [`AppCommands`](#appcommands)
|
|
3321
|
-
| `catalog` | readonly `Readonly`\<\{ `id`: `string`; `title`: `string`; `category`: `string`; `description?`: `string`; `projections?`: \{ `bindings?`: \{ `order?`: `number`; `values`: readonly `string`[]; \}; `agent?`: \{ `keybind?`: `string`; `order?`: `number`; \}; `help?`: \{ `order?`: `number`; \}; `menu?`: \{ `order?`: `number`; \}; `palette?`: \{ `order?`: `number`; \}; `slash?`: \{ `aliases`: readonly `string`[]; `order?`: `number`; `arguments?`: \{ `hint`: `string`; `words?`: readonly ...[]; `text?`: \{ `field`: ...; `arguments`: ...; `requestIdField?`: ...; \}; \}; \}; \}; `action?`: \{ `inputSchema?`: \{ \[`key`: `string`\]: \| `string` \| `number` \| `boolean` \| readonly string \| number \| boolean \| readonly (string \| number \| boolean \| readonly (string \| number \| boolean \| readonly (string \| number \| boolean \| readonly (string \| number \| boolean \| readonly (string \| number \| boolean \| readonly (string \| ... 4 more ... \| null)\[\] \| \{ ...; \} \| null)\[\] \| \{ ...; \} \| null)\[\] \| \{ ...; \} \| ...[] \| \{ \[`key`: `string`\]: string \| number \| boolean \| readonly (string \| number \| boolean \| readonly (string \| number \| boolean \| readonly (string \| number \| boolean \| readonly (string \| number \| boolean \| readonly (string \| number \| boolean \| readonly (string \| ... 4 more ... \| null)\[\] \| \{ ...; \} \| null)\[\] \| \{ ...; \} \| null)\[\] \| \{ ...; \} \| ...; \} \| `null`; \}; `outputSchema?`: \{ \[`key`: `string`\]: \| `string` \| `number` \| `boolean` \| readonly string \| number \| boolean \| readonly (string \| number \| boolean \| readonly (string \| number \| boolean \| readonly (string \| number \| boolean \| readonly (string \| number \| boolean \| readonly (string \| number \| boolean \| readonly (string \| ... 4 more ... \| null)\[\] \| \{ ...; \} \| null)\[\] \| \{ ...; \} \| null)\[\] \| \{ ...; \} \| ...[] \| \{ \[`key`: `string`\]: string \| number \| boolean \| readonly (string \| number \| boolean \| readonly (string \| number \| boolean \| readonly (string \| number \| boolean \| readonly (string \| number \| boolean \| readonly (string \| number \| boolean \| readonly (string \| ... 4 more ... \| null)\[\] \| \{ ...; \} \| null)\[\] \| \{ ...; \} \| null)\[\] \| \{ ...; \} \| ...; \} \| `null`; \}; `presentation?`: \| \{ `type`: `"action"`; \} \| \{ `type`: `"custom"`; `data`: \{ \[`key`: `string`\]: \| `string` \| `number` \| `boolean` \| readonly string \| number \| boolean \| readonly (string \| number \| boolean \| readonly (string \| number \| boolean \| readonly (string \| number \| boolean \| readonly (string \| number \| boolean \| readonly (string \| number \| boolean \| readonly (string \| ... 4 more ... \| null)\[\] \| \{ ...; \} \| null)\[\] \| \{ ...; \} \| null)\[\] \| \{ ...; \} \| ...[] \| \{ \[`key`: `string`\]: string \| number \| boolean \| readonly (string \| number \| boolean \| readonly (string \| number \| boolean \| readonly (string \| number \| boolean \| readonly (string \| number \| boolean \| readonly (string \| number \| boolean \| readonly (string \| ... 4 more ... \| null)\[\] \| \{ ...; \} \| null)\[\] \| \{ ...; \} \| null)\[\] \| \{ ...; \} \| ...; \} \| `null`; \}; \} \| \{ `type`: `"choice"`; `options`: readonly `object`[]; \} \| \{ `type`: `"form"`; `submitLabel?`: `string`; \} \| \{ `type`: `"confirmation"`; `message`: `string`; `confirmLabel?`: `string`; `cancelLabel?`: `string`; \}; \}; `availability?`: () => `WhistleAvailability`; `handler`: (`input`) => `unknown`; \}\>[] | The App's Whistle commands, handlers included. |
|
|
3379
|
+
| Parameter | Type | Description |
|
|
3380
|
+
| ---------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------- |
|
|
3381
|
+
| `commands` | [`AppCommands`](#appcommands) | The App's host command door, `app.commands`. |
|
|
3382
|
+
| `catalog` | readonly `Readonly`\<\{ `id`: `string`; `title`: `string`; `category`: `string`; `description?`: `string`; `projections?`: \{ `bindings?`: \{ `order?`: `number`; `values`: readonly `string`[]; \}; `agent?`: \{ `keybind?`: `string`; `order?`: `number`; \}; `help?`: \{ `order?`: `number`; \}; `menu?`: \{ `order?`: `number`; \}; `palette?`: \{ `order?`: `number`; \}; `slash?`: \{ `aliases`: readonly `string`[]; `consumesDraft?`: `boolean`; `order?`: `number`; `arguments?`: \{ `hint`: `string`; `words?`: readonly ...[]; `text?`: \{ `field`: ...; `arguments`: ...; `requestIdField?`: ...; \}; \}; \}; \}; `action?`: \{ `inputSchema?`: \{ \[`key`: `string`\]: \| `string` \| `number` \| `boolean` \| readonly string \| number \| boolean \| readonly (string \| number \| boolean \| readonly (string \| number \| boolean \| readonly (string \| number \| boolean \| readonly (string \| number \| boolean \| readonly (string \| number \| boolean \| readonly (string \| ... 4 more ... \| null)\[\] \| \{ ...; \} \| null)\[\] \| \{ ...; \} \| null)\[\] \| \{ ...; \} \| ...[] \| \{ \[`key`: `string`\]: string \| number \| boolean \| readonly (string \| number \| boolean \| readonly (string \| number \| boolean \| readonly (string \| number \| boolean \| readonly (string \| number \| boolean \| readonly (string \| number \| boolean \| readonly (string \| ... 4 more ... \| null)\[\] \| \{ ...; \} \| null)\[\] \| \{ ...; \} \| null)\[\] \| \{ ...; \} \| ...; \} \| `null`; \}; `outputSchema?`: \{ \[`key`: `string`\]: \| `string` \| `number` \| `boolean` \| readonly string \| number \| boolean \| readonly (string \| number \| boolean \| readonly (string \| number \| boolean \| readonly (string \| number \| boolean \| readonly (string \| number \| boolean \| readonly (string \| number \| boolean \| readonly (string \| ... 4 more ... \| null)\[\] \| \{ ...; \} \| null)\[\] \| \{ ...; \} \| null)\[\] \| \{ ...; \} \| ...[] \| \{ \[`key`: `string`\]: string \| number \| boolean \| readonly (string \| number \| boolean \| readonly (string \| number \| boolean \| readonly (string \| number \| boolean \| readonly (string \| number \| boolean \| readonly (string \| number \| boolean \| readonly (string \| ... 4 more ... \| null)\[\] \| \{ ...; \} \| null)\[\] \| \{ ...; \} \| null)\[\] \| \{ ...; \} \| ...; \} \| `null`; \}; `presentation?`: \| \{ `type`: `"action"`; \} \| \{ `type`: `"custom"`; `data`: \{ \[`key`: `string`\]: \| `string` \| `number` \| `boolean` \| readonly string \| number \| boolean \| readonly (string \| number \| boolean \| readonly (string \| number \| boolean \| readonly (string \| number \| boolean \| readonly (string \| number \| boolean \| readonly (string \| number \| boolean \| readonly (string \| ... 4 more ... \| null)\[\] \| \{ ...; \} \| null)\[\] \| \{ ...; \} \| null)\[\] \| \{ ...; \} \| ...[] \| \{ \[`key`: `string`\]: string \| number \| boolean \| readonly (string \| number \| boolean \| readonly (string \| number \| boolean \| readonly (string \| number \| boolean \| readonly (string \| number \| boolean \| readonly (string \| number \| boolean \| readonly (string \| ... 4 more ... \| null)\[\] \| \{ ...; \} \| null)\[\] \| \{ ...; \} \| null)\[\] \| \{ ...; \} \| ...; \} \| `null`; \}; \} \| \{ `type`: `"choice"`; `options`: readonly `object`[]; \} \| \{ `type`: `"form"`; `submitLabel?`: `string`; \} \| \{ `type`: `"confirmation"`; `message`: `string`; `confirmLabel?`: `string`; `cancelLabel?`: `string`; \}; \}; `availability?`: () => `WhistleAvailability`; `handler`: (`input`) => `unknown`; \}\>[] | The App's Whistle commands, handlers included. |
|
|
3322
3383
|
|
|
3323
3384
|
#### Returns
|
|
3324
3385
|
|
package/docs/api/media-json.md
CHANGED
|
@@ -400,65 +400,37 @@ A generation call carries paths and a replay ID; the host supplies authority.
|
|
|
400
400
|
### mediaGenerationJsonOutcomeSchema
|
|
401
401
|
|
|
402
402
|
```ts
|
|
403
|
-
const mediaGenerationJsonOutcomeSchema: Union<
|
|
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
|
-
"provider",
|
|
435
|
-
"normalization",
|
|
436
|
-
"artifact",
|
|
437
|
-
"destination-authorization",
|
|
438
|
-
"destination-write",
|
|
439
|
-
]
|
|
440
|
-
>
|
|
441
|
-
>;
|
|
442
|
-
code: Literals<
|
|
443
|
-
readonly [
|
|
444
|
-
"CANCELLED",
|
|
445
|
-
"CAPABILITY_DENIED",
|
|
446
|
-
"CAPABILITY_REVOKED",
|
|
447
|
-
"DISCONNECTED",
|
|
448
|
-
"HOST_FAILURE",
|
|
449
|
-
"IDENTITY",
|
|
450
|
-
"INSUFFICIENT_CREDIT",
|
|
451
|
-
"INVALID_ARGUMENT",
|
|
452
|
-
"PROTOCOL",
|
|
453
|
-
"SAFETY_FILTER_REFUSED",
|
|
454
|
-
"TIMEOUT",
|
|
455
|
-
]
|
|
456
|
-
>;
|
|
457
|
-
retryable: Boolean;
|
|
458
|
-
}>;
|
|
459
|
-
}>,
|
|
460
|
-
]
|
|
461
|
-
>;
|
|
403
|
+
const mediaGenerationJsonOutcomeSchema: Union<readonly [Struct<{
|
|
404
|
+
kind: Literal<"succeeded">;
|
|
405
|
+
result: Struct<{
|
|
406
|
+
[dispose]: optional<Unknown>;
|
|
407
|
+
bytes: Number;
|
|
408
|
+
costMilliunits: Number;
|
|
409
|
+
destination: Struct<{
|
|
410
|
+
computerId: String;
|
|
411
|
+
path: String;
|
|
412
|
+
}>;
|
|
413
|
+
format: Literals<readonly ["png", "jpeg", "gif", "webp", "mp4"]>;
|
|
414
|
+
height: Number;
|
|
415
|
+
model: String;
|
|
416
|
+
width: Number;
|
|
417
|
+
}>;
|
|
418
|
+
}>, Struct<{
|
|
419
|
+
kind: Literal<"failed">;
|
|
420
|
+
failure: Struct<{
|
|
421
|
+
message: String;
|
|
422
|
+
stage: optional<Literals<readonly ["admission", "generation-authorization", "settings", "estimate", "billing", "operation", "provider", "normalization", "artifact", "destination-authorization", "destination-write"]>>;
|
|
423
|
+
provider: optional<Union<readonly [Struct<{
|
|
424
|
+
category: ...;
|
|
425
|
+
code: ...;
|
|
426
|
+
}>, Struct<{
|
|
427
|
+
category: ...;
|
|
428
|
+
status: ...;
|
|
429
|
+
}>]>>;
|
|
430
|
+
code: Literals<readonly ["CANCELLED", "CAPABILITY_DENIED", "CAPABILITY_REVOKED", "DISCONNECTED", "HOST_FAILURE", "IDENTITY", "INSUFFICIENT_CREDIT", "INVALID_ARGUMENT", "PROTOCOL", "SAFETY_FILTER_REFUSED", "TIMEOUT"]>;
|
|
431
|
+
retryable: Boolean;
|
|
432
|
+
}>;
|
|
433
|
+
}>]>;
|
|
462
434
|
```
|
|
463
435
|
|
|
464
436
|
A typed completion or refusal; no live attempt handles cross this boundary.
|
|
@@ -488,6 +460,7 @@ const mediaGenerationJsonReplySchema: Union<readonly [Union<readonly [Struct<{
|
|
|
488
460
|
failure: Struct<{
|
|
489
461
|
message: String;
|
|
490
462
|
stage: optional<Literals<readonly [..., ..., ..., ..., ..., ..., ..., ..., ..., ..., ...]>>;
|
|
463
|
+
provider: optional<Union<readonly [..., ...]>>;
|
|
491
464
|
code: Literals<readonly ["CANCELLED", "CAPABILITY_DENIED", "CAPABILITY_REVOKED", "DISCONNECTED", "HOST_FAILURE", "IDENTITY", "INSUFFICIENT_CREDIT", "INVALID_ARGUMENT", "PROTOCOL", "SAFETY_FILTER_REFUSED", "TIMEOUT"]>;
|
|
492
465
|
retryable: Boolean;
|
|
493
466
|
}>;
|
package/docs/api/query.md
CHANGED
|
@@ -246,7 +246,7 @@ One shared inbox watch; reloads and stream failures retain the last live rows.
|
|
|
246
246
|
|
|
247
247
|
| Name | Type | Default value | Description |
|
|
248
248
|
| ----------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------- | ------------------------------------------------------------------------------------------------- |
|
|
249
|
-
| `items` | readonly ( \| \{ `agentId`: `string`; `sessionId`: `string`; `title`: `string`; `triggerId?`: `string`; `createdAt`: `number`; `lastActivityAt`: `number`; `settledAt?`: `number`; `visitedAt?`: `number`; `state`: `"running"` \| `"done"` \| `"needs_you"` \| `"errored"`; \} \| \{ `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`: `"runner"` \| `"owners"`; `show`: readonly `Json`[]; `choices?`: readonly `string`[]; `openedAt`: `number`; `expiresAt`: `number`; `state`: `"pending"` \| `"
|
|
249
|
+
| `items` | readonly ( \| \{ `agentId`: `string`; `sessionId`: `string`; `title`: `string`; `triggerId?`: `string`; `createdAt`: `number`; `lastActivityAt`: `number`; `settledAt?`: `number`; `visitedAt?`: `number`; `state`: `"running"` \| `"done"` \| `"needs_you"` \| `"errored"`; \} \| \{ `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`: `"runner"` \| `"owners"`; `show`: readonly `Json`[]; `choices?`: readonly `string`[]; `openedAt`: `number`; `expiresAt`: `number`; `state`: `"pending"` \| `"answered"` \| `"closed"` \| `"delivered"` \| `"timed_out"`; \})[] | - | - |
|
|
250
250
|
| `status` | `"error"` \| `"loading"` \| `"live"` | - | - |
|
|
251
251
|
| `error` | [`AppError`](errors.md#apperror) \| `null` | `query.error` | - |
|
|
252
252
|
| `refresh()` | () => `void` | - | Restart the inbox watch; use after a change that the live feed would not otherwise observe. |
|
package/docs/api/react.md
CHANGED
|
@@ -22,11 +22,18 @@ type AppMountState = Readonly<
|
|
|
22
22
|
app: null;
|
|
23
23
|
status: "connecting" | "standalone" | "ended";
|
|
24
24
|
}
|
|
25
|
+
| {
|
|
26
|
+
app: null;
|
|
27
|
+
status: "not-hosted";
|
|
28
|
+
error: AppError;
|
|
29
|
+
}
|
|
25
30
|
>;
|
|
26
31
|
```
|
|
27
32
|
|
|
28
33
|
The App connection state passed to `mountApp`'s `render` callback: `live` once
|
|
29
|
-
connected, or `connecting`/`standalone`/`ended` while there is no usable App.
|
|
34
|
+
connected, or `connecting`/`standalone`/`ended` while there is no usable App. An
|
|
35
|
+
embedded page whose handshake fails is `not-hosted`, never standalone; Agar also
|
|
36
|
+
renders that failure visibly.
|
|
30
37
|
|
|
31
38
|
---
|
|
32
39
|
|
|
@@ -188,11 +195,11 @@ with useCallback; changing it replaces the catalog and its availability.
|
|
|
188
195
|
|
|
189
196
|
#### Parameters
|
|
190
197
|
|
|
191
|
-
| Parameter | Type
|
|
192
|
-
| ------------------- |
|
|
193
|
-
| `app` | [`AppRoot`](index.md#approot) \| `null` \| `undefined`
|
|
194
|
-
| `__namedParameters` | `Pick`\<`WhistleContribution`, `"sourceId"` \| `"namespace"`\>
|
|
195
|
-
| `build` | () => readonly `Readonly`\<\{ `id`: `string`; `title`: `string`; `category`: `string`; `description?`: `string`; `projections?`: \{ `bindings?`: \{ `order?`: `number`; `values`: readonly `string`[]; \}; `agent?`: \{ `keybind?`: `string`; `order?`: `number`; \}; `help?`: \{ `order?`: `number`; \}; `menu?`: \{ `order?`: `number`; \}; `palette?`: \{ `order?`: `number`; \}; `slash?`: \{ `aliases`: readonly `string`[]; `order?`: `number`; `arguments?`: \{ `hint`: `string`; `words?`: ... \| ...; `text?`: ... \| ...; \}; \}; \}; `action?`: \{ `inputSchema?`: \{ \[`key`: `string`\]: \| `string` \| `number` \| `boolean` \| readonly string \| number \| boolean \| readonly (string \| number \| boolean \| readonly (string \| number \| boolean \| readonly (string \| number \| boolean \| readonly (string \| number \| boolean \| readonly (string \| number \| boolean \| readonly (string \| ... 4 more ... \| null)\[\] \| \{ ...; \} \| null)\[\] \| \{ ...; \} \| null)\[\] \| \{ ...; \} \| ...[] \| \{ \[`key`: `string`\]: string \| number \| boolean \| readonly (string \| number \| boolean \| readonly (string \| number \| boolean \| readonly (string \| number \| boolean \| readonly (string \| number \| boolean \| readonly (string \| number \| boolean \| readonly (string \| ... 4 more ... \| null)\[\] \| \{ ...; \} \| null)\[\] \| \{ ...; \} \| null)\[\] \| \{ ...; \} \| ...; \} \| `null`; \}; `outputSchema?`: \{ \[`key`: `string`\]: \| `string` \| `number` \| `boolean` \| readonly string \| number \| boolean \| readonly (string \| number \| boolean \| readonly (string \| number \| boolean \| readonly (string \| number \| boolean \| readonly (string \| number \| boolean \| readonly (string \| number \| boolean \| readonly (string \| ... 4 more ... \| null)\[\] \| \{ ...; \} \| null)\[\] \| \{ ...; \} \| null)\[\] \| \{ ...; \} \| ...[] \| \{ \[`key`: `string`\]: string \| number \| boolean \| readonly (string \| number \| boolean \| readonly (string \| number \| boolean \| readonly (string \| number \| boolean \| readonly (string \| number \| boolean \| readonly (string \| number \| boolean \| readonly (string \| ... 4 more ... \| null)\[\] \| \{ ...; \} \| null)\[\] \| \{ ...; \} \| null)\[\] \| \{ ...; \} \| ...; \} \| `null`; \}; `presentation?`: \| \{ `type`: `"action"`; \} \| \{ `type`: `"custom"`; `data`: \{ \[`key`: `string`\]: \| `string` \| `number` \| `boolean` \| readonly ...[] \| \{ \[`key`: ...\]: ...; \} \| `null`; \}; \} \| \{ `type`: `"choice"`; `options`: readonly `object`[]; \} \| \{ `type`: `"form"`; `submitLabel?`: `string`; \} \| \{ `type`: `"confirmation"`; `message`: `string`; `confirmLabel?`: `string`; `cancelLabel?`: `string`; \}; \}; `availability?`: () => `WhistleAvailability`; `handler`: (`input`) => `unknown`; \}\>[] |
|
|
198
|
+
| Parameter | Type |
|
|
199
|
+
| ------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
200
|
+
| `app` | [`AppRoot`](index.md#approot) \| `null` \| `undefined` |
|
|
201
|
+
| `__namedParameters` | `Pick`\<`WhistleContribution`, `"sourceId"` \| `"namespace"`\> |
|
|
202
|
+
| `build` | () => readonly `Readonly`\<\{ `id`: `string`; `title`: `string`; `category`: `string`; `description?`: `string`; `projections?`: \{ `bindings?`: \{ `order?`: `number`; `values`: readonly `string`[]; \}; `agent?`: \{ `keybind?`: `string`; `order?`: `number`; \}; `help?`: \{ `order?`: `number`; \}; `menu?`: \{ `order?`: `number`; \}; `palette?`: \{ `order?`: `number`; \}; `slash?`: \{ `aliases`: readonly `string`[]; `consumesDraft?`: `boolean`; `order?`: `number`; `arguments?`: \{ `hint`: `string`; `words?`: ... \| ...; `text?`: ... \| ...; \}; \}; \}; `action?`: \{ `inputSchema?`: \{ \[`key`: `string`\]: \| `string` \| `number` \| `boolean` \| readonly string \| number \| boolean \| readonly (string \| number \| boolean \| readonly (string \| number \| boolean \| readonly (string \| number \| boolean \| readonly (string \| number \| boolean \| readonly (string \| number \| boolean \| readonly (string \| ... 4 more ... \| null)\[\] \| \{ ...; \} \| null)\[\] \| \{ ...; \} \| null)\[\] \| \{ ...; \} \| ...[] \| \{ \[`key`: `string`\]: string \| number \| boolean \| readonly (string \| number \| boolean \| readonly (string \| number \| boolean \| readonly (string \| number \| boolean \| readonly (string \| number \| boolean \| readonly (string \| number \| boolean \| readonly (string \| ... 4 more ... \| null)\[\] \| \{ ...; \} \| null)\[\] \| \{ ...; \} \| null)\[\] \| \{ ...; \} \| ...; \} \| `null`; \}; `outputSchema?`: \{ \[`key`: `string`\]: \| `string` \| `number` \| `boolean` \| readonly string \| number \| boolean \| readonly (string \| number \| boolean \| readonly (string \| number \| boolean \| readonly (string \| number \| boolean \| readonly (string \| number \| boolean \| readonly (string \| number \| boolean \| readonly (string \| ... 4 more ... \| null)\[\] \| \{ ...; \} \| null)\[\] \| \{ ...; \} \| null)\[\] \| \{ ...; \} \| ...[] \| \{ \[`key`: `string`\]: string \| number \| boolean \| readonly (string \| number \| boolean \| readonly (string \| number \| boolean \| readonly (string \| number \| boolean \| readonly (string \| number \| boolean \| readonly (string \| number \| boolean \| readonly (string \| ... 4 more ... \| null)\[\] \| \{ ...; \} \| null)\[\] \| \{ ...; \} \| null)\[\] \| \{ ...; \} \| ...; \} \| `null`; \}; `presentation?`: \| \{ `type`: `"action"`; \} \| \{ `type`: `"custom"`; `data`: \{ \[`key`: `string`\]: \| `string` \| `number` \| `boolean` \| readonly ...[] \| \{ \[`key`: ...\]: ...; \} \| `null`; \}; \} \| \{ `type`: `"choice"`; `options`: readonly `object`[]; \} \| \{ `type`: `"form"`; `submitLabel?`: `string`; \} \| \{ `type`: `"confirmation"`; `message`: `string`; `confirmLabel?`: `string`; `cancelLabel?`: `string`; \}; \}; `availability?`: () => `WhistleAvailability`; `handler`: (`input`) => `unknown`; \}\>[] |
|
|
196
203
|
|
|
197
204
|
#### Returns
|
|
198
205
|
|