@pulze-io/renderflow 1.2.1
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 +21 -0
- package/README.md +69 -0
- package/dist/index.d.mts +921 -0
- package/dist/index.d.ts +921 -0
- package/dist/index.js +812 -0
- package/dist/index.mjs +776 -0
- package/package.json +37 -0
package/dist/index.d.ts
ADDED
|
@@ -0,0 +1,921 @@
|
|
|
1
|
+
declare enum EngineId {
|
|
2
|
+
Arnold = "arnold",
|
|
3
|
+
Corona = "corona",
|
|
4
|
+
Fstorm = "fstorm",
|
|
5
|
+
Redshift = "redshift",
|
|
6
|
+
Vray = "vray"
|
|
7
|
+
}
|
|
8
|
+
declare enum AssetState {
|
|
9
|
+
Value0 = 0,
|
|
10
|
+
Value1 = 1,
|
|
11
|
+
Value2 = 2,
|
|
12
|
+
Value3 = 3,
|
|
13
|
+
Value4 = 4,
|
|
14
|
+
Value5 = 5
|
|
15
|
+
}
|
|
16
|
+
declare enum NotificationType {
|
|
17
|
+
JobCompleted = "job-completed",
|
|
18
|
+
JobError = "job-error"
|
|
19
|
+
}
|
|
20
|
+
declare enum NotificationChannel {
|
|
21
|
+
Mobile = "mobile",
|
|
22
|
+
Desktop = "desktop",
|
|
23
|
+
Email = "email",
|
|
24
|
+
Webhook = "webhook",
|
|
25
|
+
Slack = "slack",
|
|
26
|
+
Teams = "teams",
|
|
27
|
+
Discord = "discord"
|
|
28
|
+
}
|
|
29
|
+
declare enum CleanupType {
|
|
30
|
+
None = "none",
|
|
31
|
+
Delete = "delete",
|
|
32
|
+
Archive = "archive"
|
|
33
|
+
}
|
|
34
|
+
declare enum JobPriority {
|
|
35
|
+
Value0 = 0,
|
|
36
|
+
Value25 = 25,
|
|
37
|
+
Value50 = 50,
|
|
38
|
+
Value75 = 75,
|
|
39
|
+
Value100 = 100
|
|
40
|
+
}
|
|
41
|
+
declare enum ForceFinish {
|
|
42
|
+
Value0 = 0,
|
|
43
|
+
Value1 = 1,
|
|
44
|
+
Value2 = 2
|
|
45
|
+
}
|
|
46
|
+
declare enum JobNodeStatus {
|
|
47
|
+
Blocked = "blocked",
|
|
48
|
+
Required = "required",
|
|
49
|
+
Waiting = "waiting",
|
|
50
|
+
Active = "active",
|
|
51
|
+
Failed = "failed",
|
|
52
|
+
Completed = "completed"
|
|
53
|
+
}
|
|
54
|
+
declare enum JobStepIOType {
|
|
55
|
+
ImageSingle = "image.single",
|
|
56
|
+
ImageSequence = "image.sequence"
|
|
57
|
+
}
|
|
58
|
+
declare enum ValidationLevel {
|
|
59
|
+
Value0 = 0,
|
|
60
|
+
Value1 = 1,
|
|
61
|
+
Value2 = 2,
|
|
62
|
+
Value3 = 3
|
|
63
|
+
}
|
|
64
|
+
declare enum AssetType {
|
|
65
|
+
Value0 = 0,
|
|
66
|
+
Value1 = 1,
|
|
67
|
+
Value2 = 2,
|
|
68
|
+
Value99 = 99
|
|
69
|
+
}
|
|
70
|
+
declare enum HardwareType {
|
|
71
|
+
Cpu = "cpu",
|
|
72
|
+
Gpu = "gpu",
|
|
73
|
+
Ram = "ram",
|
|
74
|
+
Storage = "storage"
|
|
75
|
+
}
|
|
76
|
+
declare enum ReqCategory {
|
|
77
|
+
Value0 = 0,
|
|
78
|
+
Value1 = 1,
|
|
79
|
+
Value2 = 2,
|
|
80
|
+
Value3 = 3
|
|
81
|
+
}
|
|
82
|
+
declare enum ErrorNotificationType {
|
|
83
|
+
None = "none",
|
|
84
|
+
Owner = "owner",
|
|
85
|
+
Admin = "admin",
|
|
86
|
+
Group = "group",
|
|
87
|
+
Pool = "pool",
|
|
88
|
+
All = "all"
|
|
89
|
+
}
|
|
90
|
+
declare enum ErrorLevel {
|
|
91
|
+
Info = "info",
|
|
92
|
+
Warning = "warning",
|
|
93
|
+
Critical = "critical",
|
|
94
|
+
Fatal = "fatal"
|
|
95
|
+
}
|
|
96
|
+
declare enum BenchmarkType {
|
|
97
|
+
Blender = "blender",
|
|
98
|
+
Cpuz = "cpuz",
|
|
99
|
+
Cinebench = "cinebench",
|
|
100
|
+
Corona = "corona",
|
|
101
|
+
Fstorm = "fstorm",
|
|
102
|
+
CustomMax = "custom-max",
|
|
103
|
+
Octane = "octane",
|
|
104
|
+
Phoenix = "phoenix",
|
|
105
|
+
Redshift = "redshift",
|
|
106
|
+
Vray = "vray",
|
|
107
|
+
VrayGpuCuda = "vray-gpu-cuda",
|
|
108
|
+
VrayGpuRtx = "vray-gpu-rtx",
|
|
109
|
+
YCruncher = "y-cruncher"
|
|
110
|
+
}
|
|
111
|
+
declare enum SoftwareType {
|
|
112
|
+
Host = "host",
|
|
113
|
+
Engine = "engine",
|
|
114
|
+
Plugin = "plugin",
|
|
115
|
+
System = "system",
|
|
116
|
+
Utils = "utils"
|
|
117
|
+
}
|
|
118
|
+
declare enum SpawnerType {
|
|
119
|
+
Corona = "corona",
|
|
120
|
+
Vray = "vray"
|
|
121
|
+
}
|
|
122
|
+
declare enum SoftwareId {
|
|
123
|
+
Value3Dsmax = "3dsmax",
|
|
124
|
+
After = "after",
|
|
125
|
+
Arnold = "arnold",
|
|
126
|
+
Blender = "blender",
|
|
127
|
+
ChaosCloud = "chaos_cloud",
|
|
128
|
+
Cinema4D = "cinema4d",
|
|
129
|
+
CoronaImageEditor = "corona_image_editor",
|
|
130
|
+
Fusion = "fusion",
|
|
131
|
+
FusionRenderNode = "fusion_render_node",
|
|
132
|
+
Houdini = "houdini",
|
|
133
|
+
Keyshot = "keyshot",
|
|
134
|
+
Maya = "maya",
|
|
135
|
+
Nuke = "nuke",
|
|
136
|
+
Powershell = "powershell",
|
|
137
|
+
Photoshop = "photoshop",
|
|
138
|
+
Python = "python",
|
|
139
|
+
Revit = "revit",
|
|
140
|
+
Rhino = "rhino",
|
|
141
|
+
TopazVideo = "topaz_video",
|
|
142
|
+
Sketchup = "sketchup",
|
|
143
|
+
Vray = "vray",
|
|
144
|
+
VrayStandalone = "vray_standalone",
|
|
145
|
+
VrayStandaloneSpawner = "vray_standalone_spawner",
|
|
146
|
+
Vantage = "vantage",
|
|
147
|
+
Ffmpeg = "ffmpeg",
|
|
148
|
+
Unreal = "unreal",
|
|
149
|
+
Renderflow = "renderflow",
|
|
150
|
+
SceneManager = "scene_manager",
|
|
151
|
+
Renderflow1 = "renderflow"
|
|
152
|
+
}
|
|
153
|
+
declare enum NodeStatus {
|
|
154
|
+
Offline = "offline",
|
|
155
|
+
Loading = "loading",
|
|
156
|
+
Reserved = "reserved",
|
|
157
|
+
Suspended = "suspended",
|
|
158
|
+
Idle = "idle",
|
|
159
|
+
Busy = "busy",
|
|
160
|
+
Finishing = "finishing",
|
|
161
|
+
Error = "error"
|
|
162
|
+
}
|
|
163
|
+
declare enum NodeType {
|
|
164
|
+
Monitor = "monitor",
|
|
165
|
+
Node = "node",
|
|
166
|
+
Workstation = "workstation",
|
|
167
|
+
Server = "server",
|
|
168
|
+
Test = "test"
|
|
169
|
+
}
|
|
170
|
+
declare enum DistributionOrder {
|
|
171
|
+
PoolPriorityDate = "pool_priority_date",
|
|
172
|
+
PoolPriorityBalanced = "pool_priority_balanced"
|
|
173
|
+
}
|
|
174
|
+
declare enum Status {
|
|
175
|
+
Working = "working",
|
|
176
|
+
Finishing = "finishing",
|
|
177
|
+
Pending = "pending",
|
|
178
|
+
Preparing = "preparing",
|
|
179
|
+
Failed = "failed",
|
|
180
|
+
Archived = "archived",
|
|
181
|
+
Suspended = "suspended",
|
|
182
|
+
Scheduled = "scheduled",
|
|
183
|
+
Queued = "queued",
|
|
184
|
+
Completed = "completed",
|
|
185
|
+
Disabled = "disabled",
|
|
186
|
+
Unknown = "unknown"
|
|
187
|
+
}
|
|
188
|
+
declare enum JobPropCategory {
|
|
189
|
+
Value0 = 0,
|
|
190
|
+
Value1 = 1
|
|
191
|
+
}
|
|
192
|
+
declare enum JobCallbackType {
|
|
193
|
+
PreSetup = "pre-setup",
|
|
194
|
+
PostSetup = "post-setup",
|
|
195
|
+
PreRender = "pre-render",
|
|
196
|
+
PreFrame = "pre-frame",
|
|
197
|
+
PostFrame = "post-frame",
|
|
198
|
+
PostRender = "post-render"
|
|
199
|
+
}
|
|
200
|
+
declare enum JobPropType {
|
|
201
|
+
FileInput = "file.input",
|
|
202
|
+
FileBrowser = "file.browser",
|
|
203
|
+
MultiFileInput = "multi.file.input",
|
|
204
|
+
Resolution = "resolution",
|
|
205
|
+
Camera = "camera",
|
|
206
|
+
Frame = "frame",
|
|
207
|
+
Tiled = "tiled",
|
|
208
|
+
ImageOutput = "image.output",
|
|
209
|
+
RenderSettings = "render.settings",
|
|
210
|
+
Config = "config",
|
|
211
|
+
Name = "name",
|
|
212
|
+
Distributed = "distributed",
|
|
213
|
+
Phoenix = "phoenix",
|
|
214
|
+
Tyflow = "tyflow",
|
|
215
|
+
Imager = "imager",
|
|
216
|
+
CoronaImageEditor = "corona.image-editor",
|
|
217
|
+
ScriptFile = "script.file",
|
|
218
|
+
ScriptSnippet = "script.snippet",
|
|
219
|
+
Preview = "preview",
|
|
220
|
+
Export = "export",
|
|
221
|
+
FfmpegCommand = "ffmpeg.command",
|
|
222
|
+
FfmpegConvertSequence = "ffmpeg.convert-sequence",
|
|
223
|
+
TopazVideo = "topaz.video",
|
|
224
|
+
SceneManager = "scene-manager",
|
|
225
|
+
Args = "args"
|
|
226
|
+
}
|
|
227
|
+
declare enum JobEnv {
|
|
228
|
+
Local = "local",
|
|
229
|
+
Cloud = "cloud"
|
|
230
|
+
}
|
|
231
|
+
declare enum TaskType {
|
|
232
|
+
RenderflowTest = "renderflow.test",
|
|
233
|
+
Value3DsmaxRender = "3dsmax.render",
|
|
234
|
+
Value3DsmaxSceneManagerRender = "3dsmax.scene_manager.render",
|
|
235
|
+
Value3DsmaxExport = "3dsmax.export",
|
|
236
|
+
Value3DsmaxPhoenixSimulate = "3dsmax.phoenix.simulate",
|
|
237
|
+
Value3DsmaxTyflowSimulate = "3dsmax.tyflow.simulate",
|
|
238
|
+
Value3DsmaxPreview = "3dsmax.preview",
|
|
239
|
+
Value3DsmaxScript = "3dsmax.script",
|
|
240
|
+
Value3DsmaxBake = "3dsmax.bake",
|
|
241
|
+
ArnoldRender = "arnold.render",
|
|
242
|
+
AfterRender = "after.render",
|
|
243
|
+
BlenderRender = "blender.render",
|
|
244
|
+
Cinema4DRender = "cinema4d.render",
|
|
245
|
+
CoronaImageEditor = "corona_image_editor",
|
|
246
|
+
CoronaDr = "corona.dr",
|
|
247
|
+
HoudiniRender = "houdini.render",
|
|
248
|
+
KeyshotRender = "keyshot.render",
|
|
249
|
+
Ffmpeg = "ffmpeg",
|
|
250
|
+
Imager = "imager",
|
|
251
|
+
FusionRender = "fusion.render",
|
|
252
|
+
MayaRender = "maya.render",
|
|
253
|
+
NukeRender = "nuke.render",
|
|
254
|
+
Photoshop = "photoshop",
|
|
255
|
+
Powershell = "powershell",
|
|
256
|
+
Python = "python",
|
|
257
|
+
RevitExport = "revit.export",
|
|
258
|
+
RhinoExport = "rhino.export",
|
|
259
|
+
SketchupExport = "sketchup.export",
|
|
260
|
+
TopazVideo = "topaz_video",
|
|
261
|
+
Unreal = "unreal",
|
|
262
|
+
VantageRender = "vantage.render",
|
|
263
|
+
VrayDr = "vray.dr",
|
|
264
|
+
VrayDrSpawner = "vray.dr.spawner",
|
|
265
|
+
VrayStandalone = "vray_standalone"
|
|
266
|
+
}
|
|
267
|
+
/** A class representation of the BSON ObjectId type. */
|
|
268
|
+
type ObjectId = string;
|
|
269
|
+
interface IDevice {
|
|
270
|
+
id: string;
|
|
271
|
+
device_id: string;
|
|
272
|
+
name: string;
|
|
273
|
+
manufacturer: string;
|
|
274
|
+
model: string;
|
|
275
|
+
platform: string;
|
|
276
|
+
fcm_token: string | null;
|
|
277
|
+
}
|
|
278
|
+
interface IUser {
|
|
279
|
+
id: string;
|
|
280
|
+
/** A class representation of the BSON ObjectId type. */
|
|
281
|
+
_id: ObjectId;
|
|
282
|
+
principal: string;
|
|
283
|
+
name: string;
|
|
284
|
+
alias: string | null;
|
|
285
|
+
first_name: string | null;
|
|
286
|
+
last_name: string | null;
|
|
287
|
+
role: string | null;
|
|
288
|
+
email: string | null;
|
|
289
|
+
password: string | null;
|
|
290
|
+
avatar: string | null;
|
|
291
|
+
group_id: ObjectId | null;
|
|
292
|
+
/** @format double */
|
|
293
|
+
created_at: number;
|
|
294
|
+
/** @format double */
|
|
295
|
+
updated_at: number;
|
|
296
|
+
devices: IDevice[];
|
|
297
|
+
/** @format double */
|
|
298
|
+
_schemaVersion: number;
|
|
299
|
+
}
|
|
300
|
+
interface IJobProp {
|
|
301
|
+
id?: string;
|
|
302
|
+
type: JobPropType;
|
|
303
|
+
name: string;
|
|
304
|
+
value: any;
|
|
305
|
+
props: any;
|
|
306
|
+
callback?: JobCallbackType;
|
|
307
|
+
category?: JobPropCategory;
|
|
308
|
+
/** @format double */
|
|
309
|
+
v?: number;
|
|
310
|
+
}
|
|
311
|
+
interface IProgress {
|
|
312
|
+
/** @format double */
|
|
313
|
+
elapsed_time: number;
|
|
314
|
+
/** @format double */
|
|
315
|
+
remaining_time: number;
|
|
316
|
+
/** @format double */
|
|
317
|
+
total_render_time?: number;
|
|
318
|
+
/** @format double */
|
|
319
|
+
average_time?: number;
|
|
320
|
+
/** @format double */
|
|
321
|
+
percent: number;
|
|
322
|
+
info: string;
|
|
323
|
+
}
|
|
324
|
+
interface IJobTaskThumbnail {
|
|
325
|
+
path: string;
|
|
326
|
+
/** @format double */
|
|
327
|
+
updated_at: number;
|
|
328
|
+
}
|
|
329
|
+
interface IResult {
|
|
330
|
+
type: string;
|
|
331
|
+
}
|
|
332
|
+
interface IJobTask {
|
|
333
|
+
id: string;
|
|
334
|
+
/** A class representation of the BSON ObjectId type. */
|
|
335
|
+
_id: ObjectId;
|
|
336
|
+
/** @format double */
|
|
337
|
+
index: number;
|
|
338
|
+
account_id: ObjectId | null;
|
|
339
|
+
node_id: ObjectId | null;
|
|
340
|
+
/** A class representation of the BSON ObjectId type. */
|
|
341
|
+
job_id: ObjectId;
|
|
342
|
+
/** A class representation of the BSON ObjectId type. */
|
|
343
|
+
step_id: ObjectId;
|
|
344
|
+
type: TaskType;
|
|
345
|
+
env?: JobEnv;
|
|
346
|
+
props: IJobProp[];
|
|
347
|
+
status: Status;
|
|
348
|
+
progress: IProgress;
|
|
349
|
+
thumbnail?: IJobTaskThumbnail;
|
|
350
|
+
result: IResult | null;
|
|
351
|
+
/** @format double */
|
|
352
|
+
started_at: number | null;
|
|
353
|
+
/** @format double */
|
|
354
|
+
finished_at: number | null;
|
|
355
|
+
helper: boolean;
|
|
356
|
+
/** @format double */
|
|
357
|
+
_schemaVersion: number;
|
|
358
|
+
}
|
|
359
|
+
interface IPool {
|
|
360
|
+
/** A class representation of the BSON ObjectId type. */
|
|
361
|
+
_id: ObjectId;
|
|
362
|
+
name: string;
|
|
363
|
+
color: string;
|
|
364
|
+
icon: string;
|
|
365
|
+
description: string;
|
|
366
|
+
/** @format double */
|
|
367
|
+
priority: number;
|
|
368
|
+
/** @format double */
|
|
369
|
+
node_limit: number;
|
|
370
|
+
order: DistributionOrder;
|
|
371
|
+
readonly: boolean;
|
|
372
|
+
/** @format double */
|
|
373
|
+
created_at: number;
|
|
374
|
+
}
|
|
375
|
+
interface INodeJob {
|
|
376
|
+
/** A class representation of the BSON ObjectId type. */
|
|
377
|
+
_id: ObjectId;
|
|
378
|
+
/** A class representation of the BSON ObjectId type. */
|
|
379
|
+
step_id: ObjectId;
|
|
380
|
+
tasks: ObjectId[];
|
|
381
|
+
}
|
|
382
|
+
interface INodeSpawner {
|
|
383
|
+
job_id: ObjectId | null;
|
|
384
|
+
soft_id: SoftwareId;
|
|
385
|
+
version: string;
|
|
386
|
+
type: SpawnerType;
|
|
387
|
+
status: Status;
|
|
388
|
+
}
|
|
389
|
+
interface IOperatingSystem {
|
|
390
|
+
platform: string;
|
|
391
|
+
distro: string;
|
|
392
|
+
release: string;
|
|
393
|
+
build: string;
|
|
394
|
+
}
|
|
395
|
+
interface ICpu {
|
|
396
|
+
manufacturer: string;
|
|
397
|
+
brand: string;
|
|
398
|
+
/** @format double */
|
|
399
|
+
speed: number;
|
|
400
|
+
/** @format double */
|
|
401
|
+
cores: number;
|
|
402
|
+
/** @format double */
|
|
403
|
+
physical: number;
|
|
404
|
+
/** @format double */
|
|
405
|
+
processors: number;
|
|
406
|
+
/** @format double */
|
|
407
|
+
utilization: number | null;
|
|
408
|
+
/** @format double */
|
|
409
|
+
temperature: number | null;
|
|
410
|
+
}
|
|
411
|
+
interface IGpu {
|
|
412
|
+
/** @format double */
|
|
413
|
+
id: number;
|
|
414
|
+
vendor: string;
|
|
415
|
+
model: string;
|
|
416
|
+
/** @format double */
|
|
417
|
+
vram: number | null;
|
|
418
|
+
/** @format double */
|
|
419
|
+
utilization: number | null;
|
|
420
|
+
/** @format double */
|
|
421
|
+
temperature: number | null;
|
|
422
|
+
}
|
|
423
|
+
interface IRamModule {
|
|
424
|
+
/** @format double */
|
|
425
|
+
index: number;
|
|
426
|
+
manufacturer?: string;
|
|
427
|
+
type: string;
|
|
428
|
+
/** @format double */
|
|
429
|
+
speed: number | null;
|
|
430
|
+
}
|
|
431
|
+
interface IRam {
|
|
432
|
+
/** @format double */
|
|
433
|
+
total: number;
|
|
434
|
+
/** @format double */
|
|
435
|
+
free: number;
|
|
436
|
+
/** @format double */
|
|
437
|
+
used: number | null;
|
|
438
|
+
layout: IRamModule[];
|
|
439
|
+
}
|
|
440
|
+
interface ISystem {
|
|
441
|
+
manufacturer: string;
|
|
442
|
+
model: string;
|
|
443
|
+
virtual: boolean;
|
|
444
|
+
}
|
|
445
|
+
interface IDrive {
|
|
446
|
+
/** @format double */
|
|
447
|
+
id: number;
|
|
448
|
+
name: string | null;
|
|
449
|
+
local: string;
|
|
450
|
+
remote: string | null;
|
|
451
|
+
}
|
|
452
|
+
interface ISystemDrive {
|
|
453
|
+
mount: string;
|
|
454
|
+
/** @format double */
|
|
455
|
+
total: number;
|
|
456
|
+
/** @format double */
|
|
457
|
+
free: number;
|
|
458
|
+
/** @format double */
|
|
459
|
+
used: number | null;
|
|
460
|
+
}
|
|
461
|
+
interface INetwork {
|
|
462
|
+
ip: string;
|
|
463
|
+
mac: string;
|
|
464
|
+
default: boolean;
|
|
465
|
+
/** @format double */
|
|
466
|
+
speed: number | null;
|
|
467
|
+
type: string;
|
|
468
|
+
name: string;
|
|
469
|
+
internal: boolean;
|
|
470
|
+
virtual: boolean;
|
|
471
|
+
}
|
|
472
|
+
interface IHardware {
|
|
473
|
+
/** A class representation of the BSON ObjectId type. */
|
|
474
|
+
_id?: ObjectId;
|
|
475
|
+
/** A class representation of the BSON ObjectId type. */
|
|
476
|
+
node_id?: ObjectId;
|
|
477
|
+
os: IOperatingSystem | null;
|
|
478
|
+
cpu: ICpu | null;
|
|
479
|
+
gpu: IGpu[];
|
|
480
|
+
ram: IRam | null;
|
|
481
|
+
system: ISystem | null;
|
|
482
|
+
drives: IDrive[];
|
|
483
|
+
system_drive: ISystemDrive | null;
|
|
484
|
+
network: INetwork[];
|
|
485
|
+
/** @format double */
|
|
486
|
+
uptime: number | null;
|
|
487
|
+
/** @format double */
|
|
488
|
+
work_threads: number;
|
|
489
|
+
}
|
|
490
|
+
interface IPaths {
|
|
491
|
+
name: string;
|
|
492
|
+
value: string | string[] | null;
|
|
493
|
+
}
|
|
494
|
+
interface ISoftware {
|
|
495
|
+
/** A class representation of the BSON ObjectId type. */
|
|
496
|
+
_id?: ObjectId;
|
|
497
|
+
/** A class representation of the BSON ObjectId type. */
|
|
498
|
+
node_id?: ObjectId;
|
|
499
|
+
soft_id: SoftwareId | string;
|
|
500
|
+
name: string;
|
|
501
|
+
version: string;
|
|
502
|
+
display_version: string;
|
|
503
|
+
type: SoftwareType;
|
|
504
|
+
paths?: IPaths[];
|
|
505
|
+
plugins?: ISoftware[];
|
|
506
|
+
}
|
|
507
|
+
interface IBenchmarkResult {
|
|
508
|
+
/** A class representation of the BSON ObjectId type. */
|
|
509
|
+
node_id: ObjectId;
|
|
510
|
+
type: BenchmarkType;
|
|
511
|
+
version: string | null;
|
|
512
|
+
/** @format double */
|
|
513
|
+
date: number;
|
|
514
|
+
value: any;
|
|
515
|
+
guess?: boolean;
|
|
516
|
+
}
|
|
517
|
+
interface IError {
|
|
518
|
+
id: string;
|
|
519
|
+
/** A class representation of the BSON ObjectId type. */
|
|
520
|
+
_id: ObjectId;
|
|
521
|
+
tag: string;
|
|
522
|
+
level: ErrorLevel;
|
|
523
|
+
title: string;
|
|
524
|
+
notify: ErrorNotificationType;
|
|
525
|
+
detail?: string;
|
|
526
|
+
help?: any;
|
|
527
|
+
/** A class representation of the BSON ObjectId type. */
|
|
528
|
+
node_id: ObjectId;
|
|
529
|
+
/** A class representation of the BSON ObjectId type. */
|
|
530
|
+
account_id?: ObjectId;
|
|
531
|
+
/** A class representation of the BSON ObjectId type. */
|
|
532
|
+
job_id?: ObjectId;
|
|
533
|
+
/** A class representation of the BSON ObjectId type. */
|
|
534
|
+
step_id?: ObjectId;
|
|
535
|
+
/** A class representation of the BSON ObjectId type. */
|
|
536
|
+
task_id?: ObjectId;
|
|
537
|
+
/** @format double */
|
|
538
|
+
count: number;
|
|
539
|
+
/** @format double */
|
|
540
|
+
created_at: number;
|
|
541
|
+
/** @format double */
|
|
542
|
+
updated_at: number;
|
|
543
|
+
}
|
|
544
|
+
interface INodeUser {
|
|
545
|
+
id: string;
|
|
546
|
+
name: string;
|
|
547
|
+
alias: string | null;
|
|
548
|
+
}
|
|
549
|
+
interface INode {
|
|
550
|
+
id: string;
|
|
551
|
+
/** A class representation of the BSON ObjectId type. */
|
|
552
|
+
_id: ObjectId;
|
|
553
|
+
system_id: string;
|
|
554
|
+
name: string;
|
|
555
|
+
alias: string | null;
|
|
556
|
+
color: string;
|
|
557
|
+
pool_id: ObjectId | null;
|
|
558
|
+
group_id: ObjectId | null;
|
|
559
|
+
tags: string[];
|
|
560
|
+
type: NodeType;
|
|
561
|
+
user_id: ObjectId | null;
|
|
562
|
+
license: ObjectId | null;
|
|
563
|
+
status: NodeStatus;
|
|
564
|
+
info: string;
|
|
565
|
+
/** @format double */
|
|
566
|
+
alive: number;
|
|
567
|
+
/** @format double */
|
|
568
|
+
last_seen: number | null;
|
|
569
|
+
version: string | null;
|
|
570
|
+
job: INodeJob | null;
|
|
571
|
+
spawner: INodeSpawner | null;
|
|
572
|
+
/** @format double */
|
|
573
|
+
idle_since?: number | null;
|
|
574
|
+
hardware?: IHardware;
|
|
575
|
+
software?: ISoftware[];
|
|
576
|
+
benchmarks?: IBenchmarkResult[];
|
|
577
|
+
errors?: IError[];
|
|
578
|
+
user?: INodeUser;
|
|
579
|
+
}
|
|
580
|
+
interface IReq {
|
|
581
|
+
id: string;
|
|
582
|
+
enabled: boolean;
|
|
583
|
+
category: ReqCategory;
|
|
584
|
+
category_type: SoftwareType | HardwareType | AssetType;
|
|
585
|
+
value: any;
|
|
586
|
+
validation_level?: ValidationLevel;
|
|
587
|
+
}
|
|
588
|
+
interface IJobStepIOProps {
|
|
589
|
+
/** @format double */
|
|
590
|
+
width?: number;
|
|
591
|
+
/** @format double */
|
|
592
|
+
height?: number;
|
|
593
|
+
/** @format double */
|
|
594
|
+
fps?: number;
|
|
595
|
+
/** @format double */
|
|
596
|
+
start_frame?: number;
|
|
597
|
+
/** @format double */
|
|
598
|
+
end_frame?: number;
|
|
599
|
+
/** @format double */
|
|
600
|
+
frame_step?: number;
|
|
601
|
+
/** @format double */
|
|
602
|
+
digits?: number;
|
|
603
|
+
pattern?: string;
|
|
604
|
+
original: string;
|
|
605
|
+
display: string;
|
|
606
|
+
basename: string;
|
|
607
|
+
folder: string;
|
|
608
|
+
extension: string;
|
|
609
|
+
}
|
|
610
|
+
interface IJobStepIO {
|
|
611
|
+
id: string;
|
|
612
|
+
/** @format double */
|
|
613
|
+
prop_index: number;
|
|
614
|
+
name: string;
|
|
615
|
+
type: JobStepIOType;
|
|
616
|
+
value: string;
|
|
617
|
+
props: IJobStepIOProps | null;
|
|
618
|
+
}
|
|
619
|
+
interface IJobNode {
|
|
620
|
+
/** A class representation of the BSON ObjectId type. */
|
|
621
|
+
id: ObjectId;
|
|
622
|
+
/** A class representation of the BSON ObjectId type. */
|
|
623
|
+
node_id: ObjectId;
|
|
624
|
+
name: string;
|
|
625
|
+
status: JobNodeStatus;
|
|
626
|
+
/** @format double */
|
|
627
|
+
attempts: number;
|
|
628
|
+
}
|
|
629
|
+
interface IJobTaskInfo {
|
|
630
|
+
/** @format double */
|
|
631
|
+
step: number;
|
|
632
|
+
/** @format double */
|
|
633
|
+
order: number;
|
|
634
|
+
all_list: string;
|
|
635
|
+
pending_list: string;
|
|
636
|
+
suspended_list: string;
|
|
637
|
+
working_list: string;
|
|
638
|
+
completed_list: string;
|
|
639
|
+
failed_list: string;
|
|
640
|
+
/** @format double */
|
|
641
|
+
all_count: number;
|
|
642
|
+
/** @format double */
|
|
643
|
+
pending_count: number;
|
|
644
|
+
/** @format double */
|
|
645
|
+
suspended_count: number;
|
|
646
|
+
/** @format double */
|
|
647
|
+
working_count: number;
|
|
648
|
+
/** @format double */
|
|
649
|
+
completed_count: number;
|
|
650
|
+
/** @format double */
|
|
651
|
+
failed_count: number;
|
|
652
|
+
}
|
|
653
|
+
interface IJobStepSettings {
|
|
654
|
+
/** @format double */
|
|
655
|
+
limit: number;
|
|
656
|
+
/** @format double */
|
|
657
|
+
maximum: number;
|
|
658
|
+
fixed_limit: boolean;
|
|
659
|
+
/** @format double */
|
|
660
|
+
max_batch_size: number;
|
|
661
|
+
force_finish: ForceFinish;
|
|
662
|
+
/** @format double */
|
|
663
|
+
timeout: number;
|
|
664
|
+
/** @format double */
|
|
665
|
+
max_attempts: number;
|
|
666
|
+
wait_for_previous: boolean;
|
|
667
|
+
resumable: boolean;
|
|
668
|
+
}
|
|
669
|
+
interface IJobStep {
|
|
670
|
+
id: string;
|
|
671
|
+
/** A class representation of the BSON ObjectId type. */
|
|
672
|
+
_id: ObjectId;
|
|
673
|
+
/** @format double */
|
|
674
|
+
index: number;
|
|
675
|
+
name: string;
|
|
676
|
+
type: TaskType;
|
|
677
|
+
reqs: IReq[];
|
|
678
|
+
props: IJobProp[];
|
|
679
|
+
output: IJobStepIO[];
|
|
680
|
+
nodes: IJobNode[];
|
|
681
|
+
whitelisted_nodes: string[];
|
|
682
|
+
task_info: IJobTaskInfo;
|
|
683
|
+
settings: IJobStepSettings;
|
|
684
|
+
tasks: IJobTask[] | ObjectId[] | string[];
|
|
685
|
+
progress: IProgress;
|
|
686
|
+
}
|
|
687
|
+
interface IDependency {
|
|
688
|
+
id: string;
|
|
689
|
+
job_id: string;
|
|
690
|
+
resolved: boolean;
|
|
691
|
+
type?: string;
|
|
692
|
+
key?: string;
|
|
693
|
+
value?: any;
|
|
694
|
+
}
|
|
695
|
+
interface IMetadata {
|
|
696
|
+
id: string;
|
|
697
|
+
label: string;
|
|
698
|
+
value: string | number;
|
|
699
|
+
type: string;
|
|
700
|
+
icon: string;
|
|
701
|
+
}
|
|
702
|
+
interface ICleanup {
|
|
703
|
+
type: CleanupType;
|
|
704
|
+
/** @format double */
|
|
705
|
+
delay: number;
|
|
706
|
+
}
|
|
707
|
+
interface INotification {
|
|
708
|
+
id: string;
|
|
709
|
+
enabled: boolean;
|
|
710
|
+
channel: NotificationChannel;
|
|
711
|
+
type: NotificationType;
|
|
712
|
+
label: string;
|
|
713
|
+
value: string;
|
|
714
|
+
}
|
|
715
|
+
interface IAsset {
|
|
716
|
+
id: string;
|
|
717
|
+
type: string;
|
|
718
|
+
source: string;
|
|
719
|
+
filepath: string;
|
|
720
|
+
filename: string;
|
|
721
|
+
target_filename?: string;
|
|
722
|
+
retarget?: boolean;
|
|
723
|
+
state: AssetState;
|
|
724
|
+
/** @format double */
|
|
725
|
+
size: number;
|
|
726
|
+
hash: string;
|
|
727
|
+
}
|
|
728
|
+
/** Charge record for credit spending (cloud jobs only) */
|
|
729
|
+
interface ICharge {
|
|
730
|
+
transaction_id: string;
|
|
731
|
+
/** @format double */
|
|
732
|
+
amount: number;
|
|
733
|
+
task_id: string;
|
|
734
|
+
/** @format double */
|
|
735
|
+
frame: number;
|
|
736
|
+
node_id: string | null;
|
|
737
|
+
/** @format double */
|
|
738
|
+
created_at: number;
|
|
739
|
+
}
|
|
740
|
+
interface IJob {
|
|
741
|
+
id: string;
|
|
742
|
+
/** A class representation of the BSON ObjectId type. */
|
|
743
|
+
_id: ObjectId;
|
|
744
|
+
user_id: ObjectId | null;
|
|
745
|
+
account_id: ObjectId | null;
|
|
746
|
+
name: string;
|
|
747
|
+
env: JobEnv;
|
|
748
|
+
icon?: string;
|
|
749
|
+
description: string;
|
|
750
|
+
thumbnail?: string;
|
|
751
|
+
color?: string;
|
|
752
|
+
tags: string[];
|
|
753
|
+
/** A class representation of the BSON ObjectId type. */
|
|
754
|
+
pool_id: ObjectId;
|
|
755
|
+
/** A class representation of the BSON ObjectId type. */
|
|
756
|
+
group_id: ObjectId;
|
|
757
|
+
/** A class representation of the BSON ObjectId type. */
|
|
758
|
+
storage_id: ObjectId;
|
|
759
|
+
status: Status;
|
|
760
|
+
steps: IJobStep[];
|
|
761
|
+
priority: JobPriority | number;
|
|
762
|
+
dependencies: IDependency[];
|
|
763
|
+
metadata: IMetadata[];
|
|
764
|
+
progress: IProgress;
|
|
765
|
+
cleanup: ICleanup;
|
|
766
|
+
notifications: INotification[];
|
|
767
|
+
assets: IAsset[];
|
|
768
|
+
errors?: IError[];
|
|
769
|
+
charges?: ICharge[];
|
|
770
|
+
/** @format double */
|
|
771
|
+
schedule_date: number | null;
|
|
772
|
+
/** @format double */
|
|
773
|
+
created_at: number | null;
|
|
774
|
+
/** @format double */
|
|
775
|
+
started_at: number | null;
|
|
776
|
+
/** @format double */
|
|
777
|
+
finished_at: number | null;
|
|
778
|
+
/** @format double */
|
|
779
|
+
removed_at: number | null;
|
|
780
|
+
/** @format double */
|
|
781
|
+
archived_at: number | null;
|
|
782
|
+
/** @format double */
|
|
783
|
+
_schemaVersion: number;
|
|
784
|
+
}
|
|
785
|
+
interface ISoftwareValue {
|
|
786
|
+
id: SoftwareId;
|
|
787
|
+
name: string;
|
|
788
|
+
version: string;
|
|
789
|
+
}
|
|
790
|
+
interface IEngineValue {
|
|
791
|
+
id: EngineId;
|
|
792
|
+
name: string;
|
|
793
|
+
version: string;
|
|
794
|
+
}
|
|
795
|
+
interface IPluginValue {
|
|
796
|
+
id: string;
|
|
797
|
+
name: string;
|
|
798
|
+
version: string;
|
|
799
|
+
}
|
|
800
|
+
interface IJobPropOutputValue {
|
|
801
|
+
/** @format double */
|
|
802
|
+
type: number;
|
|
803
|
+
enabled: boolean;
|
|
804
|
+
path: string;
|
|
805
|
+
}
|
|
806
|
+
interface IPublicJobCreate {
|
|
807
|
+
name: string;
|
|
808
|
+
file: string;
|
|
809
|
+
type: TaskType;
|
|
810
|
+
status: "pending" | "suspended";
|
|
811
|
+
host: ISoftwareValue;
|
|
812
|
+
engine?: IEngineValue;
|
|
813
|
+
plugins?: IPluginValue[];
|
|
814
|
+
resolution?: string;
|
|
815
|
+
output?: IJobPropOutputValue[];
|
|
816
|
+
frame?: string;
|
|
817
|
+
pool_id?: string;
|
|
818
|
+
/** @format double */
|
|
819
|
+
priority?: number;
|
|
820
|
+
dependencies?: string[];
|
|
821
|
+
nodes?: string[];
|
|
822
|
+
}
|
|
823
|
+
interface IPublicJobUpdate {
|
|
824
|
+
/** @format double */
|
|
825
|
+
priority?: number;
|
|
826
|
+
/** @format double */
|
|
827
|
+
limit?: number;
|
|
828
|
+
/** @format double */
|
|
829
|
+
max_batch_size?: number;
|
|
830
|
+
whitelisted_nodes?: string[];
|
|
831
|
+
}
|
|
832
|
+
interface IAccount {
|
|
833
|
+
id: string;
|
|
834
|
+
name: string;
|
|
835
|
+
nickname: string;
|
|
836
|
+
picture: string;
|
|
837
|
+
updated_at: string;
|
|
838
|
+
}
|
|
839
|
+
interface IServiceInfo {
|
|
840
|
+
node_id: string | null;
|
|
841
|
+
version: string | null;
|
|
842
|
+
build_type: string | null;
|
|
843
|
+
node_type: NodeType;
|
|
844
|
+
platform: string;
|
|
845
|
+
hostname: string;
|
|
846
|
+
account: IAccount | null;
|
|
847
|
+
}
|
|
848
|
+
|
|
849
|
+
type RenderFlowOptions = {
|
|
850
|
+
baseUrl?: string;
|
|
851
|
+
apiKey?: string;
|
|
852
|
+
timeout?: number;
|
|
853
|
+
};
|
|
854
|
+
type RenderFlowEvent = {
|
|
855
|
+
type: "insert" | "update" | "delete" | "replace";
|
|
856
|
+
document: Record<string, any>;
|
|
857
|
+
updated?: Record<string, any>;
|
|
858
|
+
time: number;
|
|
859
|
+
};
|
|
860
|
+
type EventCallback = (event: RenderFlowEvent) => void;
|
|
861
|
+
type ErrorCallback = (error: Error) => void;
|
|
862
|
+
declare class EventListener {
|
|
863
|
+
private _controller;
|
|
864
|
+
private _closed;
|
|
865
|
+
constructor(url: string, headers: Record<string, string>, onEvent: EventCallback, onError?: ErrorCallback);
|
|
866
|
+
private _connect;
|
|
867
|
+
close(): void;
|
|
868
|
+
}
|
|
869
|
+
declare class RenderFlow {
|
|
870
|
+
readonly info: {
|
|
871
|
+
get: () => Promise<IServiceInfo>;
|
|
872
|
+
};
|
|
873
|
+
readonly jobs: {
|
|
874
|
+
list: () => Promise<IJob[]>;
|
|
875
|
+
get: (id: string) => Promise<IJob>;
|
|
876
|
+
create: (data: IPublicJobCreate) => Promise<IJob>;
|
|
877
|
+
update: (id: string, data: IPublicJobUpdate) => Promise<boolean>;
|
|
878
|
+
delete: (id: string) => Promise<string>;
|
|
879
|
+
start: (id: string) => Promise<boolean>;
|
|
880
|
+
stop: (id: string) => Promise<boolean>;
|
|
881
|
+
reset: (id: string) => Promise<string>;
|
|
882
|
+
archive: (id: string) => Promise<string>;
|
|
883
|
+
updatePool: (id: string, poolId: string) => Promise<any>;
|
|
884
|
+
on: (callback: EventCallback, onError?: ErrorCallback) => EventListener;
|
|
885
|
+
};
|
|
886
|
+
readonly tasks: {
|
|
887
|
+
list: (jobId: string, page?: number, limit?: number) => Promise<any>;
|
|
888
|
+
get: (id: string) => Promise<IJobTask>;
|
|
889
|
+
logs: (id: string, offset?: number, limit?: number) => Promise<any>;
|
|
890
|
+
thumbnail: (id: string) => Promise<void>;
|
|
891
|
+
on: (jobId: string, callback: EventCallback, onError?: ErrorCallback) => EventListener;
|
|
892
|
+
};
|
|
893
|
+
readonly nodes: {
|
|
894
|
+
list: () => Promise<INode[]>;
|
|
895
|
+
get: (id: string) => Promise<INode>;
|
|
896
|
+
delete: (id: string) => Promise<string>;
|
|
897
|
+
updateStatus: (id: string, status: string) => Promise<any>;
|
|
898
|
+
updatePool: (id: string, poolId: string) => Promise<any>;
|
|
899
|
+
utilization: (id: string) => Promise<any>;
|
|
900
|
+
benchmarks: (type?: string) => Promise<any>;
|
|
901
|
+
on: (callback: EventCallback, onError?: ErrorCallback) => EventListener;
|
|
902
|
+
};
|
|
903
|
+
readonly pools: {
|
|
904
|
+
list: () => Promise<IPool[]>;
|
|
905
|
+
get: (id: string) => Promise<IPool>;
|
|
906
|
+
};
|
|
907
|
+
readonly users: {
|
|
908
|
+
list: () => Promise<IUser[]>;
|
|
909
|
+
get: (id: string) => Promise<IUser>;
|
|
910
|
+
};
|
|
911
|
+
readonly errors: {
|
|
912
|
+
list: () => Promise<IError[]>;
|
|
913
|
+
byJob: (id: string) => Promise<IError[]>;
|
|
914
|
+
byNode: (id: string) => Promise<IError[]>;
|
|
915
|
+
};
|
|
916
|
+
private _baseUrl;
|
|
917
|
+
private _headers;
|
|
918
|
+
constructor(options?: RenderFlowOptions);
|
|
919
|
+
}
|
|
920
|
+
|
|
921
|
+
export { type ErrorCallback, type EventCallback, EventListener, type IError, type IJob, type IJobTask, type INode, type IPool, type IPublicJobCreate, type IPublicJobUpdate, type IServiceInfo, type IUser, RenderFlow, type RenderFlowEvent, type RenderFlowOptions };
|