@deepraxis/sdk 0.1.0-dev.fa57968 → 0.1.0-dev.fe2a6ba
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 +86 -1
- package/dist/generated/index.d.ts +2 -2
- package/dist/generated/index.js +1 -1
- package/dist/generated/sdk.gen.d.ts +164 -20
- package/dist/generated/sdk.gen.js +421 -47
- package/dist/generated/types.gen.d.ts +5269 -1725
- package/dist/helpers/application-publish.d.ts +24 -4
- package/dist/helpers/application-publish.js +53 -3
- package/dist/operations.generated.d.ts +437 -9
- package/dist/operations.generated.js +545 -10
- package/dist/resources.generated.d.ts +752 -33
- package/dist/resources.generated.js +46 -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
|
}
|