@eigenpal/sdk 0.6.15 → 0.6.17
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/CHANGELOG.md +6 -0
- package/README.md +2 -2
- package/package.json +1 -1
- package/src/client.ts +4 -4
- package/src/errors.ts +1 -1
- package/src/generated/client.gen.ts +1 -1
- package/src/generated/index.ts +0 -7
- package/src/generated/sdk.gen.ts +0 -17
- package/src/generated/types.gen.ts +1 -55
- package/src/index.ts +0 -1
- package/src/resources/runs.ts +0 -8
- package/src/runtime-config.ts +1 -1
- package/src/telemetry.ts +1 -1
package/CHANGELOG.md
CHANGED
package/README.md
CHANGED
|
@@ -15,7 +15,7 @@ npm i @eigenpal/sdk
|
|
|
15
15
|
|
|
16
16
|
Requires a TypeScript-aware runtime: Bun, Deno, Node 22+ (native TS), `tsx`, Next.js, Vite, or any modern bundler. Plain `node script.js` won't work — see [Configuration](./docs/configuration.md#typescript-runtime).
|
|
17
17
|
|
|
18
|
-
Get an API key at **
|
|
18
|
+
Get an API key at **studio.eigenpal.com → Settings → API Keys**.
|
|
19
19
|
|
|
20
20
|
## Quick start
|
|
21
21
|
|
|
@@ -53,7 +53,7 @@ const client = new EigenpalClient({
|
|
|
53
53
|
});
|
|
54
54
|
```
|
|
55
55
|
|
|
56
|
-
`baseUrl` likewise wins over the `EIGENPAL_BASE_URL` env fallback. Defaults to `https://
|
|
56
|
+
`baseUrl` likewise wins over the `EIGENPAL_BASE_URL` env fallback. Defaults to `https://studio.eigenpal.com` (the hosted cloud).
|
|
57
57
|
|
|
58
58
|
## Starting runs
|
|
59
59
|
|
package/package.json
CHANGED
package/src/client.ts
CHANGED
|
@@ -21,7 +21,7 @@ export interface EigenpalOptions {
|
|
|
21
21
|
/**
|
|
22
22
|
* Override the API base URL.
|
|
23
23
|
*
|
|
24
|
-
* Defaults to `EIGENPAL_BASE_URL` if set, otherwise `https://
|
|
24
|
+
* Defaults to `EIGENPAL_BASE_URL` if set, otherwise `https://studio.eigenpal.com`.
|
|
25
25
|
*/
|
|
26
26
|
baseUrl?: string;
|
|
27
27
|
/** Per-request timeout in milliseconds. Defaults to 60_000. */
|
|
@@ -34,7 +34,7 @@ export interface EigenpalOptions {
|
|
|
34
34
|
defaultHeaders?: Record<string, string>;
|
|
35
35
|
}
|
|
36
36
|
|
|
37
|
-
const DEFAULT_BASE_URL = 'https://
|
|
37
|
+
const DEFAULT_BASE_URL = 'https://studio.eigenpal.com';
|
|
38
38
|
const DEFAULT_TIMEOUT_MS = 60_000;
|
|
39
39
|
const DEFAULT_MAX_RETRIES = 3;
|
|
40
40
|
|
|
@@ -266,7 +266,7 @@ export class EigenpalClient {
|
|
|
266
266
|
const response = result.response;
|
|
267
267
|
const status = response?.status ?? 0;
|
|
268
268
|
// Guard against misconfigured `baseUrl` pointed at an HTML host
|
|
269
|
-
// (e.g. `https://eigenpal.com` instead of `https://
|
|
269
|
+
// (e.g. `https://eigenpal.com` instead of `https://studio.eigenpal.com`).
|
|
270
270
|
// Fires for both 2xx and non-2xx so a 4xx with HTML surfaces a typed
|
|
271
271
|
// baseUrl-pointing error instead of a misleading NotFoundError or a
|
|
272
272
|
// downstream JSON-parse crash. 0.4.10 shipped with this footgun.
|
|
@@ -368,7 +368,7 @@ function assertJsonResponse(response: Response): void {
|
|
|
368
368
|
`Expected a JSON response from the API but got Content-Type "${contentType}". ` +
|
|
369
369
|
`This usually means \`baseUrl\` points at a non-API host (e.g. the marketing site or ` +
|
|
370
370
|
`a misconfigured proxy). Set \`baseUrl\` to your EigenPal instance root, ` +
|
|
371
|
-
`e.g. "https://
|
|
371
|
+
`e.g. "https://studio.eigenpal.com".`,
|
|
372
372
|
{ status: response.status }
|
|
373
373
|
);
|
|
374
374
|
}
|
package/src/errors.ts
CHANGED
|
@@ -27,7 +27,7 @@ export class EigenpalAuthError extends EigenpalError {
|
|
|
27
27
|
constructor(envelope?: ApiErrorEnvelope) {
|
|
28
28
|
super(
|
|
29
29
|
envelope?.issues?.[0]?.message ??
|
|
30
|
-
'Invalid or missing API key. Generate one at
|
|
30
|
+
'Invalid or missing API key. Generate one at studio.eigenpal.com → Settings → API Keys; ' +
|
|
31
31
|
'pass it as `new EigenpalClient({ apiKey })` or set EIGENPAL_API_KEY.',
|
|
32
32
|
{ status: 401, envelope }
|
|
33
33
|
);
|
|
@@ -18,5 +18,5 @@ export type CreateClientConfig<T extends ClientOptions = ClientOptions2> = (
|
|
|
18
18
|
) => Config<Required<ClientOptions> & T>;
|
|
19
19
|
|
|
20
20
|
export const client = createClient(
|
|
21
|
-
createClientConfig(createConfig<ClientOptions2>({ baseUrl: 'https://
|
|
21
|
+
createClientConfig(createConfig<ClientOptions2>({ baseUrl: 'https://studio.eigenpal.com' }))
|
|
22
22
|
);
|
package/src/generated/index.ts
CHANGED
|
@@ -36,7 +36,6 @@ export {
|
|
|
36
36
|
runsGet,
|
|
37
37
|
runsList,
|
|
38
38
|
runsRerun,
|
|
39
|
-
runsResume,
|
|
40
39
|
runsTraceGet,
|
|
41
40
|
sourceLockfilePreview,
|
|
42
41
|
sourceRaw,
|
|
@@ -141,7 +140,6 @@ export type {
|
|
|
141
140
|
RunFilesResponse,
|
|
142
141
|
RunRerunRequest,
|
|
143
142
|
RunRerunResponse,
|
|
144
|
-
RunResumeResponse,
|
|
145
143
|
RunStartResponse,
|
|
146
144
|
RunStartWithTargetData,
|
|
147
145
|
RunStartWithTargetError,
|
|
@@ -244,11 +242,6 @@ export type {
|
|
|
244
242
|
RunsRerunErrors,
|
|
245
243
|
RunsRerunResponse,
|
|
246
244
|
RunsRerunResponses,
|
|
247
|
-
RunsResumeData,
|
|
248
|
-
RunsResumeError,
|
|
249
|
-
RunsResumeErrors,
|
|
250
|
-
RunsResumeResponse,
|
|
251
|
-
RunsResumeResponses,
|
|
252
245
|
RunsTraceGetData,
|
|
253
246
|
RunsTraceGetError,
|
|
254
247
|
RunsTraceGetErrors,
|
package/src/generated/sdk.gen.ts
CHANGED
|
@@ -108,9 +108,6 @@ import type {
|
|
|
108
108
|
RunsRerunData,
|
|
109
109
|
RunsRerunErrors,
|
|
110
110
|
RunsRerunResponses,
|
|
111
|
-
RunsResumeData,
|
|
112
|
-
RunsResumeErrors,
|
|
113
|
-
RunsResumeResponses,
|
|
114
111
|
RunStartWithTargetData,
|
|
115
112
|
RunStartWithTargetErrors,
|
|
116
113
|
RunStartWithTargetResponses,
|
|
@@ -715,20 +712,6 @@ export const runsRerun = <ThrowOnError extends boolean = false>(
|
|
|
715
712
|
},
|
|
716
713
|
});
|
|
717
714
|
|
|
718
|
-
/**
|
|
719
|
-
* Resume workflow run
|
|
720
|
-
*
|
|
721
|
-
* Resume a workflow run that is waiting for approval.
|
|
722
|
-
*/
|
|
723
|
-
export const runsResume = <ThrowOnError extends boolean = false>(
|
|
724
|
-
options: Options<RunsResumeData, ThrowOnError>
|
|
725
|
-
) =>
|
|
726
|
-
(options.client ?? client).post<RunsResumeResponses, RunsResumeErrors, ThrowOnError>({
|
|
727
|
-
security: [{ scheme: 'bearer', type: 'http' }],
|
|
728
|
-
url: '/api/v1/runs/{id}/resume',
|
|
729
|
-
...options,
|
|
730
|
-
});
|
|
731
|
-
|
|
732
715
|
/**
|
|
733
716
|
* Get run
|
|
734
717
|
*
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
// This file is auto-generated by @hey-api/openapi-ts
|
|
2
2
|
|
|
3
3
|
export type ClientOptions = {
|
|
4
|
-
baseUrl: 'https://
|
|
4
|
+
baseUrl: 'https://studio.eigenpal.com' | (string & {});
|
|
5
5
|
};
|
|
6
6
|
|
|
7
7
|
export type PatchAgentBody = {
|
|
@@ -248,10 +248,6 @@ export type RunRerunResponse = {
|
|
|
248
248
|
status?: string;
|
|
249
249
|
};
|
|
250
250
|
|
|
251
|
-
export type RunResumeResponse = {
|
|
252
|
-
[key: string]: unknown;
|
|
253
|
-
};
|
|
254
|
-
|
|
255
251
|
export type RunEnvelope = {
|
|
256
252
|
run:
|
|
257
253
|
| RunSummary
|
|
@@ -2168,56 +2164,6 @@ export type RunsRerunResponses = {
|
|
|
2168
2164
|
|
|
2169
2165
|
export type RunsRerunResponse = RunsRerunResponses[keyof RunsRerunResponses];
|
|
2170
2166
|
|
|
2171
|
-
export type RunsResumeData = {
|
|
2172
|
-
body?: never;
|
|
2173
|
-
path: {
|
|
2174
|
-
/**
|
|
2175
|
-
* Run id
|
|
2176
|
-
*/
|
|
2177
|
-
id: string;
|
|
2178
|
-
};
|
|
2179
|
-
query?: never;
|
|
2180
|
-
url: '/api/v1/runs/{id}/resume';
|
|
2181
|
-
};
|
|
2182
|
-
|
|
2183
|
-
export type RunsResumeErrors = {
|
|
2184
|
-
/**
|
|
2185
|
-
* Validation error. Request shape did not match the spec.
|
|
2186
|
-
*/
|
|
2187
|
-
400: ApiErrorEnvelope;
|
|
2188
|
-
/**
|
|
2189
|
-
* Missing or invalid API key
|
|
2190
|
-
*/
|
|
2191
|
-
401: ApiErrorEnvelope;
|
|
2192
|
-
/**
|
|
2193
|
-
* API key lacks required scope
|
|
2194
|
-
*/
|
|
2195
|
-
403: ApiErrorEnvelope;
|
|
2196
|
-
/**
|
|
2197
|
-
* Resource not found
|
|
2198
|
-
*/
|
|
2199
|
-
404: ApiErrorEnvelope;
|
|
2200
|
-
/**
|
|
2201
|
-
* Rate limit exceeded
|
|
2202
|
-
*/
|
|
2203
|
-
429: ApiErrorEnvelope;
|
|
2204
|
-
/**
|
|
2205
|
-
* Internal server error
|
|
2206
|
-
*/
|
|
2207
|
-
500: ApiErrorEnvelope;
|
|
2208
|
-
};
|
|
2209
|
-
|
|
2210
|
-
export type RunsResumeError = RunsResumeErrors[keyof RunsResumeErrors];
|
|
2211
|
-
|
|
2212
|
-
export type RunsResumeResponses = {
|
|
2213
|
-
/**
|
|
2214
|
-
* Run resumed
|
|
2215
|
-
*/
|
|
2216
|
-
200: RunResumeResponse;
|
|
2217
|
-
};
|
|
2218
|
-
|
|
2219
|
-
export type RunsResumeResponse = RunsResumeResponses[keyof RunsResumeResponses];
|
|
2220
|
-
|
|
2221
2167
|
export type RunsGetData = {
|
|
2222
2168
|
body?: never;
|
|
2223
2169
|
path: {
|
package/src/index.ts
CHANGED
package/src/resources/runs.ts
CHANGED
|
@@ -21,7 +21,6 @@ import {
|
|
|
21
21
|
runsGet,
|
|
22
22
|
runsList,
|
|
23
23
|
runsRerun,
|
|
24
|
-
runsResume,
|
|
25
24
|
runsTraceGet,
|
|
26
25
|
} from '../generated/sdk.gen';
|
|
27
26
|
import type {
|
|
@@ -47,7 +46,6 @@ import type {
|
|
|
47
46
|
RunsListData,
|
|
48
47
|
RunsListResponse,
|
|
49
48
|
RunsRerunResponse,
|
|
50
|
-
RunsResumeResponse,
|
|
51
49
|
RunsTraceGetResponse,
|
|
52
50
|
} from '../generated/types.gen';
|
|
53
51
|
|
|
@@ -93,12 +91,6 @@ export class RunsResource {
|
|
|
93
91
|
return response.run;
|
|
94
92
|
}
|
|
95
93
|
|
|
96
|
-
async resume(runId: string, options: SignalOptions = {}): Promise<RunsResumeResponse> {
|
|
97
|
-
return this.dispatch(() =>
|
|
98
|
-
runsResume({ client: this.client, path: { id: runId }, signal: options.signal })
|
|
99
|
-
);
|
|
100
|
-
}
|
|
101
|
-
|
|
102
94
|
async cancel(runId: string, options: SignalOptions = {}): Promise<RunsCancelResponse> {
|
|
103
95
|
return this.dispatch(() =>
|
|
104
96
|
runsCancel({ client: this.client, path: { id: runId }, signal: options.signal })
|
package/src/runtime-config.ts
CHANGED
|
@@ -11,5 +11,5 @@ import type { CreateClientConfig } from './generated/client.gen';
|
|
|
11
11
|
*/
|
|
12
12
|
export const createClientConfig: CreateClientConfig = (config) => ({
|
|
13
13
|
...config,
|
|
14
|
-
baseUrl: config?.baseUrl ?? 'https://
|
|
14
|
+
baseUrl: config?.baseUrl ?? 'https://studio.eigenpal.com',
|
|
15
15
|
});
|
package/src/telemetry.ts
CHANGED
|
@@ -19,7 +19,7 @@
|
|
|
19
19
|
export const SDK_LANGUAGE = 'typescript';
|
|
20
20
|
// Rewritten at publish time by scripts/render-sdk-versions.sh.
|
|
21
21
|
// Keep this string literal exactly stable — sed matches on it.
|
|
22
|
-
export const SDK_VERSION = '0.6.
|
|
22
|
+
export const SDK_VERSION = '0.6.17';
|
|
23
23
|
|
|
24
24
|
function detectRuntime(): string {
|
|
25
25
|
const g = globalThis as unknown as {
|