@deepraxis/sdk 0.1.0-dev.06cf3b8 → 0.1.0-dev.13103a0
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/METHODS.md +14 -1
- package/dist/generated/index.d.ts +2 -2
- package/dist/generated/index.js +1 -1
- package/dist/generated/sdk.gen.d.ts +31 -13
- package/dist/generated/sdk.gen.js +90 -40
- package/dist/generated/types.gen.d.ts +4601 -3337
- package/dist/helpers/application-publish.d.ts +24 -4
- package/dist/helpers/application-publish.js +53 -3
- package/dist/operations.generated.d.ts +57 -0
- package/dist/operations.generated.js +77 -0
- package/dist/resources.generated.d.ts +353 -0
- package/dist/resources.generated.js +7 -0
- package/package.json +1 -1
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import type { Praxis } from '../core/client.js';
|
|
2
|
-
import type { ApplicationAssetsConfig, ApplicationBinding } from '../generated/types.gen.js';
|
|
2
|
+
import type { ApplicationAssetsConfig, ApplicationBinding, ApplicationVersion } from '../generated/types.gen.js';
|
|
3
3
|
export type AssetsConfig = ApplicationAssetsConfig;
|
|
4
4
|
export interface PublishInput {
|
|
5
5
|
/** 应用名;存在同名应用时复用。 */
|
|
@@ -20,16 +20,32 @@ export interface PublishInput {
|
|
|
20
20
|
bindings?: ApplicationBinding[];
|
|
21
21
|
/** 静态资源路由配置,原样传递。 */
|
|
22
22
|
assets_config?: AssetsConfig;
|
|
23
|
+
/** Register an upload session to plan changes; do not upload content or publish. Requires an existing application. */
|
|
24
|
+
dryRun?: boolean;
|
|
25
|
+
/** Preserve current paths omitted from files. Defaults to false (whole-site replacement). */
|
|
26
|
+
keepExisting?: boolean;
|
|
23
27
|
/** 是否等待部署完成,默认 true。 */
|
|
24
28
|
wait?: boolean;
|
|
25
29
|
/** 部署等待上限(毫秒),默认 120000。超时不会撤销部署。 */
|
|
26
30
|
timeout_ms?: number;
|
|
27
31
|
}
|
|
28
32
|
export interface PublishResult {
|
|
33
|
+
/** True when a static-only publication matches the active version. */
|
|
34
|
+
unchanged?: boolean;
|
|
35
|
+
/** Current version when unchanged or planning an existing deployment. */
|
|
36
|
+
version?: ApplicationVersion;
|
|
37
|
+
/** dryRun compares against the active version; counts are distinct content hashes. */
|
|
38
|
+
plan?: {
|
|
39
|
+
added: string[];
|
|
40
|
+
changed: string[];
|
|
41
|
+
removed: string[];
|
|
42
|
+
upload_hashes: number;
|
|
43
|
+
existing_hashes: number;
|
|
44
|
+
};
|
|
29
45
|
url: string;
|
|
30
46
|
worker_id: string;
|
|
31
|
-
version_id: string;
|
|
32
|
-
deployment_id: string;
|
|
47
|
+
version_id: string | null;
|
|
48
|
+
deployment_id: string | null;
|
|
33
49
|
status: string;
|
|
34
50
|
created: boolean;
|
|
35
51
|
/** 本次上传的不同内容 hash 数量。 */
|
|
@@ -37,5 +53,9 @@ export interface PublishResult {
|
|
|
37
53
|
/** 服务端已存在的不同内容 hash 数量。 */
|
|
38
54
|
reused: number;
|
|
39
55
|
}
|
|
40
|
-
/** Publish
|
|
56
|
+
/** Publish with whole-site replacement by default; keepExisting preserves omitted paths.
|
|
57
|
+
* dryRun registers an idempotent upload session (stores its manifest), but uploads no content and does not publish.
|
|
58
|
+
* The platform does not support gradual rollout. Roll back using workers.deployments.create with
|
|
59
|
+
* strategy: 'percentage', versions: [{ version_id: previousVersionId, percentage: 100 }], while artifacts are retained.
|
|
60
|
+
*/
|
|
41
61
|
export declare function publish(client: Pick<Praxis, 'application'>, input: PublishInput): Promise<PublishResult>;
|
|
@@ -8,8 +8,16 @@ function base64(bytes) {
|
|
|
8
8
|
}
|
|
9
9
|
return btoa(chunks.join(''));
|
|
10
10
|
}
|
|
11
|
-
/** Publish
|
|
11
|
+
/** Publish with whole-site replacement by default; keepExisting preserves omitted paths.
|
|
12
|
+
* dryRun registers an idempotent upload session (stores its manifest), but uploads no content and does not publish.
|
|
13
|
+
* The platform does not support gradual rollout. Roll back using workers.deployments.create with
|
|
14
|
+
* strategy: 'percentage', versions: [{ version_id: previousVersionId, percentage: 100 }], while artifacts are retained.
|
|
15
|
+
*/
|
|
12
16
|
export async function publish(client, input) {
|
|
17
|
+
const rolloutFields = ['gradual', 'gradualRollout', 'gradual_rollout', 'canary', 'rollout', 'percentage', 'percent', 'traffic', 'traffic_percentage', 'strategy', 'versions'];
|
|
18
|
+
if (Object.keys(input).some(key => rolloutFields.includes(key) || /percentage|percent|canary|gradual|rollout|灰度/i.test(key))) {
|
|
19
|
+
throw new PraxisError({ code: 'INVALID_PARAMS', message: '平台不支持灰度 (gradual rollout is not supported). Roll back with praxis.application.workers.deployments.create({ path: { worker_id }, body: { strategy: "percentage", versions: [{ version_id: previousVersionId, percentage: 100 }] } }); the previous version artifacts must still be retained.' });
|
|
20
|
+
}
|
|
13
21
|
const timeout = input.timeout_ms ?? 120_000;
|
|
14
22
|
if (!Number.isFinite(timeout) || timeout < 0)
|
|
15
23
|
throw new RangeError('timeout_ms must be non-negative and finite');
|
|
@@ -21,7 +29,7 @@ export async function publish(client, input) {
|
|
|
21
29
|
const files = Object.entries(input.files);
|
|
22
30
|
if (files.length > 100_000)
|
|
23
31
|
throw new PraxisError({ code: 'LIMIT_EXCEEDED', message: 'At most 100000 asset paths can be published' });
|
|
24
|
-
|
|
32
|
+
let manifest = {};
|
|
25
33
|
const contents = new Map();
|
|
26
34
|
for (const [path, content] of files) {
|
|
27
35
|
const normalized = path.startsWith('/') ? path : `/${path}`;
|
|
@@ -44,9 +52,51 @@ export async function publish(client, input) {
|
|
|
44
52
|
}
|
|
45
53
|
}
|
|
46
54
|
const created = !worker;
|
|
55
|
+
if (!worker && input.dryRun)
|
|
56
|
+
throw new PraxisError({ code: 'NOT_FOUND', message: '请先创建应用 (create the application before dryRun)' });
|
|
47
57
|
worker ??= await workers.create({ body: { name: input.name, subdomain: { enabled: true } } });
|
|
48
58
|
const path = { worker_id: worker.id };
|
|
59
|
+
let currentVersion;
|
|
60
|
+
let currentDeployment;
|
|
61
|
+
let previous = {};
|
|
62
|
+
if (worker.praxis?.current_deployment_id) {
|
|
63
|
+
currentDeployment = await workers.deployments.retrieve({ path: { ...path, deployment_id: worker.praxis.current_deployment_id } });
|
|
64
|
+
const active = currentDeployment.versions[0];
|
|
65
|
+
if (!active)
|
|
66
|
+
throw new PraxisError({ code: 'INVALID_RESPONSE', message: 'Current deployment has no version' });
|
|
67
|
+
currentVersion = await workers.versions.retrieve({ path: { ...path, version_id: active.version_id } });
|
|
68
|
+
previous = (await workers.versions.assets.retrieveManifest({ path: { ...path, version_id: active.version_id } })).manifest;
|
|
69
|
+
}
|
|
70
|
+
// Keep the stored path order: the service hashes JSON.stringify(manifest), including property order.
|
|
71
|
+
// Reordered input with identical paths must still hash to the active version's manifest_hash.
|
|
72
|
+
manifest = {
|
|
73
|
+
...Object.fromEntries(Object.entries(previous).filter(([key]) => input.keepExisting || Object.hasOwn(manifest, key))),
|
|
74
|
+
...manifest,
|
|
75
|
+
};
|
|
76
|
+
if (Object.keys(manifest).length > 100_000)
|
|
77
|
+
throw new PraxisError({ code: 'LIMIT_EXCEEDED', message: 'At most 100000 asset paths can be published' });
|
|
78
|
+
const added = Object.keys(manifest).filter(key => !Object.hasOwn(previous, key));
|
|
79
|
+
const changed = Object.keys(manifest).filter(key => previous[key] && (previous[key].hash !== manifest[key].hash || previous[key].size !== manifest[key].size));
|
|
80
|
+
const removed = Object.keys(previous).filter(key => !Object.hasOwn(manifest, key));
|
|
81
|
+
const digest = new Uint8Array(await crypto.subtle.digest('SHA-256', new TextEncoder().encode(JSON.stringify(manifest))));
|
|
82
|
+
const manifestHash = Array.from(digest, byte => byte.toString(16).padStart(2, '0')).join('');
|
|
83
|
+
const staticOnly = !['main', 'bindings', 'compatibility_date', 'compatibility_flags', 'assets_config'].some(key => Object.hasOwn(input, key));
|
|
84
|
+
const unchanged = staticOnly && !!currentVersion && manifestHash === currentVersion.praxis.assets_manifest?.manifest_hash;
|
|
85
|
+
const hashes = new Set(Object.values(manifest).map(entry => entry.hash));
|
|
86
|
+
const currentResult = { url: worker.subdomain.url, worker_id: worker.id, version_id: currentVersion?.id ?? null,
|
|
87
|
+
deployment_id: currentDeployment?.id ?? null, status: currentDeployment?.praxis.status ?? 'draft', created,
|
|
88
|
+
...(currentVersion ? { version: currentVersion } : {}), unchanged, uploaded: 0, reused: hashes.size };
|
|
89
|
+
if (unchanged && !input.dryRun)
|
|
90
|
+
return currentResult;
|
|
91
|
+
// dryRun intentionally registers the content-addressed session manifest, but never uploads or publishes.
|
|
49
92
|
const session = await workers.assetsUploadSession.create({ path, body: { manifest } });
|
|
93
|
+
if (input.dryRun) {
|
|
94
|
+
const missing = new Set(session.buckets.flat());
|
|
95
|
+
if ([...missing].some(hash => !hashes.has(hash)))
|
|
96
|
+
throw new PraxisError({ code: 'INVALID_RESPONSE', message: 'Upload session requested an unknown hash' });
|
|
97
|
+
return { ...currentResult, reused: hashes.size - missing.size,
|
|
98
|
+
plan: { added, changed, removed, upload_hashes: missing.size, existing_hashes: hashes.size - missing.size } };
|
|
99
|
+
}
|
|
50
100
|
let jwt = session.buckets.length ? null : session.jwt;
|
|
51
101
|
const uploaded = new Set();
|
|
52
102
|
for (const bucket of session.buckets) {
|
|
@@ -112,5 +162,5 @@ export async function publish(client, input) {
|
|
|
112
162
|
}
|
|
113
163
|
return { url: worker.subdomain.url, worker_id: worker.id, version_id: result.version.id,
|
|
114
164
|
deployment_id: deployment.id, status: deployment.praxis.status, created,
|
|
115
|
-
uploaded: uploaded.size, reused:
|
|
165
|
+
uploaded: uploaded.size, reused: hashes.size - uploaded.size };
|
|
116
166
|
}
|
|
@@ -140,6 +140,12 @@ export declare const operations: readonly [{
|
|
|
140
140
|
readonly type: "object";
|
|
141
141
|
readonly required: false;
|
|
142
142
|
readonly description: "Praxis extension: switchable model ids on /agent/v1 only. The default model must be included. When omitted, only the default model is selectable.";
|
|
143
|
+
}, {
|
|
144
|
+
readonly name: "preset";
|
|
145
|
+
readonly type: "string";
|
|
146
|
+
readonly enum: readonly ["minimal", "data-editor", "full"];
|
|
147
|
+
readonly required: false;
|
|
148
|
+
readonly description: "Optional tool preset. minimal enables read, glob, grep and ask_user_question; data-editor also enables write and edit; full uses the default toolset with always_allow. Explicit tools override matching preset entries. codemode requires bash and is absent from data-editor.";
|
|
143
149
|
}];
|
|
144
150
|
};
|
|
145
151
|
}, {
|
|
@@ -268,6 +274,12 @@ export declare const operations: readonly [{
|
|
|
268
274
|
readonly type: "object";
|
|
269
275
|
readonly required: false;
|
|
270
276
|
readonly description: "Praxis extension: switchable model ids on /agent/v1 only. The default model must be included. When omitted, only the default model is selectable.";
|
|
277
|
+
}, {
|
|
278
|
+
readonly name: "preset";
|
|
279
|
+
readonly type: "string";
|
|
280
|
+
readonly enum: readonly ["minimal", "data-editor", "full"];
|
|
281
|
+
readonly required: false;
|
|
282
|
+
readonly description: "Optional tool preset. minimal enables read, glob, grep and ask_user_question; data-editor also enables write and edit; full uses the default toolset with always_allow. Explicit tools override matching preset entries. codemode requires bash and is absent from data-editor.";
|
|
271
283
|
}];
|
|
272
284
|
};
|
|
273
285
|
}, {
|
|
@@ -420,6 +432,20 @@ export declare const operations: readonly [{
|
|
|
420
432
|
readonly sdkName: "external_user_id";
|
|
421
433
|
}];
|
|
422
434
|
readonly query: readonly [];
|
|
435
|
+
}, {
|
|
436
|
+
readonly resource: "agent.agents.unarchive";
|
|
437
|
+
readonly method: "create";
|
|
438
|
+
readonly summary: "Unarchive Agent";
|
|
439
|
+
readonly description: "Restore an archived agent without creating a configuration version. Already active agents are unchanged. Missing or inaccessible agents return 404. Use the returned agent id to create new sessions.";
|
|
440
|
+
readonly http: "POST";
|
|
441
|
+
readonly path: "/agent/v1/agents/{agent_id}/unarchive";
|
|
442
|
+
readonly streaming: "no";
|
|
443
|
+
readonly pagination: false;
|
|
444
|
+
readonly pathParams: readonly [{
|
|
445
|
+
readonly name: "agent_id";
|
|
446
|
+
readonly sdkName: "agent_id";
|
|
447
|
+
}];
|
|
448
|
+
readonly query: readonly [];
|
|
423
449
|
}, {
|
|
424
450
|
readonly resource: "agent.agents.versions";
|
|
425
451
|
readonly method: "list";
|
|
@@ -1485,6 +1511,20 @@ export declare const operations: readonly [{
|
|
|
1485
1511
|
readonly description: "Praxis extension: explicit session thinking effort; null inherits the pinned agent default, then the model default. none disables thinking only when model.thinking.can_disable is true. Unsupported efforts return 400 invalid_request_error.";
|
|
1486
1512
|
}];
|
|
1487
1513
|
};
|
|
1514
|
+
}, {
|
|
1515
|
+
readonly resource: "agent.sessions";
|
|
1516
|
+
readonly method: "delete";
|
|
1517
|
+
readonly summary: "Delete session";
|
|
1518
|
+
readonly description: "Delete an idle or terminated session and its event history after saving a deletion snapshot. Supply the session id from creation or listing. Running sessions return 409 INVALID_STATE: interrupt first or wait until idle or terminated. Afterwards retrieval and event listing return 404 and lists omit the session. Example: DELETE /agent/v1/sessions/sesn_example.";
|
|
1519
|
+
readonly http: "DELETE";
|
|
1520
|
+
readonly path: "/agent/v1/sessions/{session_id}";
|
|
1521
|
+
readonly streaming: "no";
|
|
1522
|
+
readonly pagination: false;
|
|
1523
|
+
readonly pathParams: readonly [{
|
|
1524
|
+
readonly name: "session_id";
|
|
1525
|
+
readonly sdkName: "session_id";
|
|
1526
|
+
}];
|
|
1527
|
+
readonly query: readonly [];
|
|
1488
1528
|
}, {
|
|
1489
1529
|
readonly resource: "agent.sessions";
|
|
1490
1530
|
readonly method: "retrieve";
|
|
@@ -2694,6 +2734,23 @@ export declare const operations: readonly [{
|
|
|
2694
2734
|
readonly sdkName: "version_id";
|
|
2695
2735
|
}];
|
|
2696
2736
|
readonly query: readonly [];
|
|
2737
|
+
}, {
|
|
2738
|
+
readonly resource: "application.workers.versions.assets";
|
|
2739
|
+
readonly method: "retrieveManifest";
|
|
2740
|
+
readonly summary: "Get version asset manifest";
|
|
2741
|
+
readonly description: "Read the retained asset paths, content hashes and byte sizes of a version for publication planning. This read creates no session or version. A version without assets returns an empty manifest; unavailable artifacts and foreign resources return 404.";
|
|
2742
|
+
readonly http: "GET";
|
|
2743
|
+
readonly path: "/application/v1/workers/{worker_id}/versions/{version_id}/assets/manifest";
|
|
2744
|
+
readonly streaming: "no";
|
|
2745
|
+
readonly pagination: false;
|
|
2746
|
+
readonly pathParams: readonly [{
|
|
2747
|
+
readonly name: "worker_id";
|
|
2748
|
+
readonly sdkName: "worker_id";
|
|
2749
|
+
}, {
|
|
2750
|
+
readonly name: "version_id";
|
|
2751
|
+
readonly sdkName: "version_id";
|
|
2752
|
+
}];
|
|
2753
|
+
readonly query: readonly [];
|
|
2697
2754
|
}, {
|
|
2698
2755
|
readonly resource: "automation.actions";
|
|
2699
2756
|
readonly method: "list";
|
|
@@ -175,6 +175,17 @@ export const operations = [
|
|
|
175
175
|
"type": "object",
|
|
176
176
|
"required": false,
|
|
177
177
|
"description": "Praxis extension: switchable model ids on /agent/v1 only. The default model must be included. When omitted, only the default model is selectable."
|
|
178
|
+
},
|
|
179
|
+
{
|
|
180
|
+
"name": "preset",
|
|
181
|
+
"type": "string",
|
|
182
|
+
"enum": [
|
|
183
|
+
"minimal",
|
|
184
|
+
"data-editor",
|
|
185
|
+
"full"
|
|
186
|
+
],
|
|
187
|
+
"required": false,
|
|
188
|
+
"description": "Optional tool preset. minimal enables read, glob, grep and ask_user_question; data-editor also enables write and edit; full uses the default toolset with always_allow. Explicit tools override matching preset entries. codemode requires bash and is absent from data-editor."
|
|
178
189
|
}
|
|
179
190
|
]
|
|
180
191
|
}
|
|
@@ -332,6 +343,17 @@ export const operations = [
|
|
|
332
343
|
"type": "object",
|
|
333
344
|
"required": false,
|
|
334
345
|
"description": "Praxis extension: switchable model ids on /agent/v1 only. The default model must be included. When omitted, only the default model is selectable."
|
|
346
|
+
},
|
|
347
|
+
{
|
|
348
|
+
"name": "preset",
|
|
349
|
+
"type": "string",
|
|
350
|
+
"enum": [
|
|
351
|
+
"minimal",
|
|
352
|
+
"data-editor",
|
|
353
|
+
"full"
|
|
354
|
+
],
|
|
355
|
+
"required": false,
|
|
356
|
+
"description": "Optional tool preset. minimal enables read, glob, grep and ask_user_question; data-editor also enables write and edit; full uses the default toolset with always_allow. Explicit tools override matching preset entries. codemode requires bash and is absent from data-editor."
|
|
335
357
|
}
|
|
336
358
|
]
|
|
337
359
|
}
|
|
@@ -522,6 +544,23 @@ export const operations = [
|
|
|
522
544
|
],
|
|
523
545
|
"query": []
|
|
524
546
|
},
|
|
547
|
+
{
|
|
548
|
+
"resource": "agent.agents.unarchive",
|
|
549
|
+
"method": "create",
|
|
550
|
+
"summary": "Unarchive Agent",
|
|
551
|
+
"description": "Restore an archived agent without creating a configuration version. Already active agents are unchanged. Missing or inaccessible agents return 404. Use the returned agent id to create new sessions.",
|
|
552
|
+
"http": "POST",
|
|
553
|
+
"path": "/agent/v1/agents/{agent_id}/unarchive",
|
|
554
|
+
"streaming": "no",
|
|
555
|
+
"pagination": false,
|
|
556
|
+
"pathParams": [
|
|
557
|
+
{
|
|
558
|
+
"name": "agent_id",
|
|
559
|
+
"sdkName": "agent_id"
|
|
560
|
+
}
|
|
561
|
+
],
|
|
562
|
+
"query": []
|
|
563
|
+
},
|
|
525
564
|
{
|
|
526
565
|
"resource": "agent.agents.versions",
|
|
527
566
|
"method": "list",
|
|
@@ -1833,6 +1872,23 @@ export const operations = [
|
|
|
1833
1872
|
]
|
|
1834
1873
|
}
|
|
1835
1874
|
},
|
|
1875
|
+
{
|
|
1876
|
+
"resource": "agent.sessions",
|
|
1877
|
+
"method": "delete",
|
|
1878
|
+
"summary": "Delete session",
|
|
1879
|
+
"description": "Delete an idle or terminated session and its event history after saving a deletion snapshot. Supply the session id from creation or listing. Running sessions return 409 INVALID_STATE: interrupt first or wait until idle or terminated. Afterwards retrieval and event listing return 404 and lists omit the session. Example: DELETE /agent/v1/sessions/sesn_example.",
|
|
1880
|
+
"http": "DELETE",
|
|
1881
|
+
"path": "/agent/v1/sessions/{session_id}",
|
|
1882
|
+
"streaming": "no",
|
|
1883
|
+
"pagination": false,
|
|
1884
|
+
"pathParams": [
|
|
1885
|
+
{
|
|
1886
|
+
"name": "session_id",
|
|
1887
|
+
"sdkName": "session_id"
|
|
1888
|
+
}
|
|
1889
|
+
],
|
|
1890
|
+
"query": []
|
|
1891
|
+
},
|
|
1836
1892
|
{
|
|
1837
1893
|
"resource": "agent.sessions",
|
|
1838
1894
|
"method": "retrieve",
|
|
@@ -3326,6 +3382,27 @@ export const operations = [
|
|
|
3326
3382
|
],
|
|
3327
3383
|
"query": []
|
|
3328
3384
|
},
|
|
3385
|
+
{
|
|
3386
|
+
"resource": "application.workers.versions.assets",
|
|
3387
|
+
"method": "retrieveManifest",
|
|
3388
|
+
"summary": "Get version asset manifest",
|
|
3389
|
+
"description": "Read the retained asset paths, content hashes and byte sizes of a version for publication planning. This read creates no session or version. A version without assets returns an empty manifest; unavailable artifacts and foreign resources return 404.",
|
|
3390
|
+
"http": "GET",
|
|
3391
|
+
"path": "/application/v1/workers/{worker_id}/versions/{version_id}/assets/manifest",
|
|
3392
|
+
"streaming": "no",
|
|
3393
|
+
"pagination": false,
|
|
3394
|
+
"pathParams": [
|
|
3395
|
+
{
|
|
3396
|
+
"name": "worker_id",
|
|
3397
|
+
"sdkName": "worker_id"
|
|
3398
|
+
},
|
|
3399
|
+
{
|
|
3400
|
+
"name": "version_id",
|
|
3401
|
+
"sdkName": "version_id"
|
|
3402
|
+
}
|
|
3403
|
+
],
|
|
3404
|
+
"query": []
|
|
3405
|
+
},
|
|
3329
3406
|
{
|
|
3330
3407
|
"resource": "automation.actions",
|
|
3331
3408
|
"method": "list",
|