crewcode-plugin-api 0.1.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.
- package/LICENSE +202 -0
- package/README.md +67 -0
- package/browser/crewcode-plugin-api.js +80 -0
- package/dist/create-api.d.ts +66 -0
- package/dist/create-api.js +79 -0
- package/dist/create-api.js.map +1 -0
- package/dist/index.d.ts +2 -0
- package/dist/index.js +6 -0
- package/dist/index.js.map +1 -0
- package/package.json +43 -0
package/LICENSE
ADDED
|
@@ -0,0 +1,202 @@
|
|
|
1
|
+
|
|
2
|
+
Apache License
|
|
3
|
+
Version 2.0, January 2004
|
|
4
|
+
http://www.apache.org/licenses/
|
|
5
|
+
|
|
6
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
|
7
|
+
|
|
8
|
+
1. Definitions.
|
|
9
|
+
|
|
10
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
|
11
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
|
12
|
+
|
|
13
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
|
14
|
+
the copyright owner that is granting the License.
|
|
15
|
+
|
|
16
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
|
17
|
+
other entities that control, are controlled by, or are under common
|
|
18
|
+
control with that entity. For the purposes of this definition,
|
|
19
|
+
"control" means (i) the power, direct or indirect, to cause the
|
|
20
|
+
direction or management of such entity, whether by contract or
|
|
21
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
|
22
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
|
23
|
+
|
|
24
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
|
25
|
+
exercising permissions granted by this License.
|
|
26
|
+
|
|
27
|
+
"Source" form shall mean the preferred form for making modifications,
|
|
28
|
+
including but not limited to software source code, documentation
|
|
29
|
+
source, and configuration files.
|
|
30
|
+
|
|
31
|
+
"Object" form shall mean any form resulting from mechanical
|
|
32
|
+
transformation or translation of a Source form, including but
|
|
33
|
+
not limited to compiled object code, generated documentation,
|
|
34
|
+
and conversions to other media types.
|
|
35
|
+
|
|
36
|
+
"Work" shall mean the work of authorship, whether in Source or
|
|
37
|
+
Object form, made available under the License, as indicated by a
|
|
38
|
+
copyright notice that is included in or attached to the work
|
|
39
|
+
(an example is provided in the Appendix below).
|
|
40
|
+
|
|
41
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
|
42
|
+
form, that is based on (or derived from) the Work and for which the
|
|
43
|
+
editorial revisions, annotations, elaborations, or other modifications
|
|
44
|
+
represent, as a whole, an original work of authorship. For the purposes
|
|
45
|
+
of this License, Derivative Works shall not include works that remain
|
|
46
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
|
47
|
+
the Work and Derivative Works thereof.
|
|
48
|
+
|
|
49
|
+
"Contribution" shall mean any work of authorship, including
|
|
50
|
+
the original version of the Work and any modifications or additions
|
|
51
|
+
to that Work or Derivative Works thereof, that is intentionally
|
|
52
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
|
53
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
|
54
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
|
55
|
+
means any form of electronic, verbal, or written communication sent
|
|
56
|
+
to the Licensor or its representatives, including but not limited to
|
|
57
|
+
communication on electronic mailing lists, source code control systems,
|
|
58
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
|
59
|
+
Licensor for the purpose of discussing and improving the Work, but
|
|
60
|
+
excluding communication that is conspicuously marked or otherwise
|
|
61
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
|
62
|
+
|
|
63
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
|
64
|
+
on behalf of whom a Contribution has been received by Licensor and
|
|
65
|
+
subsequently incorporated within the Work.
|
|
66
|
+
|
|
67
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
|
68
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
69
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
70
|
+
copyright license to reproduce, prepare Derivative Works of,
|
|
71
|
+
publicly display, publicly perform, sublicense, and distribute the
|
|
72
|
+
Work and such Derivative Works in Source or Object form.
|
|
73
|
+
|
|
74
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
|
75
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
76
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
77
|
+
(except as stated in this section) patent license to make, have made,
|
|
78
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
|
79
|
+
where such license applies only to those patent claims licensable
|
|
80
|
+
by such Contributor that are necessarily infringed by their
|
|
81
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
|
82
|
+
with the Work to which such Contribution(s) was submitted. If You
|
|
83
|
+
institute patent litigation against any entity (including a
|
|
84
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
|
85
|
+
or a Contribution incorporated within the Work constitutes direct
|
|
86
|
+
or contributory patent infringement, then any patent licenses
|
|
87
|
+
granted to You under this License for that Work shall terminate
|
|
88
|
+
as of the date such litigation is filed.
|
|
89
|
+
|
|
90
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
|
91
|
+
Work or Derivative Works thereof in any medium, with or without
|
|
92
|
+
modifications, and in Source or Object form, provided that You
|
|
93
|
+
meet the following conditions:
|
|
94
|
+
|
|
95
|
+
(a) You must give any other recipients of the Work or
|
|
96
|
+
Derivative Works a copy of this License; and
|
|
97
|
+
|
|
98
|
+
(b) You must cause any modified files to carry prominent notices
|
|
99
|
+
stating that You changed the files; and
|
|
100
|
+
|
|
101
|
+
(c) You must retain, in the Source form of any Derivative Works
|
|
102
|
+
that You distribute, all copyright, patent, trademark, and
|
|
103
|
+
attribution notices from the Source form of the Work,
|
|
104
|
+
excluding those notices that do not pertain to any part of
|
|
105
|
+
the Derivative Works; and
|
|
106
|
+
|
|
107
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
|
108
|
+
distribution, then any Derivative Works that You distribute must
|
|
109
|
+
include a readable copy of the attribution notices contained
|
|
110
|
+
within such NOTICE file, excluding those notices that do not
|
|
111
|
+
pertain to any part of the Derivative Works, in at least one
|
|
112
|
+
of the following places: within a NOTICE text file distributed
|
|
113
|
+
as part of the Derivative Works; within the Source form or
|
|
114
|
+
documentation, if provided along with the Derivative Works; or,
|
|
115
|
+
within a display generated by the Derivative Works, if and
|
|
116
|
+
wherever such third-party notices normally appear. The contents
|
|
117
|
+
of the NOTICE file are for informational purposes only and
|
|
118
|
+
do not modify the License. You may add Your own attribution
|
|
119
|
+
notices within Derivative Works that You distribute, alongside
|
|
120
|
+
or as an addendum to the NOTICE text from the Work, provided
|
|
121
|
+
that such additional attribution notices cannot be construed
|
|
122
|
+
as modifying the License.
|
|
123
|
+
|
|
124
|
+
You may add Your own copyright statement to Your modifications and
|
|
125
|
+
may provide additional or different license terms and conditions
|
|
126
|
+
for use, reproduction, or distribution of Your modifications, or
|
|
127
|
+
for any such Derivative Works as a whole, provided Your use,
|
|
128
|
+
reproduction, and distribution of the Work otherwise complies with
|
|
129
|
+
the conditions stated in this License.
|
|
130
|
+
|
|
131
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
|
132
|
+
any Contribution intentionally submitted for inclusion in the Work
|
|
133
|
+
by You to the Licensor shall be under the terms and conditions of
|
|
134
|
+
this License, without any additional terms or conditions.
|
|
135
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
|
136
|
+
the terms of any separate license agreement you may have executed
|
|
137
|
+
with Licensor regarding such Contributions.
|
|
138
|
+
|
|
139
|
+
6. Trademarks. This License does not grant permission to use the trade
|
|
140
|
+
names, trademarks, service marks, or product names of the Licensor,
|
|
141
|
+
except as required for reasonable and customary use in describing the
|
|
142
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
|
143
|
+
|
|
144
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
|
145
|
+
agreed to in writing, Licensor provides the Work (and each
|
|
146
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
|
147
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
|
148
|
+
implied, including, without limitation, any warranties or conditions
|
|
149
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
|
150
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
|
151
|
+
appropriateness of using or redistributing the Work and assume any
|
|
152
|
+
risks associated with Your exercise of permissions under this License.
|
|
153
|
+
|
|
154
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
|
155
|
+
whether in tort (including negligence), contract, or otherwise,
|
|
156
|
+
unless required by applicable law (such as deliberate and grossly
|
|
157
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
|
158
|
+
liable to You for damages, including any direct, indirect, special,
|
|
159
|
+
incidental, or consequential damages of any character arising as a
|
|
160
|
+
result of this License or out of the use or inability to use the
|
|
161
|
+
Work (including but not limited to damages for loss of goodwill,
|
|
162
|
+
work stoppage, computer failure or malfunction, or any and all
|
|
163
|
+
other commercial damages or losses), even if such Contributor
|
|
164
|
+
has been advised of the possibility of such damages.
|
|
165
|
+
|
|
166
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
|
167
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
|
168
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
|
169
|
+
or other liability obligations and/or rights consistent with this
|
|
170
|
+
License. However, in accepting such obligations, You may act only
|
|
171
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
|
172
|
+
of any other Contributor, and only if You agree to indemnify,
|
|
173
|
+
defend, and hold each Contributor harmless for any liability
|
|
174
|
+
incurred by, or claims asserted against, such Contributor by reason
|
|
175
|
+
of your accepting any such warranty or additional liability.
|
|
176
|
+
|
|
177
|
+
END OF TERMS AND CONDITIONS
|
|
178
|
+
|
|
179
|
+
APPENDIX: How to apply the Apache License to your work.
|
|
180
|
+
|
|
181
|
+
To apply the Apache License to your work, attach the following
|
|
182
|
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
|
183
|
+
replaced with your own identifying information. (Don't include
|
|
184
|
+
the brackets!) The text should be enclosed in the appropriate
|
|
185
|
+
comment syntax for the file format. We also recommend that a
|
|
186
|
+
file or class name and description of purpose be included on the
|
|
187
|
+
same "printed page" as the copyright notice for easier
|
|
188
|
+
identification within third-party archives.
|
|
189
|
+
|
|
190
|
+
Copyright 2026 OnPoint Tools
|
|
191
|
+
|
|
192
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
|
193
|
+
you may not use this file except in compliance with the License.
|
|
194
|
+
You may obtain a copy of the License at
|
|
195
|
+
|
|
196
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
|
197
|
+
|
|
198
|
+
Unless required by applicable law or agreed to in writing, software
|
|
199
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
|
200
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
201
|
+
See the License for the specific language governing permissions and
|
|
202
|
+
limitations under the License.
|
package/README.md
ADDED
|
@@ -0,0 +1,67 @@
|
|
|
1
|
+
# crewcode-plugin-api
|
|
2
|
+
|
|
3
|
+
Official typed/browser API for isolated CrewCode plugin panels.
|
|
4
|
+
|
|
5
|
+
This package is the source contract for the v0 plugin bridge. Plugin UI still runs in a sandboxed iframe and never receives `window.electronAPI`; calls are forwarded through CrewCode's permission gate.
|
|
6
|
+
|
|
7
|
+
## TypeScript / bundled plugins
|
|
8
|
+
|
|
9
|
+
```ts
|
|
10
|
+
import { crewcode } from 'crewcode-plugin-api'
|
|
11
|
+
|
|
12
|
+
crewcode.onContext(ctx => {
|
|
13
|
+
console.log(ctx.workspace?.name)
|
|
14
|
+
console.log(ctx.openContext.source)
|
|
15
|
+
})
|
|
16
|
+
|
|
17
|
+
const { files } = await crewcode.workspace.listFiles()
|
|
18
|
+
const app = await crewcode.workspace.readFile('src/App.tsx')
|
|
19
|
+
```
|
|
20
|
+
|
|
21
|
+
## Static/no-build plugins
|
|
22
|
+
|
|
23
|
+
Copy the canonical browser helper from this package into your plugin folder:
|
|
24
|
+
|
|
25
|
+
```txt
|
|
26
|
+
crewcode-plugin-api.js
|
|
27
|
+
```
|
|
28
|
+
|
|
29
|
+
Then load it before your plugin code:
|
|
30
|
+
|
|
31
|
+
```html
|
|
32
|
+
<script src="crewcode-plugin-api.js"></script>
|
|
33
|
+
<script src="plugin.js"></script>
|
|
34
|
+
```
|
|
35
|
+
|
|
36
|
+
The helper exposes `window.crewcode` and `window.crewcode.apiVersion`. It is generated from this package's TypeScript source (`npm run build:browser`) — do not edit the vendored `.js` by hand.
|
|
37
|
+
|
|
38
|
+
`workspace.writeFile()` requires the plugin manifest permission `workspace:write`. `ctx.openContext` explains why/how the panel was opened and may include optional safe hints such as `filePath` or `browserUrl`.
|
|
39
|
+
|
|
40
|
+
## Custom timeout
|
|
41
|
+
|
|
42
|
+
Requests reject after 10 seconds by default. On large or SSH-backed workspaces you can widen it by building your own instance from the exposed factory:
|
|
43
|
+
|
|
44
|
+
```ts
|
|
45
|
+
import { createCrewCodeApi } from 'crewcode-plugin-api'
|
|
46
|
+
const crewcode = createCrewCodeApi({ timeoutMs: 30_000 })
|
|
47
|
+
```
|
|
48
|
+
|
|
49
|
+
The no-build helper also exposes `window.createCrewCodeApi` for the same purpose.
|
|
50
|
+
|
|
51
|
+
## Host version
|
|
52
|
+
|
|
53
|
+
The context payload carries `hostApiVersion` — the plugin API version of the running CrewCode. The manifest gate already rejects a plugin whose declared `crewcode.apiVersion` the host does not support, but you can also feature-detect at runtime:
|
|
54
|
+
|
|
55
|
+
```ts
|
|
56
|
+
crewcode.onContext(ctx => {
|
|
57
|
+
if (ctx.hostApiVersion && ctx.hostApiVersion !== crewcode.apiVersion) {
|
|
58
|
+
// adapt or warn
|
|
59
|
+
}
|
|
60
|
+
})
|
|
61
|
+
```
|
|
62
|
+
|
|
63
|
+
## Reserved in v0
|
|
64
|
+
|
|
65
|
+
`crewcode.network.fetch()` and `crewcode.secrets.get()` are declared for forward-compatibility but are **reserved** — they reject immediately with an explanatory message. For network access use an `agentProvider` runtime (`http`/`sse-http`/`openai-compatible`/`websocket`); for auth use a provider `apiKeyEnv` or local CLI auth.
|
|
66
|
+
|
|
67
|
+
Do not put secrets in plugin HTML/JS or manifests. Plugin iframes never receive secrets.
|
|
@@ -0,0 +1,80 @@
|
|
|
1
|
+
// Official CrewCode plugin browser helper. GENERATED from src/ — do not edit by hand.
|
|
2
|
+
// Runs inside sandboxed plugin iframes. It never exposes Electron APIs.
|
|
3
|
+
"use strict";
|
|
4
|
+
(() => {
|
|
5
|
+
// src/create-api.ts
|
|
6
|
+
var CREWCODE_PLUGIN_API_VERSION = "0.1";
|
|
7
|
+
var RESERVED_NETWORK_MESSAGE = "crewcode.network.fetch is reserved in plugin API v0. Use an agentProvider runtime (http/sse-http/openai-compatible/websocket) for network access.";
|
|
8
|
+
var RESERVED_SECRETS_MESSAGE = "crewcode.secrets.get is reserved in plugin API v0. Use a provider apiKeyEnv or local CLI auth instead.";
|
|
9
|
+
function createCrewCodeApi(options = {}) {
|
|
10
|
+
var _a, _b;
|
|
11
|
+
const timeoutMs = (_a = options.timeoutMs) != null ? _a : 1e4;
|
|
12
|
+
const targetOrigin = (_b = options.targetOrigin) != null ? _b : "*";
|
|
13
|
+
const pending = /* @__PURE__ */ new Map();
|
|
14
|
+
const contextListeners = /* @__PURE__ */ new Set();
|
|
15
|
+
let seq = 0;
|
|
16
|
+
let latestContext = null;
|
|
17
|
+
const reportError = (err) => {
|
|
18
|
+
const error = err instanceof Error ? err : new Error(String(err));
|
|
19
|
+
window.parent.postMessage({ type: "crewcode:runtimeError", message: error.message, stack: error.stack }, targetOrigin);
|
|
20
|
+
};
|
|
21
|
+
window.addEventListener("error", (event) => {
|
|
22
|
+
var _a2;
|
|
23
|
+
return reportError((_a2 = event.error) != null ? _a2 : event.message);
|
|
24
|
+
});
|
|
25
|
+
window.addEventListener("unhandledrejection", (event) => reportError(event.reason));
|
|
26
|
+
const request = (method, params) => {
|
|
27
|
+
const id = `req-${++seq}`;
|
|
28
|
+
window.parent.postMessage({ type: "crewcode:request", id, method, params }, targetOrigin);
|
|
29
|
+
return new Promise((resolve, reject) => {
|
|
30
|
+
pending.set(id, { resolve, reject });
|
|
31
|
+
window.setTimeout(() => {
|
|
32
|
+
if (!pending.has(id)) return;
|
|
33
|
+
pending.delete(id);
|
|
34
|
+
reject(new Error("CrewCode plugin request timed out"));
|
|
35
|
+
}, timeoutMs);
|
|
36
|
+
});
|
|
37
|
+
};
|
|
38
|
+
window.addEventListener("message", (event) => {
|
|
39
|
+
if (event.source !== window.parent) return;
|
|
40
|
+
const msg = event.data;
|
|
41
|
+
if (!msg || typeof msg !== "object") return;
|
|
42
|
+
if (msg.type === "crewcode:context") {
|
|
43
|
+
latestContext = msg;
|
|
44
|
+
for (const listener of contextListeners) listener(latestContext);
|
|
45
|
+
return;
|
|
46
|
+
}
|
|
47
|
+
if (msg.type === "crewcode:response" && typeof msg.id === "string" && pending.has(msg.id)) {
|
|
48
|
+
const callbacks = pending.get(msg.id);
|
|
49
|
+
pending.delete(msg.id);
|
|
50
|
+
if (msg.ok) callbacks.resolve(msg.result);
|
|
51
|
+
else callbacks.reject(new Error(typeof msg.error === "string" ? msg.error : "plugin request failed"));
|
|
52
|
+
}
|
|
53
|
+
});
|
|
54
|
+
return {
|
|
55
|
+
apiVersion: CREWCODE_PLUGIN_API_VERSION,
|
|
56
|
+
request,
|
|
57
|
+
onContext(listener) {
|
|
58
|
+
contextListeners.add(listener);
|
|
59
|
+
if (latestContext) listener(latestContext);
|
|
60
|
+
return () => contextListeners.delete(listener);
|
|
61
|
+
},
|
|
62
|
+
getContext: () => latestContext,
|
|
63
|
+
workspace: {
|
|
64
|
+
listFiles: () => request("workspace:listFiles"),
|
|
65
|
+
readFile: (sub) => request("workspace:readFile", { sub }),
|
|
66
|
+
writeFile: (sub, text) => request("workspace:writeFile", { sub, text })
|
|
67
|
+
},
|
|
68
|
+
network: {
|
|
69
|
+
fetch: () => Promise.reject(new Error(RESERVED_NETWORK_MESSAGE))
|
|
70
|
+
},
|
|
71
|
+
secrets: {
|
|
72
|
+
get: () => Promise.reject(new Error(RESERVED_SECRETS_MESSAGE))
|
|
73
|
+
}
|
|
74
|
+
};
|
|
75
|
+
}
|
|
76
|
+
|
|
77
|
+
// src/browser-global.ts
|
|
78
|
+
window.createCrewCodeApi = createCrewCodeApi;
|
|
79
|
+
window.crewcode = createCrewCodeApi();
|
|
80
|
+
})();
|
|
@@ -0,0 +1,66 @@
|
|
|
1
|
+
export declare const CREWCODE_PLUGIN_API_VERSION: "0.1";
|
|
2
|
+
export type CrewCodePluginApiVersion = typeof CREWCODE_PLUGIN_API_VERSION;
|
|
3
|
+
export interface CrewCodeWorkspaceContext {
|
|
4
|
+
id: string;
|
|
5
|
+
name: string;
|
|
6
|
+
kind: string;
|
|
7
|
+
}
|
|
8
|
+
export interface CrewCodePluginOpenContext {
|
|
9
|
+
source: string;
|
|
10
|
+
filePath?: string;
|
|
11
|
+
browserUrl?: string;
|
|
12
|
+
terminalPaneId?: string;
|
|
13
|
+
chatMessageId?: string;
|
|
14
|
+
}
|
|
15
|
+
export interface CrewCodePluginContext {
|
|
16
|
+
type: 'crewcode:context';
|
|
17
|
+
/**
|
|
18
|
+
* The plugin API version of the running CrewCode host. Use it to feature-detect
|
|
19
|
+
* at runtime, e.g. `if (ctx.hostApiVersion !== crewcode.apiVersion) { ... }`.
|
|
20
|
+
* Optional for backward compatibility with hosts that predate this field.
|
|
21
|
+
*/
|
|
22
|
+
hostApiVersion?: string;
|
|
23
|
+
pluginId: string;
|
|
24
|
+
registrationId: string;
|
|
25
|
+
workspace: CrewCodeWorkspaceContext | null;
|
|
26
|
+
permissions: string[];
|
|
27
|
+
openContext: CrewCodePluginOpenContext;
|
|
28
|
+
}
|
|
29
|
+
export interface WorkspaceFileList {
|
|
30
|
+
files: string[];
|
|
31
|
+
}
|
|
32
|
+
export interface WorkspaceReadFileResult {
|
|
33
|
+
rel: string;
|
|
34
|
+
text: string;
|
|
35
|
+
size: number;
|
|
36
|
+
}
|
|
37
|
+
export interface WorkspaceWriteFileResult {
|
|
38
|
+
rel: string;
|
|
39
|
+
}
|
|
40
|
+
export interface CrewCodeWorkspaceApi {
|
|
41
|
+
listFiles(): Promise<WorkspaceFileList>;
|
|
42
|
+
readFile(sub: string): Promise<WorkspaceReadFileResult>;
|
|
43
|
+
writeFile(sub: string, text: string): Promise<WorkspaceWriteFileResult>;
|
|
44
|
+
}
|
|
45
|
+
export interface CrewCodeNetworkApi {
|
|
46
|
+
fetch(input: string, init?: Record<string, unknown>): Promise<never>;
|
|
47
|
+
}
|
|
48
|
+
export interface CrewCodeSecretsApi {
|
|
49
|
+
get(key: string): Promise<never>;
|
|
50
|
+
}
|
|
51
|
+
export interface CrewCodePluginApi {
|
|
52
|
+
apiVersion: CrewCodePluginApiVersion;
|
|
53
|
+
request<T = unknown>(method: string, params?: Record<string, unknown>): Promise<T>;
|
|
54
|
+
onContext(listener: (ctx: CrewCodePluginContext) => void): () => void;
|
|
55
|
+
getContext(): CrewCodePluginContext | null;
|
|
56
|
+
workspace: CrewCodeWorkspaceApi;
|
|
57
|
+
network: CrewCodeNetworkApi;
|
|
58
|
+
secrets: CrewCodeSecretsApi;
|
|
59
|
+
}
|
|
60
|
+
export interface CreateCrewCodeApiOptions {
|
|
61
|
+
/** Milliseconds before an unanswered request rejects. Default 10000. */
|
|
62
|
+
timeoutMs?: number;
|
|
63
|
+
/** postMessage targetOrigin. Default '*'. */
|
|
64
|
+
targetOrigin?: string;
|
|
65
|
+
}
|
|
66
|
+
export declare function createCrewCodeApi(options?: CreateCrewCodeApiOptions): CrewCodePluginApi;
|
|
@@ -0,0 +1,79 @@
|
|
|
1
|
+
export const CREWCODE_PLUGIN_API_VERSION = '0.1';
|
|
2
|
+
// Reserved v0 namespaces: these are declared for forward-compat but the host
|
|
3
|
+
// gate denies them from iframes today. Reject early with an actionable message
|
|
4
|
+
// instead of round-tripping to the host only to fail there.
|
|
5
|
+
const RESERVED_NETWORK_MESSAGE = 'crewcode.network.fetch is reserved in plugin API v0. Use an agentProvider runtime (http/sse-http/openai-compatible/websocket) for network access.';
|
|
6
|
+
const RESERVED_SECRETS_MESSAGE = 'crewcode.secrets.get is reserved in plugin API v0. Use a provider apiKeyEnv or local CLI auth instead.';
|
|
7
|
+
export function createCrewCodeApi(options = {}) {
|
|
8
|
+
const timeoutMs = options.timeoutMs ?? 10_000;
|
|
9
|
+
const targetOrigin = options.targetOrigin ?? '*';
|
|
10
|
+
const pending = new Map();
|
|
11
|
+
const contextListeners = new Set();
|
|
12
|
+
let seq = 0;
|
|
13
|
+
let latestContext = null;
|
|
14
|
+
const reportError = (err) => {
|
|
15
|
+
const error = err instanceof Error ? err : new Error(String(err));
|
|
16
|
+
window.parent.postMessage({ type: 'crewcode:runtimeError', message: error.message, stack: error.stack }, targetOrigin);
|
|
17
|
+
};
|
|
18
|
+
window.addEventListener('error', event => reportError(event.error ?? event.message));
|
|
19
|
+
window.addEventListener('unhandledrejection', event => reportError(event.reason));
|
|
20
|
+
const request = (method, params) => {
|
|
21
|
+
const id = `req-${++seq}`;
|
|
22
|
+
window.parent.postMessage({ type: 'crewcode:request', id, method, params }, targetOrigin);
|
|
23
|
+
return new Promise((resolve, reject) => {
|
|
24
|
+
pending.set(id, { resolve: resolve, reject });
|
|
25
|
+
window.setTimeout(() => {
|
|
26
|
+
if (!pending.has(id))
|
|
27
|
+
return;
|
|
28
|
+
pending.delete(id);
|
|
29
|
+
reject(new Error('CrewCode plugin request timed out'));
|
|
30
|
+
}, timeoutMs);
|
|
31
|
+
});
|
|
32
|
+
};
|
|
33
|
+
window.addEventListener('message', event => {
|
|
34
|
+
// Only trust messages from the embedding CrewCode renderer, never sibling
|
|
35
|
+
// frames or nested content injected into the panel.
|
|
36
|
+
if (event.source !== window.parent)
|
|
37
|
+
return;
|
|
38
|
+
const msg = event.data;
|
|
39
|
+
if (!msg || typeof msg !== 'object')
|
|
40
|
+
return;
|
|
41
|
+
if (msg.type === 'crewcode:context') {
|
|
42
|
+
latestContext = msg;
|
|
43
|
+
for (const listener of contextListeners)
|
|
44
|
+
listener(latestContext);
|
|
45
|
+
return;
|
|
46
|
+
}
|
|
47
|
+
if (msg.type === 'crewcode:response' && typeof msg.id === 'string' && pending.has(msg.id)) {
|
|
48
|
+
const callbacks = pending.get(msg.id);
|
|
49
|
+
pending.delete(msg.id);
|
|
50
|
+
if (msg.ok)
|
|
51
|
+
callbacks.resolve(msg.result);
|
|
52
|
+
else
|
|
53
|
+
callbacks.reject(new Error(typeof msg.error === 'string' ? msg.error : 'plugin request failed'));
|
|
54
|
+
}
|
|
55
|
+
});
|
|
56
|
+
return {
|
|
57
|
+
apiVersion: CREWCODE_PLUGIN_API_VERSION,
|
|
58
|
+
request,
|
|
59
|
+
onContext(listener) {
|
|
60
|
+
contextListeners.add(listener);
|
|
61
|
+
if (latestContext)
|
|
62
|
+
listener(latestContext);
|
|
63
|
+
return () => contextListeners.delete(listener);
|
|
64
|
+
},
|
|
65
|
+
getContext: () => latestContext,
|
|
66
|
+
workspace: {
|
|
67
|
+
listFiles: () => request('workspace:listFiles'),
|
|
68
|
+
readFile: sub => request('workspace:readFile', { sub }),
|
|
69
|
+
writeFile: (sub, text) => request('workspace:writeFile', { sub, text }),
|
|
70
|
+
},
|
|
71
|
+
network: {
|
|
72
|
+
fetch: () => Promise.reject(new Error(RESERVED_NETWORK_MESSAGE)),
|
|
73
|
+
},
|
|
74
|
+
secrets: {
|
|
75
|
+
get: () => Promise.reject(new Error(RESERVED_SECRETS_MESSAGE)),
|
|
76
|
+
},
|
|
77
|
+
};
|
|
78
|
+
}
|
|
79
|
+
//# sourceMappingURL=create-api.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"create-api.js","sourceRoot":"","sources":["../src/create-api.ts"],"names":[],"mappings":"AAAA,MAAM,CAAC,MAAM,2BAA2B,GAAG,KAAc,CAAA;AAmFzD,6EAA6E;AAC7E,+EAA+E;AAC/E,4DAA4D;AAC5D,MAAM,wBAAwB,GAC5B,mJAAmJ,CAAA;AACrJ,MAAM,wBAAwB,GAC5B,wGAAwG,CAAA;AAE1G,MAAM,UAAU,iBAAiB,CAAC,UAAoC,EAAE;IACtE,MAAM,SAAS,GAAG,OAAO,CAAC,SAAS,IAAI,MAAM,CAAA;IAC7C,MAAM,YAAY,GAAG,OAAO,CAAC,YAAY,IAAI,GAAG,CAAA;IAChD,MAAM,OAAO,GAAG,IAAI,GAAG,EAA0B,CAAA;IACjD,MAAM,gBAAgB,GAAG,IAAI,GAAG,EAAwC,CAAA;IACxE,IAAI,GAAG,GAAG,CAAC,CAAA;IACX,IAAI,aAAa,GAAiC,IAAI,CAAA;IAEtD,MAAM,WAAW,GAAG,CAAC,GAAY,EAAE,EAAE;QACnC,MAAM,KAAK,GAAG,GAAG,YAAY,KAAK,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,KAAK,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAA;QACjE,MAAM,CAAC,MAAM,CAAC,WAAW,CAAC,EAAE,IAAI,EAAE,uBAAuB,EAAE,OAAO,EAAE,KAAK,CAAC,OAAO,EAAE,KAAK,EAAE,KAAK,CAAC,KAAK,EAAE,EAAE,YAAY,CAAC,CAAA;IACxH,CAAC,CAAA;IAED,MAAM,CAAC,gBAAgB,CAAC,OAAO,EAAE,KAAK,CAAC,EAAE,CAAC,WAAW,CAAC,KAAK,CAAC,KAAK,IAAI,KAAK,CAAC,OAAO,CAAC,CAAC,CAAA;IACpF,MAAM,CAAC,gBAAgB,CAAC,oBAAoB,EAAE,KAAK,CAAC,EAAE,CAAC,WAAW,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CAAA;IAEjF,MAAM,OAAO,GAAG,CAAc,MAAc,EAAE,MAAgC,EAAc,EAAE;QAC5F,MAAM,EAAE,GAAG,OAAO,EAAE,GAAG,EAAE,CAAA;QACzB,MAAM,CAAC,MAAM,CAAC,WAAW,CAAC,EAAE,IAAI,EAAE,kBAAkB,EAAE,EAAE,EAAE,MAAM,EAAE,MAAM,EAAE,EAAE,YAAY,CAAC,CAAA;QACzF,OAAO,IAAI,OAAO,CAAI,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;YACxC,OAAO,CAAC,GAAG,CAAC,EAAE,EAAE,EAAE,OAAO,EAAE,OAAmC,EAAE,MAAM,EAAE,CAAC,CAAA;YACzE,MAAM,CAAC,UAAU,CAAC,GAAG,EAAE;gBACrB,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE,CAAC;oBAAE,OAAM;gBAC5B,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC,CAAA;gBAClB,MAAM,CAAC,IAAI,KAAK,CAAC,mCAAmC,CAAC,CAAC,CAAA;YACxD,CAAC,EAAE,SAAS,CAAC,CAAA;QACf,CAAC,CAAC,CAAA;IACJ,CAAC,CAAA;IAED,MAAM,CAAC,gBAAgB,CAAC,SAAS,EAAE,KAAK,CAAC,EAAE;QACzC,0EAA0E;QAC1E,oDAAoD;QACpD,IAAI,KAAK,CAAC,MAAM,KAAK,MAAM,CAAC,MAAM;YAAE,OAAM;QAE1C,MAAM,GAAG,GAAG,KAAK,CAAC,IAAsC,CAAA;QACxD,IAAI,CAAC,GAAG,IAAI,OAAO,GAAG,KAAK,QAAQ;YAAE,OAAM;QAE3C,IAAI,GAAG,CAAC,IAAI,KAAK,kBAAkB,EAAE,CAAC;YACpC,aAAa,GAAG,GAAuC,CAAA;YACvD,KAAK,MAAM,QAAQ,IAAI,gBAAgB;gBAAE,QAAQ,CAAC,aAAa,CAAC,CAAA;YAChE,OAAM;QACR,CAAC;QAED,IAAI,GAAG,CAAC,IAAI,KAAK,mBAAmB,IAAI,OAAO,GAAG,CAAC,EAAE,KAAK,QAAQ,IAAI,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,CAAC;YAC1F,MAAM,SAAS,GAAG,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,CAAE,CAAA;YACtC,OAAO,CAAC,MAAM,CAAC,GAAG,CAAC,EAAE,CAAC,CAAA;YACtB,IAAI,GAAG,CAAC,EAAE;gBAAE,SAAS,CAAC,OAAO,CAAC,GAAG,CAAC,MAAM,CAAC,CAAA;;gBACpC,SAAS,CAAC,MAAM,CAAC,IAAI,KAAK,CAAC,OAAO,GAAG,CAAC,KAAK,KAAK,QAAQ,CAAC,CAAC,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC,uBAAuB,CAAC,CAAC,CAAA;QACvG,CAAC;IACH,CAAC,CAAC,CAAA;IAEF,OAAO;QACL,UAAU,EAAE,2BAA2B;QACvC,OAAO;QACP,SAAS,CAAC,QAAQ;YAChB,gBAAgB,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAA;YAC9B,IAAI,aAAa;gBAAE,QAAQ,CAAC,aAAa,CAAC,CAAA;YAC1C,OAAO,GAAG,EAAE,CAAC,gBAAgB,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAA;QAChD,CAAC;QACD,UAAU,EAAE,GAAG,EAAE,CAAC,aAAa;QAC/B,SAAS,EAAE;YACT,SAAS,EAAE,GAAG,EAAE,CAAC,OAAO,CAAoB,qBAAqB,CAAC;YAClE,QAAQ,EAAE,GAAG,CAAC,EAAE,CAAC,OAAO,CAA0B,oBAAoB,EAAE,EAAE,GAAG,EAAE,CAAC;YAChF,SAAS,EAAE,CAAC,GAAG,EAAE,IAAI,EAAE,EAAE,CAAC,OAAO,CAA2B,qBAAqB,EAAE,EAAE,GAAG,EAAE,IAAI,EAAE,CAAC;SAClG;QACD,OAAO,EAAE;YACP,KAAK,EAAE,GAAG,EAAE,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,KAAK,CAAC,wBAAwB,CAAC,CAAC;SACjE;QACD,OAAO,EAAE;YACP,GAAG,EAAE,GAAG,EAAE,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,KAAK,CAAC,wBAAwB,CAAC,CAAC;SAC/D;KACF,CAAA;AACH,CAAC"}
|
package/dist/index.d.ts
ADDED
package/dist/index.js
ADDED
|
@@ -0,0 +1,6 @@
|
|
|
1
|
+
export * from './create-api';
|
|
2
|
+
import { createCrewCodeApi } from './create-api';
|
|
3
|
+
// Default singleton for `import { crewcode } from 'crewcode-plugin-api'`.
|
|
4
|
+
// Authors who need custom options can call createCrewCodeApi() themselves.
|
|
5
|
+
export const crewcode = createCrewCodeApi();
|
|
6
|
+
//# sourceMappingURL=index.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,cAAc,CAAA;AAE5B,OAAO,EAAE,iBAAiB,EAAE,MAAM,cAAc,CAAA;AAEhD,0EAA0E;AAC1E,2EAA2E;AAC3E,MAAM,CAAC,MAAM,QAAQ,GAAG,iBAAiB,EAAE,CAAA"}
|
package/package.json
ADDED
|
@@ -0,0 +1,43 @@
|
|
|
1
|
+
{
|
|
2
|
+
"name": "crewcode-plugin-api",
|
|
3
|
+
"version": "0.1.0",
|
|
4
|
+
"description": "Typed browser API for isolated CrewCode plugin panels.",
|
|
5
|
+
"license": "Apache-2.0",
|
|
6
|
+
"type": "module",
|
|
7
|
+
"keywords": [
|
|
8
|
+
"crewcode",
|
|
9
|
+
"plugin",
|
|
10
|
+
"plugin-api",
|
|
11
|
+
"ade",
|
|
12
|
+
"ai-agents"
|
|
13
|
+
],
|
|
14
|
+
"homepage": "https://github.com/CjLogic/CrewCode/tree/main/packages/crewcode-plugin-api#readme",
|
|
15
|
+
"repository": {
|
|
16
|
+
"type": "git",
|
|
17
|
+
"url": "git+https://github.com/CjLogic/CrewCode.git",
|
|
18
|
+
"directory": "packages/crewcode-plugin-api"
|
|
19
|
+
},
|
|
20
|
+
"bugs": {
|
|
21
|
+
"url": "https://github.com/CjLogic/CrewCode/issues"
|
|
22
|
+
},
|
|
23
|
+
"main": "dist/index.js",
|
|
24
|
+
"types": "dist/index.d.ts",
|
|
25
|
+
"exports": {
|
|
26
|
+
".": {
|
|
27
|
+
"types": "./dist/index.d.ts",
|
|
28
|
+
"import": "./dist/index.js"
|
|
29
|
+
},
|
|
30
|
+
"./browser": "./browser/crewcode-plugin-api.js"
|
|
31
|
+
},
|
|
32
|
+
"scripts": {
|
|
33
|
+
"build": "tsc -p tsconfig.json && npm run build:browser",
|
|
34
|
+
"build:browser": "node scripts/build-browser.mjs",
|
|
35
|
+
"sync": "node scripts/sync-vendored.mjs",
|
|
36
|
+
"prepublishOnly": "npm run build"
|
|
37
|
+
},
|
|
38
|
+
"devDependencies": {
|
|
39
|
+
"esbuild": "^0.25.0",
|
|
40
|
+
"typescript": "^5.5.0"
|
|
41
|
+
},
|
|
42
|
+
"files": ["dist", "browser", "LICENSE", "README.md"]
|
|
43
|
+
}
|