@getpaseo/plugin 0.15.4 → 0.16.0-beta.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/LICENSE +211 -0
- package/dist/client/client-state.d.ts +74 -6
- package/dist/client/client-state.js +48 -16
- package/dist/client/composer.d.ts +104 -0
- package/dist/client/composer.js +37 -0
- package/dist/client/contracts.d.ts +36 -4
- package/dist/client/host.d.ts +9 -3
- package/dist/client/host.js +7 -3
- package/dist/client/index.d.ts +11 -3
- package/dist/client/index.js +4 -2
- package/dist/client/new-workspace.d.ts +69 -0
- package/dist/client/new-workspace.js +17 -0
- package/dist/client/paseo-context.d.ts +5 -5
- package/dist/client/paseo-context.js +1 -1
- package/dist/client/query.d.ts +26 -0
- package/dist/client/query.js +84 -0
- package/dist/client/reference-api.d.ts +38 -0
- package/dist/client/reference-api.js +44 -0
- package/dist/client/refs.d.ts +28 -0
- package/dist/client/refs.js +22 -0
- package/dist/client/rpc-context.d.ts +23 -3
- package/dist/client/rpc-context.js +60 -4
- package/dist/client/runtime-context-bridge.js +11 -3
- package/dist/client/ui.d.ts +65 -0
- package/dist/contracts.d.ts +39 -0
- package/dist/index.d.ts +2 -2
- package/dist/index.js +1 -1
- package/dist/refs.d.ts +16 -0
- package/dist/refs.js +2 -0
- package/dist/rpc.d.ts +40 -1
- package/dist/rpc.js +37 -2
- package/dist/server/acp-internal/connection.js +44 -19
- package/dist/server/contracts.d.ts +19 -2
- package/dist/server/index.d.ts +1 -1
- package/dist/server/lifecycle.d.ts +15 -2
- package/dist/server/provider.d.ts +44 -1
- package/dist/server/provider.js +29 -1
- package/dist/settings.d.ts +2 -2
- package/dist/settings.js +2 -2
- package/package.json +6 -5
package/LICENSE
ADDED
|
@@ -0,0 +1,211 @@
|
|
|
1
|
+
Copyright (c) 2025-present Mohamed Boudra
|
|
2
|
+
|
|
3
|
+
Portions of this software are licensed as follows:
|
|
4
|
+
|
|
5
|
+
* Third-party components incorporated into Paseo remain licensed under
|
|
6
|
+
the licenses provided by their respective copyright holders.
|
|
7
|
+
* Except for those third-party components, Paseo is licensed under the
|
|
8
|
+
Apache License, Version 2.0, reproduced below.
|
|
9
|
+
|
|
10
|
+
|
|
11
|
+
Apache License
|
|
12
|
+
Version 2.0, January 2004
|
|
13
|
+
http://www.apache.org/licenses/
|
|
14
|
+
|
|
15
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
|
16
|
+
|
|
17
|
+
1. Definitions.
|
|
18
|
+
|
|
19
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
|
20
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
|
21
|
+
|
|
22
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
|
23
|
+
the copyright owner that is granting the License.
|
|
24
|
+
|
|
25
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
|
26
|
+
other entities that control, are controlled by, or are under common
|
|
27
|
+
control with that entity. For the purposes of this definition,
|
|
28
|
+
"control" means (i) the power, direct or indirect, to cause the
|
|
29
|
+
direction or management of such entity, whether by contract or
|
|
30
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
|
31
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
|
32
|
+
|
|
33
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
|
34
|
+
exercising permissions granted by this License.
|
|
35
|
+
|
|
36
|
+
"Source" form shall mean the preferred form for making modifications,
|
|
37
|
+
including but not limited to software source code, documentation
|
|
38
|
+
source, and configuration files.
|
|
39
|
+
|
|
40
|
+
"Object" form shall mean any form resulting from mechanical
|
|
41
|
+
transformation or translation of a Source form, including but
|
|
42
|
+
not limited to compiled object code, generated documentation,
|
|
43
|
+
and conversions to other media types.
|
|
44
|
+
|
|
45
|
+
"Work" shall mean the work of authorship, whether in Source or
|
|
46
|
+
Object form, made available under the License, as indicated by a
|
|
47
|
+
copyright notice that is included in or attached to the work
|
|
48
|
+
(an example is provided in the Appendix below).
|
|
49
|
+
|
|
50
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
|
51
|
+
form, that is based on (or derived from) the Work and for which the
|
|
52
|
+
editorial revisions, annotations, elaborations, or other modifications
|
|
53
|
+
represent, as a whole, an original work of authorship. For the purposes
|
|
54
|
+
of this License, Derivative Works shall not include works that remain
|
|
55
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
|
56
|
+
the Work and Derivative Works thereof.
|
|
57
|
+
|
|
58
|
+
"Contribution" shall mean any work of authorship, including
|
|
59
|
+
the original version of the Work and any modifications or additions
|
|
60
|
+
to that Work or Derivative Works thereof, that is intentionally
|
|
61
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
|
62
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
|
63
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
|
64
|
+
means any form of electronic, verbal, or written communication sent
|
|
65
|
+
to the Licensor or its representatives, including but not limited to
|
|
66
|
+
communication on electronic mailing lists, source code control systems,
|
|
67
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
|
68
|
+
Licensor for the purpose of discussing and improving the Work, but
|
|
69
|
+
excluding communication that is conspicuously marked or otherwise
|
|
70
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
|
71
|
+
|
|
72
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
|
73
|
+
on behalf of whom a Contribution has been received by Licensor and
|
|
74
|
+
subsequently incorporated within the Work.
|
|
75
|
+
|
|
76
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
|
77
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
78
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
79
|
+
copyright license to reproduce, prepare Derivative Works of,
|
|
80
|
+
publicly display, publicly perform, sublicense, and distribute the
|
|
81
|
+
Work and such Derivative Works in Source or Object form.
|
|
82
|
+
|
|
83
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
|
84
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
85
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
86
|
+
(except as stated in this section) patent license to make, have made,
|
|
87
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
|
88
|
+
where such license applies only to those patent claims licensable
|
|
89
|
+
by such Contributor that are necessarily infringed by their
|
|
90
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
|
91
|
+
with the Work to which such Contribution(s) was submitted. If You
|
|
92
|
+
institute patent litigation against any entity (including a
|
|
93
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
|
94
|
+
or a Contribution incorporated within the Work constitutes direct
|
|
95
|
+
or contributory patent infringement, then any patent licenses
|
|
96
|
+
granted to You under this License for that Work shall terminate
|
|
97
|
+
as of the date such litigation is filed.
|
|
98
|
+
|
|
99
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
|
100
|
+
Work or Derivative Works thereof in any medium, with or without
|
|
101
|
+
modifications, and in Source or Object form, provided that You
|
|
102
|
+
meet the following conditions:
|
|
103
|
+
|
|
104
|
+
(a) You must give any other recipients of the Work or
|
|
105
|
+
Derivative Works a copy of this License; and
|
|
106
|
+
|
|
107
|
+
(b) You must cause any modified files to carry prominent notices
|
|
108
|
+
stating that You changed the files; and
|
|
109
|
+
|
|
110
|
+
(c) You must retain, in the Source form of any Derivative Works
|
|
111
|
+
that You distribute, all copyright, patent, trademark, and
|
|
112
|
+
attribution notices from the Source form of the Work,
|
|
113
|
+
excluding those notices that do not pertain to any part of
|
|
114
|
+
the Derivative Works; and
|
|
115
|
+
|
|
116
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
|
117
|
+
distribution, then any Derivative Works that You distribute must
|
|
118
|
+
include a readable copy of the attribution notices contained
|
|
119
|
+
within such NOTICE file, excluding those notices that do not
|
|
120
|
+
pertain to any part of the Derivative Works, in at least one
|
|
121
|
+
of the following places: within a NOTICE text file distributed
|
|
122
|
+
as part of the Derivative Works; within the Source form or
|
|
123
|
+
documentation, if provided along with the Derivative Works; or,
|
|
124
|
+
within a display generated by the Derivative Works, if and
|
|
125
|
+
wherever such third-party notices normally appear. The contents
|
|
126
|
+
of the NOTICE file are for informational purposes only and
|
|
127
|
+
do not modify the License. You may add Your own attribution
|
|
128
|
+
notices within Derivative Works that You distribute, alongside
|
|
129
|
+
or as an addendum to the NOTICE text from the Work, provided
|
|
130
|
+
that such additional attribution notices cannot be construed
|
|
131
|
+
as modifying the License.
|
|
132
|
+
|
|
133
|
+
You may add Your own copyright statement to Your modifications and
|
|
134
|
+
may provide additional or different license terms and conditions
|
|
135
|
+
for use, reproduction, or distribution of Your modifications, or
|
|
136
|
+
for any such Derivative Works as a whole, provided Your use,
|
|
137
|
+
reproduction, and distribution of the Work otherwise complies with
|
|
138
|
+
the conditions stated in this License.
|
|
139
|
+
|
|
140
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
|
141
|
+
any Contribution intentionally submitted for inclusion in the Work
|
|
142
|
+
by You to the Licensor shall be under the terms and conditions of
|
|
143
|
+
this License, without any additional terms or conditions.
|
|
144
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
|
145
|
+
the terms of any separate license agreement you may have executed
|
|
146
|
+
with Licensor regarding such Contributions.
|
|
147
|
+
|
|
148
|
+
6. Trademarks. This License does not grant permission to use the trade
|
|
149
|
+
names, trademarks, service marks, or product names of the Licensor,
|
|
150
|
+
except as required for reasonable and customary use in describing the
|
|
151
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
|
152
|
+
|
|
153
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
|
154
|
+
agreed to in writing, Licensor provides the Work (and each
|
|
155
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
|
156
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
|
157
|
+
implied, including, without limitation, any warranties or conditions
|
|
158
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
|
159
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
|
160
|
+
appropriateness of using or redistributing the Work and assume any
|
|
161
|
+
risks associated with Your exercise of permissions under this License.
|
|
162
|
+
|
|
163
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
|
164
|
+
whether in tort (including negligence), contract, or otherwise,
|
|
165
|
+
unless required by applicable law (such as deliberate and grossly
|
|
166
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
|
167
|
+
liable to You for damages, including any direct, indirect, special,
|
|
168
|
+
incidental, or consequential damages of any character arising as a
|
|
169
|
+
result of this License or out of the use or inability to use the
|
|
170
|
+
Work (including but not limited to damages for loss of goodwill,
|
|
171
|
+
work stoppage, computer failure or malfunction, or any and all
|
|
172
|
+
other commercial damages or losses), even if such Contributor
|
|
173
|
+
has been advised of the possibility of such damages.
|
|
174
|
+
|
|
175
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
|
176
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
|
177
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
|
178
|
+
or other liability obligations and/or rights consistent with this
|
|
179
|
+
License. However, in accepting such obligations, You may act only
|
|
180
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
|
181
|
+
of any other Contributor, and only if You agree to indemnify,
|
|
182
|
+
defend, and hold each Contributor harmless for any liability
|
|
183
|
+
incurred by, or claims asserted against, such Contributor by reason
|
|
184
|
+
of your accepting any such warranty or additional liability.
|
|
185
|
+
|
|
186
|
+
END OF TERMS AND CONDITIONS
|
|
187
|
+
|
|
188
|
+
APPENDIX: How to apply the Apache License to your work.
|
|
189
|
+
|
|
190
|
+
To apply the Apache License to your work, attach the following
|
|
191
|
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
|
192
|
+
replaced with your own identifying information. (Don't include
|
|
193
|
+
the brackets!) The text should be enclosed in the appropriate
|
|
194
|
+
comment syntax for the file format. We also recommend that a
|
|
195
|
+
file or class name and description of purpose be included on the
|
|
196
|
+
same "printed page" as the copyright notice for easier
|
|
197
|
+
identification within third-party archives.
|
|
198
|
+
|
|
199
|
+
Copyright [yyyy] [name of copyright owner]
|
|
200
|
+
|
|
201
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
|
202
|
+
you may not use this file except in compliance with the License.
|
|
203
|
+
You may obtain a copy of the License at
|
|
204
|
+
|
|
205
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
|
206
|
+
|
|
207
|
+
Unless required by applicable law or agreed to in writing, software
|
|
208
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
|
209
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
210
|
+
See the License for the specific language governing permissions and
|
|
211
|
+
limitations under the License.
|
|
@@ -1,13 +1,81 @@
|
|
|
1
1
|
import { type ReactNode } from "react";
|
|
2
|
-
import type {
|
|
2
|
+
import type { AgentRef, WorkspaceRef, ProjectRef, TerminalRef } from "../refs.js";
|
|
3
|
+
import type { PluginAgentSnapshot, PluginWorkspaceSnapshot, PluginProjectSnapshot, PluginTerminalSnapshot } from "../contracts.js";
|
|
4
|
+
import { type Query, type Group } from "./query.js";
|
|
3
5
|
export interface PluginClientStateSource {
|
|
4
|
-
subscribe(listener: () => void
|
|
5
|
-
|
|
6
|
-
|
|
6
|
+
subscribe(listener: () => void, options?: {
|
|
7
|
+
terminals?: boolean;
|
|
8
|
+
}): () => void;
|
|
9
|
+
getWorkspace(id: string | WorkspaceRef): PluginWorkspaceSnapshot | null;
|
|
10
|
+
getAgent(id: string | AgentRef): PluginAgentSnapshot | null;
|
|
11
|
+
getProject(ref: ProjectRef): PluginProjectSnapshot | null;
|
|
12
|
+
getTerminal(ref: TerminalRef): PluginTerminalSnapshot | null;
|
|
13
|
+
getSnapshot(): PluginClientSnapshot;
|
|
14
|
+
}
|
|
15
|
+
export interface PluginClientSnapshot {
|
|
16
|
+
readonly workspaces: readonly PluginWorkspaceSnapshot[];
|
|
17
|
+
readonly agents: readonly PluginAgentSnapshot[];
|
|
18
|
+
readonly projects: readonly PluginProjectSnapshot[];
|
|
19
|
+
readonly terminals: readonly PluginTerminalSnapshot[];
|
|
20
|
+
readonly terminalErrors?: ReadonlyMap<string, Error>;
|
|
7
21
|
}
|
|
8
22
|
export declare function usePluginClientStateSource(): PluginClientStateSource | null;
|
|
9
|
-
|
|
10
|
-
export declare function
|
|
23
|
+
/** Shared selection semantics for host surfaces and plugin entities. */
|
|
24
|
+
export declare function usePaseoSelector<Entity, Selection>(source: {
|
|
25
|
+
subscribe(listener: () => void): () => void;
|
|
26
|
+
}, read: () => Entity, selector: (entity: Entity) => Selection, equals?: (left: Selection, right: Selection) => boolean): Selection;
|
|
27
|
+
export declare const useWorkspace: {
|
|
28
|
+
(ref: string | WorkspaceRef, selector?: undefined, equals?: ((left: PluginWorkspaceSnapshot | null, right: PluginWorkspaceSnapshot | null) => boolean) | undefined): PluginWorkspaceSnapshot | null;
|
|
29
|
+
<Selection>(ref: string | WorkspaceRef, selector: (entity: PluginWorkspaceSnapshot) => Selection, equals?: ((left: Selection | null, right: Selection | null) => boolean) | undefined): Selection | null;
|
|
30
|
+
};
|
|
31
|
+
export declare const useAgent: {
|
|
32
|
+
(ref: string | AgentRef, selector?: undefined, equals?: ((left: PluginAgentSnapshot | null, right: PluginAgentSnapshot | null) => boolean) | undefined): PluginAgentSnapshot | null;
|
|
33
|
+
<Selection>(ref: string | AgentRef, selector: (entity: PluginAgentSnapshot) => Selection, equals?: ((left: Selection | null, right: Selection | null) => boolean) | undefined): Selection | null;
|
|
34
|
+
};
|
|
35
|
+
export declare const useProject: {
|
|
36
|
+
(ref: ProjectRef, selector?: undefined, equals?: ((left: PluginProjectSnapshot | null, right: PluginProjectSnapshot | null) => boolean) | undefined): PluginProjectSnapshot | null;
|
|
37
|
+
<Selection>(ref: ProjectRef, selector: (entity: PluginProjectSnapshot) => Selection, equals?: ((left: Selection | null, right: Selection | null) => boolean) | undefined): Selection | null;
|
|
38
|
+
};
|
|
39
|
+
export declare const useTerminal: {
|
|
40
|
+
(ref: TerminalRef, selector?: undefined, equals?: ((left: PluginTerminalSnapshot | null, right: PluginTerminalSnapshot | null) => boolean) | undefined): PluginTerminalSnapshot | null;
|
|
41
|
+
<Selection>(ref: TerminalRef, selector: (entity: PluginTerminalSnapshot) => Selection, equals?: ((left: Selection | null, right: Selection | null) => boolean) | undefined): Selection | null;
|
|
42
|
+
};
|
|
43
|
+
export declare const useWorkspaces: {
|
|
44
|
+
(query: Query<PluginWorkspaceSnapshot> & {
|
|
45
|
+
groupBy: (item: PluginWorkspaceSnapshot) => import("./query.js").GroupKey | readonly import("./query.js").GroupKey[];
|
|
46
|
+
}): readonly Group<WorkspaceRef>[];
|
|
47
|
+
(query?: (Query<PluginWorkspaceSnapshot> & {
|
|
48
|
+
groupBy?: undefined;
|
|
49
|
+
}) | undefined): readonly WorkspaceRef[];
|
|
50
|
+
(query: Query<PluginWorkspaceSnapshot>): readonly Group<WorkspaceRef>[] | readonly WorkspaceRef[];
|
|
51
|
+
};
|
|
52
|
+
export declare const useAgents: {
|
|
53
|
+
(query: Query<PluginAgentSnapshot> & {
|
|
54
|
+
groupBy: (item: PluginAgentSnapshot) => import("./query.js").GroupKey | readonly import("./query.js").GroupKey[];
|
|
55
|
+
}): readonly Group<AgentRef>[];
|
|
56
|
+
(query?: (Query<PluginAgentSnapshot> & {
|
|
57
|
+
groupBy?: undefined;
|
|
58
|
+
}) | undefined): readonly AgentRef[];
|
|
59
|
+
(query: Query<PluginAgentSnapshot>): readonly Group<AgentRef>[] | readonly AgentRef[];
|
|
60
|
+
};
|
|
61
|
+
export declare const useProjects: {
|
|
62
|
+
(query: Query<PluginProjectSnapshot> & {
|
|
63
|
+
groupBy: (item: PluginProjectSnapshot) => import("./query.js").GroupKey | readonly import("./query.js").GroupKey[];
|
|
64
|
+
}): readonly Group<ProjectRef>[];
|
|
65
|
+
(query?: (Query<PluginProjectSnapshot> & {
|
|
66
|
+
groupBy?: undefined;
|
|
67
|
+
}) | undefined): readonly ProjectRef[];
|
|
68
|
+
(query: Query<PluginProjectSnapshot>): readonly Group<ProjectRef>[] | readonly ProjectRef[];
|
|
69
|
+
};
|
|
70
|
+
export declare const useTerminals: {
|
|
71
|
+
(query: Query<PluginTerminalSnapshot> & {
|
|
72
|
+
groupBy: (item: PluginTerminalSnapshot) => import("./query.js").GroupKey | readonly import("./query.js").GroupKey[];
|
|
73
|
+
}): readonly Group<TerminalRef>[];
|
|
74
|
+
(query?: (Query<PluginTerminalSnapshot> & {
|
|
75
|
+
groupBy?: undefined;
|
|
76
|
+
}) | undefined): readonly TerminalRef[];
|
|
77
|
+
(query: Query<PluginTerminalSnapshot>): readonly Group<TerminalRef>[] | readonly TerminalRef[];
|
|
78
|
+
};
|
|
11
79
|
export declare function PluginClientStateProvider({ children, source, }: {
|
|
12
80
|
children: ReactNode;
|
|
13
81
|
source: PluginClientStateSource;
|
|
@@ -1,31 +1,63 @@
|
|
|
1
1
|
import { jsx as _jsx } from "react/jsx-runtime";
|
|
2
|
-
import { createContext, useContext } from "react";
|
|
2
|
+
import { createContext, useContext, useMemo } from "react";
|
|
3
3
|
import { useSyncExternalStoreWithSelector } from "use-sync-external-store/shim/with-selector";
|
|
4
|
+
import { createCollectionQuery } from "./query.js";
|
|
4
5
|
import { shallowEqual } from "./shallow.js";
|
|
5
6
|
const PluginClientStateContext = createContext(null);
|
|
6
7
|
export function usePluginClientStateSource() {
|
|
7
8
|
return useContext(PluginClientStateContext);
|
|
8
9
|
}
|
|
9
|
-
|
|
10
|
+
/** Shared selection semantics for host surfaces and plugin entities. */
|
|
11
|
+
export function usePaseoSelector(source, read, selector, equals = shallowEqual) {
|
|
12
|
+
return useSyncExternalStoreWithSelector(source.subscribe, read, read, selector, equals);
|
|
13
|
+
}
|
|
14
|
+
function useStateSource(terminals) {
|
|
10
15
|
const source = usePluginClientStateSource();
|
|
11
16
|
if (!source)
|
|
12
|
-
throw new Error("Plugin state hooks must run inside a
|
|
13
|
-
return
|
|
17
|
+
throw new Error("Plugin state hooks must run inside a plugin host");
|
|
18
|
+
return useMemo(() => terminals
|
|
19
|
+
? {
|
|
20
|
+
...source,
|
|
21
|
+
subscribe: (listener) => source.subscribe(listener, { terminals: true }),
|
|
22
|
+
}
|
|
23
|
+
: source, [source, terminals]);
|
|
14
24
|
}
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
25
|
+
function createEntityHook(read, terminals = false) {
|
|
26
|
+
function useEntity(ref, selector, equals) {
|
|
27
|
+
const source = useStateSource(terminals);
|
|
28
|
+
function select(entity) {
|
|
29
|
+
return entity !== null && selector ? selector(entity) : entity;
|
|
30
|
+
}
|
|
31
|
+
const equality = equals ?? (selector ? shallowEqual : Object.is);
|
|
32
|
+
return usePaseoSelector(source, () => read(source, ref), select, equality);
|
|
33
|
+
}
|
|
34
|
+
return useEntity;
|
|
21
35
|
}
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
36
|
+
// COMPAT(plugin-entity-id): string ids accepted since 0.16; remove after 2027-03.
|
|
37
|
+
export const useWorkspace = createEntityHook((source, ref) => source.getWorkspace(ref));
|
|
38
|
+
// COMPAT(plugin-entity-id): string ids accepted since 0.16; remove after 2027-03.
|
|
39
|
+
export const useAgent = createEntityHook((source, ref) => source.getAgent(ref));
|
|
40
|
+
export const useProject = createEntityHook((source, ref) => source.getProject(ref));
|
|
41
|
+
export const useTerminal = createEntityHook((source, ref) => source.getTerminal(ref), true);
|
|
42
|
+
function createCollectionHook(read, terminals = false) {
|
|
43
|
+
function useCollection(query = {}) {
|
|
44
|
+
const source = useStateSource(terminals);
|
|
45
|
+
const project = useMemo(() => createCollectionQuery(), []);
|
|
46
|
+
return usePaseoSelector(source, () => read(source, query), (snapshots) => project(snapshots, query), Object.is);
|
|
47
|
+
}
|
|
48
|
+
return useCollection;
|
|
28
49
|
}
|
|
50
|
+
export const useWorkspaces = createCollectionHook((source) => source.getSnapshot().workspaces);
|
|
51
|
+
export const useAgents = createCollectionHook((source) => source.getSnapshot().agents);
|
|
52
|
+
export const useProjects = createCollectionHook((source) => source.getSnapshot().projects);
|
|
53
|
+
export const useTerminals = createCollectionHook((source, query) => {
|
|
54
|
+
const snapshot = source.getSnapshot();
|
|
55
|
+
for (const [hostId, error] of snapshot.terminalErrors ?? []) {
|
|
56
|
+
if (!query.hosts || query.hosts.includes(hostId))
|
|
57
|
+
throw error;
|
|
58
|
+
}
|
|
59
|
+
return snapshot.terminals;
|
|
60
|
+
}, true);
|
|
29
61
|
export function PluginClientStateProvider({ children, source, }) {
|
|
30
62
|
return (_jsx(PluginClientStateContext.Provider, { value: source, children: children }));
|
|
31
63
|
}
|
|
@@ -0,0 +1,104 @@
|
|
|
1
|
+
import { type ComponentType, type ReactNode } from "react";
|
|
2
|
+
import type { JsonValue } from "@getpaseo/protocol/agent-types";
|
|
3
|
+
import type { PluginAttachmentItem } from "../attachments.js";
|
|
4
|
+
import type { PluginHostProps } from "./contracts.js";
|
|
5
|
+
/** One item the user attached from a source this plugin registered with `addAttachmentSource`. */
|
|
6
|
+
export interface PluginComposerAttachment {
|
|
7
|
+
readonly sourceId: string;
|
|
8
|
+
readonly item: PluginAttachmentItem;
|
|
9
|
+
}
|
|
10
|
+
/** Where the cursor goes when a composer takes focus. */
|
|
11
|
+
export interface PluginComposerFocusOptions {
|
|
12
|
+
/** Offsets into `prompt`, clamped to its length. Equal offsets place the cursor. Omit to keep the cursor where it is. */
|
|
13
|
+
selection?: {
|
|
14
|
+
start: number;
|
|
15
|
+
end: number;
|
|
16
|
+
};
|
|
17
|
+
}
|
|
18
|
+
/**
|
|
19
|
+
* The composer the item sits in: the prompt, the attachments and the agent being configured.
|
|
20
|
+
* The commands behave the same in every composer. `context` says where the composer is; it does
|
|
21
|
+
* not change what a command does, except that a running agent keeps its provider.
|
|
22
|
+
*/
|
|
23
|
+
export interface PluginComposer {
|
|
24
|
+
/** `"agent"`: a running agent. `"draft"`: a new agent in a workspace. `"new-workspace"`: the New workspace screen. */
|
|
25
|
+
readonly context: "agent" | "draft" | "new-workspace";
|
|
26
|
+
readonly prompt: string;
|
|
27
|
+
/** This plugin's attachments only. */
|
|
28
|
+
readonly attachments: readonly PluginComposerAttachment[];
|
|
29
|
+
readonly agent: {
|
|
30
|
+
readonly provider: string | null;
|
|
31
|
+
readonly model: string | null;
|
|
32
|
+
readonly mode: string | null;
|
|
33
|
+
readonly thinking: string | null;
|
|
34
|
+
/** The options the agent runs with, including provider defaults. */
|
|
35
|
+
readonly options: Readonly<Record<string, JsonValue>>;
|
|
36
|
+
readonly metadata: Readonly<Record<string, JsonValue>>;
|
|
37
|
+
};
|
|
38
|
+
setPrompt(text: string): void;
|
|
39
|
+
/** Inserts at the cursor, replacing the selection. */
|
|
40
|
+
insertText(text: string): void;
|
|
41
|
+
/**
|
|
42
|
+
* Puts the cursor in this composer, ready to type. Paseo opens the agent's tab or workspace when
|
|
43
|
+
* it is not on screen. Resolves once the input has focus; rejects when it could not get there.
|
|
44
|
+
*/
|
|
45
|
+
focus(options?: PluginComposerFocusOptions): Promise<void>;
|
|
46
|
+
addAttachment(input: {
|
|
47
|
+
sourceId: string;
|
|
48
|
+
item: PluginAttachmentItem;
|
|
49
|
+
}): void;
|
|
50
|
+
removeAttachment(input: {
|
|
51
|
+
sourceId: string;
|
|
52
|
+
itemId: string;
|
|
53
|
+
}): void;
|
|
54
|
+
/** Resets the model like the built-in control. Rejects on a running agent, which keeps its provider. */
|
|
55
|
+
setProvider(provider: string): Promise<void>;
|
|
56
|
+
/** On a running agent, rejects with the provider's message when it refuses the model. */
|
|
57
|
+
setModel(modelId: string): Promise<void>;
|
|
58
|
+
setMode(modeId: string): Promise<void>;
|
|
59
|
+
setThinking(thinkingOptionId: string): Promise<void>;
|
|
60
|
+
/** Top-level keys replace; `null` removes the agent's own value. */
|
|
61
|
+
setOptions(patch: Record<string, JsonValue>): Promise<void>;
|
|
62
|
+
/** Top-level keys replace; `null` removes the key. */
|
|
63
|
+
setMetadata(patch: Record<string, JsonValue>): Promise<void>;
|
|
64
|
+
}
|
|
65
|
+
export interface PluginComposerItemProps extends PluginHostProps {
|
|
66
|
+
}
|
|
67
|
+
export interface PluginComposerItemContribution {
|
|
68
|
+
id: string;
|
|
69
|
+
Component: ComponentType<PluginComposerItemProps>;
|
|
70
|
+
}
|
|
71
|
+
export declare function PluginComposerProvider({ composer, children, }: {
|
|
72
|
+
composer: PluginComposer;
|
|
73
|
+
children: ReactNode;
|
|
74
|
+
}): import("react/jsx-runtime").JSX.Element;
|
|
75
|
+
export declare function usePluginComposerValue(): PluginComposer | null;
|
|
76
|
+
/** The composer this item sits in. Call it from a component registered with `addComposerItem`. */
|
|
77
|
+
export declare function useComposer(): PluginComposer;
|
|
78
|
+
/**
|
|
79
|
+
* Names the running agent whose composer a plugin wants. Both forms resolve to the same
|
|
80
|
+
* `PluginComposer` an item of that agent's composer gets from `useComposer()`.
|
|
81
|
+
*/
|
|
82
|
+
export type PluginComposerSelector = {
|
|
83
|
+
agentId: string;
|
|
84
|
+
} | {
|
|
85
|
+
focused: true;
|
|
86
|
+
};
|
|
87
|
+
/** What `useComposers` and `composers(selector)` read. Paseo implements it per installed plugin. */
|
|
88
|
+
export interface PluginComposersSource {
|
|
89
|
+
/** Tells `listener` when the composers `selector` names change, and keeps them live meanwhile. */
|
|
90
|
+
subscribe(selector: PluginComposerSelector, listener: () => void): () => void;
|
|
91
|
+
/** The composers `selector` names now: one for a known running agent, none otherwise. */
|
|
92
|
+
resolve(selector: PluginComposerSelector): readonly PluginComposer[];
|
|
93
|
+
}
|
|
94
|
+
export declare function PluginComposersProvider({ source, children, }: {
|
|
95
|
+
source: PluginComposersSource;
|
|
96
|
+
children: ReactNode;
|
|
97
|
+
}): import("react/jsx-runtime").JSX.Element;
|
|
98
|
+
export declare function usePluginComposersSource(): PluginComposersSource | null;
|
|
99
|
+
/**
|
|
100
|
+
* The composers `selector` names, whether or not their tabs are open. Runs in any plugin
|
|
101
|
+
* component. Empty for an unknown agent, or for `{ focused: true }` when no agent is focused.
|
|
102
|
+
*/
|
|
103
|
+
export declare function useComposers(selector: PluginComposerSelector): readonly PluginComposer[];
|
|
104
|
+
//# sourceMappingURL=composer.d.ts.map
|
|
@@ -0,0 +1,37 @@
|
|
|
1
|
+
import { jsx as _jsx } from "react/jsx-runtime";
|
|
2
|
+
import { createContext, useContext, useMemo, useSyncExternalStore, } from "react";
|
|
3
|
+
const PluginComposerContext = createContext(null);
|
|
4
|
+
export function PluginComposerProvider({ composer, children, }) {
|
|
5
|
+
return (_jsx(PluginComposerContext.Provider, { value: composer, children: children }));
|
|
6
|
+
}
|
|
7
|
+
export function usePluginComposerValue() {
|
|
8
|
+
return useContext(PluginComposerContext);
|
|
9
|
+
}
|
|
10
|
+
/** The composer this item sits in. Call it from a component registered with `addComposerItem`. */
|
|
11
|
+
export function useComposer() {
|
|
12
|
+
const composer = usePluginComposerValue();
|
|
13
|
+
if (!composer)
|
|
14
|
+
throw new Error("useComposer must run inside a composer item");
|
|
15
|
+
return composer;
|
|
16
|
+
}
|
|
17
|
+
const PluginComposersContext = createContext(null);
|
|
18
|
+
export function PluginComposersProvider({ source, children, }) {
|
|
19
|
+
return (_jsx(PluginComposersContext.Provider, { value: source, children: children }));
|
|
20
|
+
}
|
|
21
|
+
export function usePluginComposersSource() {
|
|
22
|
+
return useContext(PluginComposersContext);
|
|
23
|
+
}
|
|
24
|
+
/**
|
|
25
|
+
* The composers `selector` names, whether or not their tabs are open. Runs in any plugin
|
|
26
|
+
* component. Empty for an unknown agent, or for `{ focused: true }` when no agent is focused.
|
|
27
|
+
*/
|
|
28
|
+
export function useComposers(selector) {
|
|
29
|
+
const source = useContext(PluginComposersContext);
|
|
30
|
+
if (!source)
|
|
31
|
+
throw new Error("useComposers must run inside a plugin component");
|
|
32
|
+
// The selector is usually an inline literal; its content is what the subscription depends on.
|
|
33
|
+
const selection = "agentId" in selector ? selector.agentId : null;
|
|
34
|
+
const subscribe = useMemo(() => (listener) => source.subscribe(selection === null ? { focused: true } : { agentId: selection }, listener), [source, selection]);
|
|
35
|
+
return useSyncExternalStore(subscribe, () => source.resolve(selector), () => source.resolve(selector));
|
|
36
|
+
}
|
|
37
|
+
//# sourceMappingURL=composer.js.map
|
|
@@ -1,10 +1,13 @@
|
|
|
1
|
+
import type { WorkspaceRef, AgentRef, ProjectRef, TerminalRef } from "../refs.js";
|
|
1
2
|
import type { PluginText } from "../text.js";
|
|
2
3
|
import type { ComponentType } from "react";
|
|
3
|
-
import type {
|
|
4
|
+
import type { PluginPaseoApi } from "./reference-api.js";
|
|
4
5
|
import type { AgentTimelineItem, JsonValue } from "@getpaseo/protocol/agent-types";
|
|
5
6
|
import type { ZodType, input as ZodInput, output as ZodOutput } from "zod";
|
|
6
7
|
import type { PluginFile } from "./file.js";
|
|
7
|
-
import type {
|
|
8
|
+
import type { PluginComposer, PluginComposerItemContribution, PluginComposerSelector } from "./composer.js";
|
|
9
|
+
import type { PluginNewWorkspaceItemContribution } from "./new-workspace.js";
|
|
10
|
+
import type { PluginRpcContract, PluginSubscribeOptions, PluginSubscriptionContract, PluginSubscriptionHandle, PluginWireInput } from "../rpc.js";
|
|
8
11
|
import type { PluginButtonRegistration, PluginHeaderButtonContribution, PluginComposerPillContribution } from "./buttons.js";
|
|
9
12
|
import type { PluginTheme, PluginWorkspaceSnapshot, PluginAgentSnapshot, PluginThemeContribution, PluginAttachmentSourceContribution, PluginTimelineTransformResult, PluginCleanup } from "../contracts.js";
|
|
10
13
|
import type { PluginIconProps, PluginSerializableIcon } from "../icons.js";
|
|
@@ -71,6 +74,25 @@ export interface PluginSidebarItemContribution<Text extends PluginText = string>
|
|
|
71
74
|
title: Text;
|
|
72
75
|
Component: ComponentType<PluginSidebarItemProps>;
|
|
73
76
|
}
|
|
77
|
+
export interface PluginSidebarViewProps extends Pick<PluginHostProps, "theme" | "layout"> {
|
|
78
|
+
active: {
|
|
79
|
+
workspace: WorkspaceRef | null;
|
|
80
|
+
agent: AgentRef | null;
|
|
81
|
+
};
|
|
82
|
+
navigation: {
|
|
83
|
+
openWorkspace(ref: WorkspaceRef): void;
|
|
84
|
+
openAgent(ref: AgentRef): void;
|
|
85
|
+
openTerminal(ref: TerminalRef): void;
|
|
86
|
+
openProject(ref: ProjectRef): void;
|
|
87
|
+
};
|
|
88
|
+
dismiss(): void;
|
|
89
|
+
}
|
|
90
|
+
export interface PluginSidebarViewContribution<Text extends PluginText = string> {
|
|
91
|
+
id: string;
|
|
92
|
+
title: Text;
|
|
93
|
+
description?: Text;
|
|
94
|
+
Component: ComponentType<PluginSidebarViewProps>;
|
|
95
|
+
}
|
|
74
96
|
/**
|
|
75
97
|
* A Lucide icon name, inline SVG markup, or a component. Components receive the surface's size
|
|
76
98
|
* and color; buttons widen the props with their host and target context.
|
|
@@ -152,6 +174,7 @@ export interface PluginClientContext extends PluginCommandCapabilities, PluginCl
|
|
|
152
174
|
}): Promise<void>;
|
|
153
175
|
addSettingsScreen(contribution: PluginSettingsScreenContribution<PluginText>): PluginCleanup;
|
|
154
176
|
addScreen(contribution: PluginScreenContribution<PluginText>): PluginCleanup;
|
|
177
|
+
addSidebarView(contribution: PluginSidebarViewContribution<PluginText>): PluginCleanup;
|
|
155
178
|
addSidebarHeaderItem(contribution: PluginSidebarItemContribution<PluginText>): PluginCleanup;
|
|
156
179
|
addSidebarFooterItem(contribution: PluginSidebarItemContribution<PluginText>): PluginCleanup;
|
|
157
180
|
addAgentPanel(contribution: PluginAgentPanelContribution<PluginText>): PluginCleanup;
|
|
@@ -161,11 +184,18 @@ export interface PluginClientContext extends PluginCommandCapabilities, PluginCl
|
|
|
161
184
|
addHeaderButton(contribution: PluginHeaderButtonContribution<PluginText>): PluginButtonRegistration<PluginText>;
|
|
162
185
|
addComposerPill(contribution: PluginComposerPillContribution<PluginText>): PluginButtonRegistration<PluginText>;
|
|
163
186
|
addAttachmentSource(contribution: PluginAttachmentSourceContribution<PluginText>): PluginCleanup;
|
|
187
|
+
addComposerItem(contribution: PluginComposerItemContribution): PluginCleanup;
|
|
188
|
+
addNewWorkspaceItem(contribution: PluginNewWorkspaceItemContribution): PluginCleanup;
|
|
164
189
|
addTheme(contribution: PluginThemeContribution<PluginText>): PluginCleanup;
|
|
165
190
|
addFilePanel(contribution: PluginFilePanelContribution<PluginText>): PluginCleanup;
|
|
166
191
|
addTimelineTransformer<ItemType extends AgentTimelineItem["type"]>(contribution: PluginTimelineTransformerContribution<ItemType>): PluginCleanup;
|
|
167
192
|
addTimelineRenderer<Schema extends ZodType>(contribution: PluginTimelineRendererContribution<Schema>): PluginCleanup;
|
|
168
193
|
openPanel(id: string, options: PluginClientOpenPanelOptions): void;
|
|
194
|
+
/**
|
|
195
|
+
* Subscribes to a plugin subscription on this client's host. Paseo re-subscribes after a
|
|
196
|
+
* reconnect and releases what is left when the plugin stops.
|
|
197
|
+
*/
|
|
198
|
+
subscribe<InputSchema extends ZodType, EventSchema extends ZodType>(contract: PluginSubscriptionContract<InputSchema, EventSchema>, input: PluginWireInput<ZodInput<InputSchema>>, onEvent: (event: ZodOutput<EventSchema>) => void, options?: PluginSubscribeOptions): PluginSubscriptionHandle;
|
|
169
199
|
}
|
|
170
200
|
export type PluginClientContribution = (client: PluginClientContext) => PluginCleanup;
|
|
171
201
|
export type PluginWorkspacePanelContribution<Text extends PluginText = string> = (PluginWorkspacePanelBase<Text> & {
|
|
@@ -233,9 +263,11 @@ export interface PluginTimelineRendererContribution<Schema extends ZodType = Zod
|
|
|
233
263
|
Component: ComponentType<PluginTimelineItemProps<ZodOutput<Schema>>>;
|
|
234
264
|
}
|
|
235
265
|
export interface PluginCommandCapabilities {
|
|
236
|
-
paseo:
|
|
237
|
-
rpc<InputSchema extends ZodType, OutputSchema extends ZodType>(contract: PluginRpcContract<InputSchema, OutputSchema>, input: ZodInput<InputSchema
|
|
266
|
+
paseo: PluginPaseoApi;
|
|
267
|
+
rpc<InputSchema extends ZodType, OutputSchema extends ZodType>(contract: PluginRpcContract<InputSchema, OutputSchema>, input: PluginWireInput<ZodInput<InputSchema>>): Promise<ZodOutput<OutputSchema>>;
|
|
238
268
|
openScreen(input: PluginOpenScreenInput): void;
|
|
269
|
+
/** The composers `selector` names, whether or not their tabs are open; see `useComposers`. */
|
|
270
|
+
composers(selector: PluginComposerSelector): readonly PluginComposer[];
|
|
239
271
|
/** @deprecated Use `openScreen`. */
|
|
240
272
|
openSurface(id: string): void;
|
|
241
273
|
openSettings(id: string): void;
|
package/dist/client/host.d.ts
CHANGED
|
@@ -1,10 +1,12 @@
|
|
|
1
1
|
import type { PluginText } from "../text.js";
|
|
2
|
-
export { PluginClientStateProvider, type PluginClientStateSource } from "./client-state.js";
|
|
2
|
+
export { PluginClientStateProvider, usePaseoSelector, type PluginClientStateSource, type PluginClientSnapshot, } from "./client-state.js";
|
|
3
|
+
export { PluginComposerProvider, PluginComposersProvider, type PluginComposersSource, } from "./composer.js";
|
|
4
|
+
export { PluginNewWorkspaceProvider } from "./new-workspace.js";
|
|
3
5
|
export { usePluginRuntimeContextBridge, type PluginRuntimeContextBridge, } from "./runtime-context-bridge.js";
|
|
4
6
|
import type { PluginAttachmentSourceContribution } from "../contracts.js";
|
|
5
7
|
import { PluginRpcProvider } from "./rpc-context.js";
|
|
6
8
|
import { PaseoApiProvider } from "./paseo-context.js";
|
|
7
|
-
import { callPluginRpc } from "../rpc.js";
|
|
9
|
+
import { callPluginRpc, subscribePluginRpc, type PluginSubscriptionObserver } from "../rpc.js";
|
|
8
10
|
export declare function searchPluginAttachments(source: PluginAttachmentSourceContribution<PluginText>, invoke: (method: string, input: unknown) => Promise<unknown>, query: string): Promise<{
|
|
9
11
|
items: {
|
|
10
12
|
id: string;
|
|
@@ -16,7 +18,11 @@ export declare function searchPluginAttachments(source: PluginAttachmentSourceCo
|
|
|
16
18
|
subtitle?: string | undefined;
|
|
17
19
|
}[];
|
|
18
20
|
}>;
|
|
19
|
-
export { callPluginRpc, PaseoApiProvider, PluginRpcProvider };
|
|
21
|
+
export { callPluginRpc, subscribePluginRpc, PaseoApiProvider, PluginRpcProvider };
|
|
22
|
+
export type { PluginSubscriptionObserver };
|
|
23
|
+
export type { PluginSubscribe } from "./rpc-context.js";
|
|
20
24
|
export { PluginTranslationRuntime, PluginTranslationProvider, usePluginTranslationRuntime, requirePluginText, isPluginMessage, } from "./translations.js";
|
|
21
25
|
export type { PluginLocaleSource } from "./translations.js";
|
|
26
|
+
export { createEntityRefs } from "./refs.js";
|
|
27
|
+
export { createPluginReferenceApi } from "./reference-api.js";
|
|
22
28
|
//# sourceMappingURL=host.d.ts.map
|