veryfront 0.1.74 → 0.1.76
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/README.md +2 -0
- package/esm/cli/commands/files/command.d.ts +3 -3
- package/esm/cli/commands/knowledge/command.d.ts +2 -0
- package/esm/cli/commands/knowledge/command.d.ts.map +1 -1
- package/esm/cli/commands/knowledge/command.js +64 -1
- package/esm/deno.d.ts +7 -0
- package/esm/deno.js +13 -6
- package/esm/src/data/data-fetcher.d.ts +11 -1
- package/esm/src/data/data-fetcher.d.ts.map +1 -1
- package/esm/src/data/data-fetcher.js +5 -2
- package/esm/src/data/index.d.ts +1 -1
- package/esm/src/data/index.d.ts.map +1 -1
- package/esm/src/data/server-data-fetcher.d.ts +14 -1
- package/esm/src/data/server-data-fetcher.d.ts.map +1 -1
- package/esm/src/data/server-data-fetcher.js +65 -3
- package/esm/src/jobs/index.d.ts +34 -0
- package/esm/src/jobs/index.d.ts.map +1 -0
- package/esm/src/jobs/index.js +33 -0
- package/esm/src/jobs/jobs-client.d.ts +134 -0
- package/esm/src/jobs/jobs-client.d.ts.map +1 -0
- package/esm/src/jobs/jobs-client.js +218 -0
- package/esm/src/jobs/schemas.d.ts +1304 -0
- package/esm/src/jobs/schemas.d.ts.map +1 -0
- package/esm/src/jobs/schemas.js +159 -0
- package/esm/src/platform/adapters/veryfront-api-client/retry-handler.d.ts +4 -0
- package/esm/src/platform/adapters/veryfront-api-client/retry-handler.d.ts.map +1 -1
- package/esm/src/platform/adapters/veryfront-api-client/retry-handler.js +12 -6
- package/esm/src/proxy/handler.d.ts.map +1 -1
- package/esm/src/proxy/handler.js +21 -21
- package/esm/src/rendering/orchestrator/lifecycle.d.ts +4 -0
- package/esm/src/rendering/orchestrator/lifecycle.d.ts.map +1 -1
- package/esm/src/rendering/orchestrator/lifecycle.js +8 -0
- package/esm/src/rendering/orchestrator/pipeline.d.ts.map +1 -1
- package/esm/src/rendering/orchestrator/pipeline.js +6 -1
- package/esm/src/rendering/orchestrator/ssr-orchestrator.d.ts +26 -1
- package/esm/src/rendering/orchestrator/ssr-orchestrator.d.ts.map +1 -1
- package/esm/src/rendering/orchestrator/ssr-orchestrator.js +77 -1
- package/esm/src/routing/api/handler.d.ts.map +1 -1
- package/esm/src/routing/api/handler.js +6 -2
- package/esm/src/routing/api/route-executor.d.ts +8 -2
- package/esm/src/routing/api/route-executor.d.ts.map +1 -1
- package/esm/src/routing/api/route-executor.js +158 -3
- package/esm/src/security/deno-permissions.d.ts +7 -1
- package/esm/src/security/deno-permissions.d.ts.map +1 -1
- package/esm/src/security/deno-permissions.js +12 -1
- package/esm/src/security/sandbox/project-worker.d.ts +61 -0
- package/esm/src/security/sandbox/project-worker.d.ts.map +1 -0
- package/esm/src/security/sandbox/project-worker.js +318 -0
- package/esm/src/security/sandbox/worker-permissions.d.ts +30 -0
- package/esm/src/security/sandbox/worker-permissions.d.ts.map +1 -0
- package/esm/src/security/sandbox/worker-permissions.js +63 -0
- package/esm/src/security/sandbox/worker-pool.d.ts +87 -0
- package/esm/src/security/sandbox/worker-pool.d.ts.map +1 -0
- package/esm/src/security/sandbox/worker-pool.js +359 -0
- package/esm/src/security/sandbox/worker-types.d.ts +167 -0
- package/esm/src/security/sandbox/worker-types.d.ts.map +1 -0
- package/esm/src/security/sandbox/worker-types.js +19 -0
- package/esm/src/server/handlers/request/internal-tasks-list.handler.d.ts +11 -0
- package/esm/src/server/handlers/request/internal-tasks-list.handler.d.ts.map +1 -0
- package/esm/src/server/handlers/request/internal-tasks-list.handler.js +72 -0
- package/esm/src/server/project-env/storage.d.ts +6 -0
- package/esm/src/server/project-env/storage.d.ts.map +1 -1
- package/esm/src/server/project-env/storage.js +8 -0
- package/esm/src/server/runtime-handler/index.d.ts +1 -1
- package/esm/src/server/runtime-handler/index.d.ts.map +1 -1
- package/esm/src/server/runtime-handler/index.js +3 -0
- package/esm/src/server/runtime-handler/project-isolation.d.ts +5 -0
- package/esm/src/server/runtime-handler/project-isolation.d.ts.map +1 -1
- package/esm/src/server/runtime-handler/project-isolation.js +44 -0
- package/esm/src/server/shared/renderer/memory/pressure.d.ts +7 -0
- package/esm/src/server/shared/renderer/memory/pressure.d.ts.map +1 -1
- package/esm/src/server/shared/renderer/memory/pressure.js +7 -0
- package/esm/src/task/control-plane.d.ts +105 -0
- package/esm/src/task/control-plane.d.ts.map +1 -0
- package/esm/src/task/control-plane.js +52 -0
- package/esm/src/task/types.d.ts +6 -0
- package/esm/src/task/types.d.ts.map +1 -1
- package/esm/src/transforms/pipeline/stages/ssr-vf-modules/path-resolver.d.ts +4 -4
- package/esm/src/transforms/pipeline/stages/ssr-vf-modules/path-resolver.d.ts.map +1 -1
- package/esm/src/transforms/pipeline/stages/ssr-vf-modules/path-resolver.js +15 -15
- package/esm/src/utils/index.d.ts +10 -1
- package/esm/src/utils/index.d.ts.map +1 -1
- package/esm/src/utils/index.js +9 -1
- package/esm/src/utils/logger/index.d.ts +1 -1
- package/esm/src/utils/logger/index.d.ts.map +1 -1
- package/esm/src/utils/logger/index.js +1 -1
- package/esm/src/utils/logger/logger.d.ts +14 -0
- package/esm/src/utils/logger/logger.d.ts.map +1 -1
- package/esm/src/utils/logger/logger.js +17 -0
- package/esm/src/workflow/claude-code/tool.d.ts +5 -5
- package/package.json +8 -1
- package/src/cli/commands/knowledge/command.ts +76 -1
- package/src/deno.js +13 -6
- package/src/src/data/data-fetcher.ts +18 -2
- package/src/src/data/index.ts +1 -1
- package/src/src/data/server-data-fetcher.ts +106 -3
- package/src/src/jobs/index.ts +85 -0
- package/src/src/jobs/jobs-client.ts +503 -0
- package/src/src/jobs/schemas.ts +202 -0
- package/src/src/platform/adapters/veryfront-api-client/retry-handler.ts +15 -6
- package/src/src/proxy/handler.ts +27 -19
- package/src/src/rendering/orchestrator/lifecycle.ts +11 -0
- package/src/src/rendering/orchestrator/pipeline.ts +7 -2
- package/src/src/rendering/orchestrator/ssr-orchestrator.ts +119 -0
- package/src/src/routing/api/handler.ts +16 -3
- package/src/src/routing/api/route-executor.ts +258 -1
- package/src/src/security/deno-permissions.ts +13 -1
- package/src/src/security/sandbox/project-worker.ts +416 -0
- package/src/src/security/sandbox/worker-permissions.ts +77 -0
- package/src/src/security/sandbox/worker-pool.ts +459 -0
- package/src/src/security/sandbox/worker-types.ts +212 -0
- package/src/src/server/handlers/request/internal-tasks-list.handler.ts +103 -0
- package/src/src/server/project-env/storage.ts +9 -0
- package/src/src/server/runtime-handler/index.ts +3 -0
- package/src/src/server/runtime-handler/project-isolation.ts +53 -0
- package/src/src/server/shared/renderer/memory/pressure.ts +8 -0
- package/src/src/task/control-plane.ts +76 -0
- package/src/src/task/types.ts +6 -0
- package/src/src/transforms/pipeline/stages/ssr-vf-modules/path-resolver.ts +18 -12
- package/src/src/utils/index.ts +11 -0
- package/src/src/utils/logger/index.ts +1 -0
- package/src/src/utils/logger/logger.ts +34 -0
|
@@ -0,0 +1,134 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Jobs client SDK for project-scoped background execution.
|
|
3
|
+
*
|
|
4
|
+
* Provides a stable public client for one-off jobs, cron jobs, job batches,
|
|
5
|
+
* and job target discovery on the Veryfront Jobs API.
|
|
6
|
+
*/
|
|
7
|
+
import { type RetryConfig } from "../platform/adapters/veryfront-api-client/retry-handler.js";
|
|
8
|
+
import { type CronJob, type CronJobStatus, type Job, type JobBatch, type JobEventsResponse, type JobLogsResponse, type JobStatus, type JobTargetDefinition, type JobTargetDefinitionsResponse, type PaginatedCronJobsResponse, type PaginatedJobsResponse } from "./schemas.js";
|
|
9
|
+
export interface VeryfrontJobsClientConfig {
|
|
10
|
+
apiUrl?: string;
|
|
11
|
+
authToken?: string;
|
|
12
|
+
projectReference?: string;
|
|
13
|
+
retry?: Partial<RetryConfig>;
|
|
14
|
+
}
|
|
15
|
+
export interface ProjectScopedOptions {
|
|
16
|
+
projectReference?: string;
|
|
17
|
+
}
|
|
18
|
+
export interface ListJobsOptions extends ProjectScopedOptions {
|
|
19
|
+
cursor?: string;
|
|
20
|
+
limit?: number;
|
|
21
|
+
status?: JobStatus;
|
|
22
|
+
cronJobId?: string;
|
|
23
|
+
environmentId?: string;
|
|
24
|
+
batchId?: string;
|
|
25
|
+
}
|
|
26
|
+
export interface ListJobEventsOptions extends ProjectScopedOptions {
|
|
27
|
+
cursor?: string;
|
|
28
|
+
limit?: number;
|
|
29
|
+
direction?: "forward" | "backward";
|
|
30
|
+
}
|
|
31
|
+
export interface CreateJobInput extends ProjectScopedOptions {
|
|
32
|
+
name: string;
|
|
33
|
+
target: string;
|
|
34
|
+
environmentId?: string;
|
|
35
|
+
batchId?: string;
|
|
36
|
+
config?: Record<string, unknown>;
|
|
37
|
+
timeoutSeconds?: number;
|
|
38
|
+
backoffLimit?: number;
|
|
39
|
+
}
|
|
40
|
+
export interface ListBatchJobsOptions extends ProjectScopedOptions {
|
|
41
|
+
cursor?: string;
|
|
42
|
+
limit?: number;
|
|
43
|
+
status?: JobStatus;
|
|
44
|
+
}
|
|
45
|
+
export interface CreateCronJobInput extends ProjectScopedOptions {
|
|
46
|
+
name: string;
|
|
47
|
+
target: string;
|
|
48
|
+
environmentId?: string;
|
|
49
|
+
schedule: string;
|
|
50
|
+
timezone?: string;
|
|
51
|
+
config?: Record<string, unknown>;
|
|
52
|
+
timeoutSeconds?: number;
|
|
53
|
+
backoffLimit?: number;
|
|
54
|
+
concurrencyPolicy?: "Allow" | "Forbid" | "Replace";
|
|
55
|
+
}
|
|
56
|
+
export interface ListCronJobsOptions extends ProjectScopedOptions {
|
|
57
|
+
cursor?: string;
|
|
58
|
+
limit?: number;
|
|
59
|
+
status?: CronJobStatus;
|
|
60
|
+
environmentId?: string;
|
|
61
|
+
}
|
|
62
|
+
export interface UpdateCronJobInput extends ProjectScopedOptions {
|
|
63
|
+
name?: string;
|
|
64
|
+
schedule?: string;
|
|
65
|
+
timezone?: string;
|
|
66
|
+
config?: Record<string, unknown>;
|
|
67
|
+
timeoutSeconds?: number;
|
|
68
|
+
backoffLimit?: number;
|
|
69
|
+
concurrencyPolicy?: "Allow" | "Forbid" | "Replace";
|
|
70
|
+
status?: "active" | "paused";
|
|
71
|
+
}
|
|
72
|
+
type NamespaceMethod<TArgs extends unknown[], TResult> = (...args: TArgs) => Promise<TResult>;
|
|
73
|
+
export declare class VeryfrontJobsClient {
|
|
74
|
+
private readonly config;
|
|
75
|
+
private readonly retryConfig;
|
|
76
|
+
private requestToken?;
|
|
77
|
+
private requestProjectReference?;
|
|
78
|
+
readonly cron: {
|
|
79
|
+
create: NamespaceMethod<[CreateCronJobInput], CronJob>;
|
|
80
|
+
list: NamespaceMethod<[ListCronJobsOptions?], PaginatedCronJobsResponse>;
|
|
81
|
+
get: NamespaceMethod<[cronJobId: string, options?: ProjectScopedOptions], CronJob>;
|
|
82
|
+
update: NamespaceMethod<[cronJobId: string, input: UpdateCronJobInput], CronJob>;
|
|
83
|
+
delete: NamespaceMethod<[cronJobId: string, options?: ProjectScopedOptions], CronJob>;
|
|
84
|
+
trigger: NamespaceMethod<[cronJobId: string, options?: ProjectScopedOptions], Job>;
|
|
85
|
+
};
|
|
86
|
+
readonly batches: {
|
|
87
|
+
get: NamespaceMethod<[batchId: string, options?: ProjectScopedOptions], JobBatch>;
|
|
88
|
+
listJobs: NamespaceMethod<[
|
|
89
|
+
batchId: string,
|
|
90
|
+
options?: ListBatchJobsOptions
|
|
91
|
+
], PaginatedJobsResponse>;
|
|
92
|
+
};
|
|
93
|
+
readonly targets: {
|
|
94
|
+
list: NamespaceMethod<[options?: ProjectScopedOptions], JobTargetDefinitionsResponse>;
|
|
95
|
+
get: NamespaceMethod<[target: string, options?: ProjectScopedOptions], JobTargetDefinition>;
|
|
96
|
+
};
|
|
97
|
+
constructor(config?: VeryfrontJobsClientConfig);
|
|
98
|
+
setRequestToken(token: string): void;
|
|
99
|
+
clearRequestToken(): void;
|
|
100
|
+
setProjectReference(projectReference: string): void;
|
|
101
|
+
getProjectReference(): string | undefined;
|
|
102
|
+
clearProjectReference(): void;
|
|
103
|
+
create(input: CreateJobInput): Promise<Job>;
|
|
104
|
+
list(options?: ListJobsOptions): Promise<PaginatedJobsResponse>;
|
|
105
|
+
get(jobId: string, options?: ProjectScopedOptions): Promise<Job>;
|
|
106
|
+
/**
|
|
107
|
+
* Canonical user-visible operational output for a job.
|
|
108
|
+
* Prefer this over raw logs for status, progress, and per-file activity.
|
|
109
|
+
*/
|
|
110
|
+
events(jobId: string, options?: ListJobEventsOptions): Promise<JobEventsResponse>;
|
|
111
|
+
/**
|
|
112
|
+
* Raw debugging output for a job.
|
|
113
|
+
* This is secondary to `events()` for operational UX.
|
|
114
|
+
*/
|
|
115
|
+
logs(jobId: string, options?: ProjectScopedOptions): Promise<JobLogsResponse>;
|
|
116
|
+
cancel(jobId: string, options?: ProjectScopedOptions): Promise<Job>;
|
|
117
|
+
private createCronJob;
|
|
118
|
+
private listCronJobs;
|
|
119
|
+
private getCronJob;
|
|
120
|
+
private updateCronJob;
|
|
121
|
+
private deleteCronJob;
|
|
122
|
+
private triggerCronJob;
|
|
123
|
+
private getBatch;
|
|
124
|
+
private listBatchJobs;
|
|
125
|
+
private listTargets;
|
|
126
|
+
private getTarget;
|
|
127
|
+
private resolveApiUrl;
|
|
128
|
+
private resolveAuthToken;
|
|
129
|
+
private resolveProjectReference;
|
|
130
|
+
private requestProjectJson;
|
|
131
|
+
}
|
|
132
|
+
export declare function createJobsClient(config?: VeryfrontJobsClientConfig): VeryfrontJobsClient;
|
|
133
|
+
export {};
|
|
134
|
+
//# sourceMappingURL=jobs-client.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"jobs-client.d.ts","sourceRoot":"","sources":["../../../src/src/jobs/jobs-client.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAGH,OAAO,EAEL,KAAK,WAAW,EACjB,MAAM,4DAA4D,CAAC;AAGpE,OAAO,EACL,KAAK,OAAO,EAEZ,KAAK,aAAa,EAClB,KAAK,GAAG,EACR,KAAK,QAAQ,EAEb,KAAK,iBAAiB,EAEtB,KAAK,eAAe,EAGpB,KAAK,SAAS,EACd,KAAK,mBAAmB,EAExB,KAAK,4BAA4B,EAEjC,KAAK,yBAAyB,EAE9B,KAAK,qBAAqB,EAE3B,MAAM,cAAc,CAAC;AAMtB,MAAM,WAAW,yBAAyB;IACxC,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,KAAK,CAAC,EAAE,OAAO,CAAC,WAAW,CAAC,CAAC;CAC9B;AAED,MAAM,WAAW,oBAAoB;IACnC,gBAAgB,CAAC,EAAE,MAAM,CAAC;CAC3B;AAED,MAAM,WAAW,eAAgB,SAAQ,oBAAoB;IAC3D,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,MAAM,CAAC,EAAE,SAAS,CAAC;IACnB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED,MAAM,WAAW,oBAAqB,SAAQ,oBAAoB;IAChE,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,SAAS,CAAC,EAAE,SAAS,GAAG,UAAU,CAAC;CACpC;AAED,MAAM,WAAW,cAAe,SAAQ,oBAAoB;IAC1D,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,MAAM,CAAC;IACf,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IACjC,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,YAAY,CAAC,EAAE,MAAM,CAAC;CACvB;AAED,MAAM,WAAW,oBAAqB,SAAQ,oBAAoB;IAChE,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,MAAM,CAAC,EAAE,SAAS,CAAC;CACpB;AAED,MAAM,WAAW,kBAAmB,SAAQ,oBAAoB;IAC9D,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,MAAM,CAAC;IACf,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,QAAQ,EAAE,MAAM,CAAC;IACjB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IACjC,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,iBAAiB,CAAC,EAAE,OAAO,GAAG,QAAQ,GAAG,SAAS,CAAC;CACpD;AAED,MAAM,WAAW,mBAAoB,SAAQ,oBAAoB;IAC/D,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,MAAM,CAAC,EAAE,aAAa,CAAC;IACvB,aAAa,CAAC,EAAE,MAAM,CAAC;CACxB;AAED,MAAM,WAAW,kBAAmB,SAAQ,oBAAoB;IAC9D,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IACjC,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,iBAAiB,CAAC,EAAE,OAAO,GAAG,QAAQ,GAAG,SAAS,CAAC;IACnD,MAAM,CAAC,EAAE,QAAQ,GAAG,QAAQ,CAAC;CAC9B;AAED,KAAK,eAAe,CAAC,KAAK,SAAS,OAAO,EAAE,EAAE,OAAO,IAAI,CAAC,GAAG,IAAI,EAAE,KAAK,KAAK,OAAO,CAAC,OAAO,CAAC,CAAC;AAsB9F,qBAAa,mBAAmB;IA2BlB,OAAO,CAAC,QAAQ,CAAC,MAAM;IA1BnC,OAAO,CAAC,QAAQ,CAAC,WAAW,CAAc;IAC1C,OAAO,CAAC,YAAY,CAAC,CAAS;IAC9B,OAAO,CAAC,uBAAuB,CAAC,CAAS;IAEzC,QAAQ,CAAC,IAAI,EAAE;QACb,MAAM,EAAE,eAAe,CAAC,CAAC,kBAAkB,CAAC,EAAE,OAAO,CAAC,CAAC;QACvD,IAAI,EAAE,eAAe,CAAC,CAAC,mBAAmB,CAAC,CAAC,EAAE,yBAAyB,CAAC,CAAC;QACzE,GAAG,EAAE,eAAe,CAAC,CAAC,SAAS,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,oBAAoB,CAAC,EAAE,OAAO,CAAC,CAAC;QACnF,MAAM,EAAE,eAAe,CAAC,CAAC,SAAS,EAAE,MAAM,EAAE,KAAK,EAAE,kBAAkB,CAAC,EAAE,OAAO,CAAC,CAAC;QACjF,MAAM,EAAE,eAAe,CAAC,CAAC,SAAS,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,oBAAoB,CAAC,EAAE,OAAO,CAAC,CAAC;QACtF,OAAO,EAAE,eAAe,CAAC,CAAC,SAAS,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,oBAAoB,CAAC,EAAE,GAAG,CAAC,CAAC;KACpF,CAAC;IAEF,QAAQ,CAAC,OAAO,EAAE;QAChB,GAAG,EAAE,eAAe,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,oBAAoB,CAAC,EAAE,QAAQ,CAAC,CAAC;QAClF,QAAQ,EAAE,eAAe,CACvB;YAAC,OAAO,EAAE,MAAM;YAAE,OAAO,CAAC,EAAE,oBAAoB;SAAC,EACjD,qBAAqB,CACtB,CAAC;KACH,CAAC;IAEF,QAAQ,CAAC,OAAO,EAAE;QAChB,IAAI,EAAE,eAAe,CAAC,CAAC,OAAO,CAAC,EAAE,oBAAoB,CAAC,EAAE,4BAA4B,CAAC,CAAC;QACtF,GAAG,EAAE,eAAe,CAAC,CAAC,MAAM,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,oBAAoB,CAAC,EAAE,mBAAmB,CAAC,CAAC;KAC7F,CAAC;gBAE2B,MAAM,GAAE,yBAA8B;IA2BnE,eAAe,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI;IAIpC,iBAAiB,IAAI,IAAI;IAIzB,mBAAmB,CAAC,gBAAgB,EAAE,MAAM,GAAG,IAAI;IAInD,mBAAmB,IAAI,MAAM,GAAG,SAAS;IAIzC,qBAAqB,IAAI,IAAI;IAI7B,MAAM,CAAC,KAAK,EAAE,cAAc,GAAG,OAAO,CAAC,GAAG,CAAC;IAqB3C,IAAI,CAAC,OAAO,GAAE,eAAoB,GAAG,OAAO,CAAC,qBAAqB,CAAC;IAoBnE,GAAG,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,GAAE,oBAAyB,GAAG,OAAO,CAAC,GAAG,CAAC;IAQpE;;;OAGG;IACH,MAAM,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,GAAE,oBAAyB,GAAG,OAAO,CAAC,iBAAiB,CAAC;IAarF;;;OAGG;IACH,IAAI,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,GAAE,oBAAyB,GAAG,OAAO,CAAC,eAAe,CAAC;IAQjF,MAAM,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,GAAE,oBAAyB,GAAG,OAAO,CAAC,GAAG,CAAC;IASvE,OAAO,CAAC,aAAa;IA2BrB,OAAO,CAAC,YAAY;IAkBpB,OAAO,CAAC,UAAU;IAQlB,OAAO,CAAC,aAAa;IAyBrB,OAAO,CAAC,aAAa;IASrB,OAAO,CAAC,cAAc;IAStB,OAAO,CAAC,QAAQ;IAQhB,OAAO,CAAC,aAAa;IAoBrB,OAAO,CAAC,WAAW;IAUnB,OAAO,CAAC,SAAS;IAWjB,OAAO,CAAC,aAAa;IAIrB,OAAO,CAAC,gBAAgB;IAcxB,OAAO,CAAC,uBAAuB;YAiBjB,kBAAkB;CAsBjC;AAED,wBAAgB,gBAAgB,CAAC,MAAM,CAAC,EAAE,yBAAyB,GAAG,mBAAmB,CAExF"}
|
|
@@ -0,0 +1,218 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Jobs client SDK for project-scoped background execution.
|
|
3
|
+
*
|
|
4
|
+
* Provides a stable public client for one-off jobs, cron jobs, job batches,
|
|
5
|
+
* and job target discovery on the Veryfront Jobs API.
|
|
6
|
+
*/
|
|
7
|
+
import { getVeryfrontCloudBootstrap } from "../platform/cloud/resolver.js";
|
|
8
|
+
import { requestWithRetry, } from "../platform/adapters/veryfront-api-client/retry-handler.js";
|
|
9
|
+
import { API_CLIENT_ERROR } from "../platform/adapters/veryfront-api-client/types.js";
|
|
10
|
+
import { CronJobSchema, JobBatchSchema, JobEventsResponseSchema, JobLogsResponseSchema, JobSchema, JobTargetDefinitionSchema, JobTargetDefinitionsResponseSchema, PaginatedCronJobsResponseSchema, PaginatedJobsResponseSchema, } from "./schemas.js";
|
|
11
|
+
const DEFAULT_MAX_RETRIES = 3;
|
|
12
|
+
const DEFAULT_INITIAL_RETRY_DELAY_MS = 1_000;
|
|
13
|
+
const DEFAULT_MAX_RETRY_DELAY_MS = 10_000;
|
|
14
|
+
function toQueryParams(values) {
|
|
15
|
+
const params = new URLSearchParams();
|
|
16
|
+
for (const [key, value] of Object.entries(values)) {
|
|
17
|
+
if (value == null) {
|
|
18
|
+
continue;
|
|
19
|
+
}
|
|
20
|
+
params.set(key, String(value));
|
|
21
|
+
}
|
|
22
|
+
return params;
|
|
23
|
+
}
|
|
24
|
+
function withQuery(path, params) {
|
|
25
|
+
const query = params.toString();
|
|
26
|
+
return query.length > 0 ? `${path}?${query}` : path;
|
|
27
|
+
}
|
|
28
|
+
export class VeryfrontJobsClient {
|
|
29
|
+
config;
|
|
30
|
+
retryConfig;
|
|
31
|
+
requestToken;
|
|
32
|
+
requestProjectReference;
|
|
33
|
+
cron;
|
|
34
|
+
batches;
|
|
35
|
+
targets;
|
|
36
|
+
constructor(config = {}) {
|
|
37
|
+
this.config = config;
|
|
38
|
+
this.retryConfig = {
|
|
39
|
+
maxRetries: config.retry?.maxRetries ?? DEFAULT_MAX_RETRIES,
|
|
40
|
+
initialDelay: config.retry?.initialDelay ?? DEFAULT_INITIAL_RETRY_DELAY_MS,
|
|
41
|
+
maxDelay: config.retry?.maxDelay ?? DEFAULT_MAX_RETRY_DELAY_MS,
|
|
42
|
+
};
|
|
43
|
+
this.cron = {
|
|
44
|
+
create: (input) => this.createCronJob(input),
|
|
45
|
+
list: (options) => this.listCronJobs(options),
|
|
46
|
+
get: (cronJobId, options) => this.getCronJob(cronJobId, options),
|
|
47
|
+
update: (cronJobId, input) => this.updateCronJob(cronJobId, input),
|
|
48
|
+
delete: (cronJobId, options) => this.deleteCronJob(cronJobId, options),
|
|
49
|
+
trigger: (cronJobId, options) => this.triggerCronJob(cronJobId, options),
|
|
50
|
+
};
|
|
51
|
+
this.batches = {
|
|
52
|
+
get: (batchId, options) => this.getBatch(batchId, options),
|
|
53
|
+
listJobs: (batchId, options) => this.listBatchJobs(batchId, options),
|
|
54
|
+
};
|
|
55
|
+
this.targets = {
|
|
56
|
+
list: (options) => this.listTargets(options),
|
|
57
|
+
get: (target, options) => this.getTarget(target, options),
|
|
58
|
+
};
|
|
59
|
+
}
|
|
60
|
+
setRequestToken(token) {
|
|
61
|
+
this.requestToken = token;
|
|
62
|
+
}
|
|
63
|
+
clearRequestToken() {
|
|
64
|
+
this.requestToken = undefined;
|
|
65
|
+
}
|
|
66
|
+
setProjectReference(projectReference) {
|
|
67
|
+
this.requestProjectReference = projectReference;
|
|
68
|
+
}
|
|
69
|
+
getProjectReference() {
|
|
70
|
+
return this.requestProjectReference ?? this.config.projectReference;
|
|
71
|
+
}
|
|
72
|
+
clearProjectReference() {
|
|
73
|
+
this.requestProjectReference = undefined;
|
|
74
|
+
}
|
|
75
|
+
create(input) {
|
|
76
|
+
const { projectReference, environmentId, batchId, timeoutSeconds, backoffLimit, ...rest } = input;
|
|
77
|
+
return this.requestProjectJson(projectReference, "/jobs", JobSchema, {
|
|
78
|
+
method: "POST",
|
|
79
|
+
body: {
|
|
80
|
+
...rest,
|
|
81
|
+
environment_id: environmentId,
|
|
82
|
+
batch_id: batchId,
|
|
83
|
+
timeout_seconds: timeoutSeconds,
|
|
84
|
+
backoff_limit: backoffLimit,
|
|
85
|
+
},
|
|
86
|
+
});
|
|
87
|
+
}
|
|
88
|
+
list(options = {}) {
|
|
89
|
+
const { projectReference, cursor, limit, status, cronJobId, environmentId, batchId } = options;
|
|
90
|
+
return this.requestProjectJson(projectReference, withQuery("/jobs", toQueryParams({
|
|
91
|
+
cursor,
|
|
92
|
+
limit,
|
|
93
|
+
status,
|
|
94
|
+
cron_job_id: cronJobId,
|
|
95
|
+
environment_id: environmentId,
|
|
96
|
+
batch_id: batchId,
|
|
97
|
+
})), PaginatedJobsResponseSchema);
|
|
98
|
+
}
|
|
99
|
+
get(jobId, options = {}) {
|
|
100
|
+
return this.requestProjectJson(options.projectReference, `/jobs/${encodeURIComponent(jobId)}`, JobSchema);
|
|
101
|
+
}
|
|
102
|
+
/**
|
|
103
|
+
* Canonical user-visible operational output for a job.
|
|
104
|
+
* Prefer this over raw logs for status, progress, and per-file activity.
|
|
105
|
+
*/
|
|
106
|
+
events(jobId, options = {}) {
|
|
107
|
+
const { projectReference, cursor, limit, direction } = options;
|
|
108
|
+
return this.requestProjectJson(projectReference, withQuery(`/jobs/${encodeURIComponent(jobId)}/events`, toQueryParams({ cursor, limit, direction })), JobEventsResponseSchema);
|
|
109
|
+
}
|
|
110
|
+
/**
|
|
111
|
+
* Raw debugging output for a job.
|
|
112
|
+
* This is secondary to `events()` for operational UX.
|
|
113
|
+
*/
|
|
114
|
+
logs(jobId, options = {}) {
|
|
115
|
+
return this.requestProjectJson(options.projectReference, `/jobs/${encodeURIComponent(jobId)}/logs`, JobLogsResponseSchema);
|
|
116
|
+
}
|
|
117
|
+
cancel(jobId, options = {}) {
|
|
118
|
+
return this.requestProjectJson(options.projectReference, `/jobs/${encodeURIComponent(jobId)}/cancel`, JobSchema, { method: "POST" });
|
|
119
|
+
}
|
|
120
|
+
createCronJob(input) {
|
|
121
|
+
const { projectReference, environmentId, timeoutSeconds, backoffLimit, concurrencyPolicy, ...rest } = input;
|
|
122
|
+
return this.requestProjectJson(projectReference, "/cron-jobs", CronJobSchema, {
|
|
123
|
+
method: "POST",
|
|
124
|
+
body: {
|
|
125
|
+
...rest,
|
|
126
|
+
environment_id: environmentId,
|
|
127
|
+
timeout_seconds: timeoutSeconds,
|
|
128
|
+
backoff_limit: backoffLimit,
|
|
129
|
+
concurrency_policy: concurrencyPolicy,
|
|
130
|
+
},
|
|
131
|
+
});
|
|
132
|
+
}
|
|
133
|
+
listCronJobs(options = {}) {
|
|
134
|
+
const { projectReference, cursor, limit, status, environmentId } = options;
|
|
135
|
+
return this.requestProjectJson(projectReference, withQuery("/cron-jobs", toQueryParams({
|
|
136
|
+
cursor,
|
|
137
|
+
limit,
|
|
138
|
+
status,
|
|
139
|
+
environment_id: environmentId,
|
|
140
|
+
})), PaginatedCronJobsResponseSchema);
|
|
141
|
+
}
|
|
142
|
+
getCronJob(cronJobId, options = {}) {
|
|
143
|
+
return this.requestProjectJson(options.projectReference, `/cron-jobs/${encodeURIComponent(cronJobId)}`, CronJobSchema);
|
|
144
|
+
}
|
|
145
|
+
updateCronJob(cronJobId, input) {
|
|
146
|
+
const { projectReference, timeoutSeconds, backoffLimit, concurrencyPolicy, ...rest } = input;
|
|
147
|
+
return this.requestProjectJson(projectReference, `/cron-jobs/${encodeURIComponent(cronJobId)}`, CronJobSchema, {
|
|
148
|
+
method: "PATCH",
|
|
149
|
+
body: {
|
|
150
|
+
...rest,
|
|
151
|
+
timeout_seconds: timeoutSeconds,
|
|
152
|
+
backoff_limit: backoffLimit,
|
|
153
|
+
concurrency_policy: concurrencyPolicy,
|
|
154
|
+
},
|
|
155
|
+
});
|
|
156
|
+
}
|
|
157
|
+
deleteCronJob(cronJobId, options = {}) {
|
|
158
|
+
return this.requestProjectJson(options.projectReference, `/cron-jobs/${encodeURIComponent(cronJobId)}`, CronJobSchema, { method: "DELETE" });
|
|
159
|
+
}
|
|
160
|
+
triggerCronJob(cronJobId, options = {}) {
|
|
161
|
+
return this.requestProjectJson(options.projectReference, `/cron-jobs/${encodeURIComponent(cronJobId)}/trigger`, JobSchema, { method: "POST" });
|
|
162
|
+
}
|
|
163
|
+
getBatch(batchId, options = {}) {
|
|
164
|
+
return this.requestProjectJson(options.projectReference, `/job-batches/${encodeURIComponent(batchId)}`, JobBatchSchema);
|
|
165
|
+
}
|
|
166
|
+
listBatchJobs(batchId, options = {}) {
|
|
167
|
+
const { projectReference, cursor, limit, status } = options;
|
|
168
|
+
return this.requestProjectJson(projectReference, withQuery(`/job-batches/${encodeURIComponent(batchId)}/jobs`, toQueryParams({
|
|
169
|
+
cursor,
|
|
170
|
+
limit,
|
|
171
|
+
status,
|
|
172
|
+
})), PaginatedJobsResponseSchema);
|
|
173
|
+
}
|
|
174
|
+
listTargets(options = {}) {
|
|
175
|
+
return this.requestProjectJson(options.projectReference, "/job-targets", JobTargetDefinitionsResponseSchema);
|
|
176
|
+
}
|
|
177
|
+
getTarget(target, options = {}) {
|
|
178
|
+
return this.requestProjectJson(options.projectReference, `/job-targets/${encodeURIComponent(target)}`, JobTargetDefinitionSchema);
|
|
179
|
+
}
|
|
180
|
+
resolveApiUrl() {
|
|
181
|
+
return this.config.apiUrl ?? getVeryfrontCloudBootstrap().apiBaseUrl;
|
|
182
|
+
}
|
|
183
|
+
resolveAuthToken() {
|
|
184
|
+
const token = this.requestToken ?? this.config.authToken ??
|
|
185
|
+
getVeryfrontCloudBootstrap().apiToken;
|
|
186
|
+
if (token) {
|
|
187
|
+
return token;
|
|
188
|
+
}
|
|
189
|
+
throw API_CLIENT_ERROR.create({
|
|
190
|
+
detail: "Jobs auth not configured. Set VERYFRONT_API_TOKEN, provide request-scoped Veryfront credentials, or pass authToken explicitly.",
|
|
191
|
+
status: 401,
|
|
192
|
+
});
|
|
193
|
+
}
|
|
194
|
+
resolveProjectReference(projectReference) {
|
|
195
|
+
const resolved = projectReference ??
|
|
196
|
+
this.requestProjectReference ??
|
|
197
|
+
this.config.projectReference ??
|
|
198
|
+
getVeryfrontCloudBootstrap().projectSlug;
|
|
199
|
+
if (resolved) {
|
|
200
|
+
return resolved;
|
|
201
|
+
}
|
|
202
|
+
throw API_CLIENT_ERROR.create({
|
|
203
|
+
detail: "Jobs project reference not configured. Pass projectReference explicitly, set VERYFRONT_PROJECT_SLUG, or provide request-scoped Veryfront project context.",
|
|
204
|
+
status: 400,
|
|
205
|
+
});
|
|
206
|
+
}
|
|
207
|
+
async requestProjectJson(projectReference, path, schema, options = {}) {
|
|
208
|
+
const resolvedProjectReference = this.resolveProjectReference(projectReference);
|
|
209
|
+
const raw = await requestWithRetry(`${this.resolveApiUrl()}/projects/${encodeURIComponent(resolvedProjectReference)}${path}`, this.resolveAuthToken(), this.retryConfig, {
|
|
210
|
+
method: options.method,
|
|
211
|
+
body: options.body == null ? undefined : JSON.stringify(options.body),
|
|
212
|
+
});
|
|
213
|
+
return schema.parse(raw);
|
|
214
|
+
}
|
|
215
|
+
}
|
|
216
|
+
export function createJobsClient(config) {
|
|
217
|
+
return new VeryfrontJobsClient(config);
|
|
218
|
+
}
|