@rendobar/sdk 3.0.1 → 3.1.0

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.
Files changed (5) hide show
  1. package/dist/index.cjs +8 -0
  2. package/dist/index.d.cts +29 -4
  3. package/dist/index.d.mts +29 -4
  4. package/dist/index.mjs +8 -0
  5. package/package.json +1 -1
package/dist/index.cjs CHANGED
@@ -699,6 +699,8 @@ const KNOWN_EVENT_TYPES = new Set([
699
699
  "job.progress",
700
700
  "job.step",
701
701
  "job.log",
702
+ "job.metrics",
703
+ "job.context",
702
704
  "balance.updated",
703
705
  "subscription.updated",
704
706
  "notification",
@@ -787,6 +789,12 @@ function dispatchJobEvent(event, options) {
787
789
  case "job.result":
788
790
  options.onResult?.(event);
789
791
  break;
792
+ case "job.metrics":
793
+ options.onMetrics?.(event);
794
+ break;
795
+ case "job.context":
796
+ options.onContext?.(event);
797
+ break;
790
798
  }
791
799
  }
792
800
  //#endregion
package/dist/index.d.cts CHANGED
@@ -2269,6 +2269,7 @@ declare const jobResponseSchema: ZodDiscriminatedUnion<[ZodObject<{
2269
2269
  error: ZodOptional<ZodString>;
2270
2270
  }, $strip>>;
2271
2271
  logsAvailable: ZodBoolean;
2272
+ metricsAvailable: ZodBoolean;
2272
2273
  createdAt: ZodNumber;
2273
2274
  dispatchedAt: ZodNullable<ZodNumber>;
2274
2275
  startedAt: ZodNullable<ZodNumber>;
@@ -2305,6 +2306,7 @@ declare const jobResponseSchema: ZodDiscriminatedUnion<[ZodObject<{
2305
2306
  error: ZodOptional<ZodString>;
2306
2307
  }, $strip>>;
2307
2308
  logsAvailable: ZodBoolean;
2309
+ metricsAvailable: ZodBoolean;
2308
2310
  createdAt: ZodNumber;
2309
2311
  dispatchedAt: ZodNullable<ZodNumber>;
2310
2312
  startedAt: ZodNullable<ZodNumber>;
@@ -2343,6 +2345,7 @@ declare const jobResponseSchema: ZodDiscriminatedUnion<[ZodObject<{
2343
2345
  error: ZodOptional<ZodString>;
2344
2346
  }, $strip>>;
2345
2347
  logsAvailable: ZodBoolean;
2348
+ metricsAvailable: ZodBoolean;
2346
2349
  createdAt: ZodNumber;
2347
2350
  dispatchedAt: ZodNullable<ZodNumber>;
2348
2351
  startedAt: ZodNullable<ZodNumber>;
@@ -2381,6 +2384,7 @@ declare const jobResponseSchema: ZodDiscriminatedUnion<[ZodObject<{
2381
2384
  error: ZodOptional<ZodString>;
2382
2385
  }, $strip>>;
2383
2386
  logsAvailable: ZodBoolean;
2387
+ metricsAvailable: ZodBoolean;
2384
2388
  createdAt: ZodNumber;
2385
2389
  dispatchedAt: ZodNullable<ZodNumber>;
2386
2390
  startedAt: ZodNullable<ZodNumber>;
@@ -2461,6 +2465,7 @@ declare const jobResponseSchema: ZodDiscriminatedUnion<[ZodObject<{
2461
2465
  error: ZodOptional<ZodString>;
2462
2466
  }, $strip>>;
2463
2467
  logsAvailable: ZodBoolean;
2468
+ metricsAvailable: ZodBoolean;
2464
2469
  createdAt: ZodNumber;
2465
2470
  dispatchedAt: ZodNullable<ZodNumber>;
2466
2471
  startedAt: ZodNullable<ZodNumber>;
@@ -2503,6 +2508,7 @@ declare const jobResponseSchema: ZodDiscriminatedUnion<[ZodObject<{
2503
2508
  error: ZodOptional<ZodString>;
2504
2509
  }, $strip>>;
2505
2510
  logsAvailable: ZodBoolean;
2511
+ metricsAvailable: ZodBoolean;
2506
2512
  createdAt: ZodNumber;
2507
2513
  dispatchedAt: ZodNullable<ZodNumber>;
2508
2514
  startedAt: ZodNullable<ZodNumber>;
@@ -2520,7 +2526,7 @@ declare const jobTypeSchema: ZodObject<{
2520
2526
  summary: ZodString;
2521
2527
  needs: ZodArray<ZodString>;
2522
2528
  pattern: ZodNullable<ZodString>;
2523
- provider: ZodOptional<ZodObject<{
2529
+ runner: ZodOptional<ZodObject<{
2524
2530
  id: ZodString;
2525
2531
  resource: ZodString;
2526
2532
  }, $strip>>;
@@ -2866,6 +2872,19 @@ declare const orgEventSchema: ZodDiscriminatedUnion<[ZodObject<{
2866
2872
  stepProgress: ZodOptional<ZodNumber>;
2867
2873
  eta: ZodOptional<ZodNumber>;
2868
2874
  metrics: ZodOptional<ZodRecord<ZodString, ZodUnion<readonly [ZodNumber, ZodString]>>>;
2875
+ }, $strip>, ZodObject<{
2876
+ type: ZodLiteral<"job.metrics">;
2877
+ jobId: ZodString;
2878
+ timestamp: ZodNumber;
2879
+ cpuPct: ZodNumber;
2880
+ cpuCores: ZodNumber;
2881
+ allocatedCores: ZodOptional<ZodNumber>;
2882
+ memUsedMB: ZodNumber;
2883
+ memLimitMB: ZodNumber;
2884
+ diskRMBps: ZodOptional<ZodNumber>;
2885
+ diskWMBps: ZodOptional<ZodNumber>;
2886
+ netRxMBps: ZodOptional<ZodNumber>;
2887
+ netTxMBps: ZodOptional<ZodNumber>;
2869
2888
  }, $strip>, ZodObject<{
2870
2889
  type: ZodLiteral<"job.step">;
2871
2890
  jobId: ZodString;
@@ -2902,10 +2921,10 @@ declare const orgEventSchema: ZodDiscriminatedUnion<[ZodObject<{
2902
2921
  }, $strip>], "type">;
2903
2922
  type OrgEvent = output<typeof orgEventSchema>;
2904
2923
  /**
2905
- * Log entry data structure used by dashboard hooks and executor.
2924
+ * Log entry data structure used by dashboard hooks and runner.
2906
2925
  * Import from `@rendobar/shared/events/org-events`.
2907
2926
  *
2908
- * Matches executor's log event format.
2927
+ * Matches runner's log event format.
2909
2928
  */
2910
2929
  interface LogEntryData {
2911
2930
  timestamp: number;
@@ -2949,7 +2968,7 @@ declare function jobData<T>(job: JobResponse): T | null;
2949
2968
  * Per-job execution timing breakdown. Returned by `client.jobs.getTimings(id)`.
2950
2969
  *
2951
2970
  * All values are milliseconds, or `null` if the corresponding stage did not
2952
- * execute (e.g. a sync-completed job has no executor or queue timings).
2971
+ * execute (e.g. a sync-completed job has no runner or queue timings).
2953
2972
  */
2954
2973
  interface JobTimings {
2955
2974
  jobId: string;
@@ -3278,6 +3297,12 @@ interface JobSubscribeOptions {
3278
3297
  onComplete?: (event: Extract<OrgEvent, {
3279
3298
  type: "job.status";
3280
3299
  }>) => void;
3300
+ onMetrics?: (event: Extract<OrgEvent, {
3301
+ type: "job.metrics";
3302
+ }>) => void;
3303
+ onContext?: (event: Extract<OrgEvent, {
3304
+ type: "job.context";
3305
+ }>) => void;
3281
3306
  onError?: (error: Error) => void;
3282
3307
  }
3283
3308
  interface JobSubscription {
package/dist/index.d.mts CHANGED
@@ -2269,6 +2269,7 @@ declare const jobResponseSchema: ZodDiscriminatedUnion<[ZodObject<{
2269
2269
  error: ZodOptional<ZodString>;
2270
2270
  }, $strip>>;
2271
2271
  logsAvailable: ZodBoolean;
2272
+ metricsAvailable: ZodBoolean;
2272
2273
  createdAt: ZodNumber;
2273
2274
  dispatchedAt: ZodNullable<ZodNumber>;
2274
2275
  startedAt: ZodNullable<ZodNumber>;
@@ -2305,6 +2306,7 @@ declare const jobResponseSchema: ZodDiscriminatedUnion<[ZodObject<{
2305
2306
  error: ZodOptional<ZodString>;
2306
2307
  }, $strip>>;
2307
2308
  logsAvailable: ZodBoolean;
2309
+ metricsAvailable: ZodBoolean;
2308
2310
  createdAt: ZodNumber;
2309
2311
  dispatchedAt: ZodNullable<ZodNumber>;
2310
2312
  startedAt: ZodNullable<ZodNumber>;
@@ -2343,6 +2345,7 @@ declare const jobResponseSchema: ZodDiscriminatedUnion<[ZodObject<{
2343
2345
  error: ZodOptional<ZodString>;
2344
2346
  }, $strip>>;
2345
2347
  logsAvailable: ZodBoolean;
2348
+ metricsAvailable: ZodBoolean;
2346
2349
  createdAt: ZodNumber;
2347
2350
  dispatchedAt: ZodNullable<ZodNumber>;
2348
2351
  startedAt: ZodNullable<ZodNumber>;
@@ -2381,6 +2384,7 @@ declare const jobResponseSchema: ZodDiscriminatedUnion<[ZodObject<{
2381
2384
  error: ZodOptional<ZodString>;
2382
2385
  }, $strip>>;
2383
2386
  logsAvailable: ZodBoolean;
2387
+ metricsAvailable: ZodBoolean;
2384
2388
  createdAt: ZodNumber;
2385
2389
  dispatchedAt: ZodNullable<ZodNumber>;
2386
2390
  startedAt: ZodNullable<ZodNumber>;
@@ -2461,6 +2465,7 @@ declare const jobResponseSchema: ZodDiscriminatedUnion<[ZodObject<{
2461
2465
  error: ZodOptional<ZodString>;
2462
2466
  }, $strip>>;
2463
2467
  logsAvailable: ZodBoolean;
2468
+ metricsAvailable: ZodBoolean;
2464
2469
  createdAt: ZodNumber;
2465
2470
  dispatchedAt: ZodNullable<ZodNumber>;
2466
2471
  startedAt: ZodNullable<ZodNumber>;
@@ -2503,6 +2508,7 @@ declare const jobResponseSchema: ZodDiscriminatedUnion<[ZodObject<{
2503
2508
  error: ZodOptional<ZodString>;
2504
2509
  }, $strip>>;
2505
2510
  logsAvailable: ZodBoolean;
2511
+ metricsAvailable: ZodBoolean;
2506
2512
  createdAt: ZodNumber;
2507
2513
  dispatchedAt: ZodNullable<ZodNumber>;
2508
2514
  startedAt: ZodNullable<ZodNumber>;
@@ -2520,7 +2526,7 @@ declare const jobTypeSchema: ZodObject<{
2520
2526
  summary: ZodString;
2521
2527
  needs: ZodArray<ZodString>;
2522
2528
  pattern: ZodNullable<ZodString>;
2523
- provider: ZodOptional<ZodObject<{
2529
+ runner: ZodOptional<ZodObject<{
2524
2530
  id: ZodString;
2525
2531
  resource: ZodString;
2526
2532
  }, $strip>>;
@@ -2866,6 +2872,19 @@ declare const orgEventSchema: ZodDiscriminatedUnion<[ZodObject<{
2866
2872
  stepProgress: ZodOptional<ZodNumber>;
2867
2873
  eta: ZodOptional<ZodNumber>;
2868
2874
  metrics: ZodOptional<ZodRecord<ZodString, ZodUnion<readonly [ZodNumber, ZodString]>>>;
2875
+ }, $strip>, ZodObject<{
2876
+ type: ZodLiteral<"job.metrics">;
2877
+ jobId: ZodString;
2878
+ timestamp: ZodNumber;
2879
+ cpuPct: ZodNumber;
2880
+ cpuCores: ZodNumber;
2881
+ allocatedCores: ZodOptional<ZodNumber>;
2882
+ memUsedMB: ZodNumber;
2883
+ memLimitMB: ZodNumber;
2884
+ diskRMBps: ZodOptional<ZodNumber>;
2885
+ diskWMBps: ZodOptional<ZodNumber>;
2886
+ netRxMBps: ZodOptional<ZodNumber>;
2887
+ netTxMBps: ZodOptional<ZodNumber>;
2869
2888
  }, $strip>, ZodObject<{
2870
2889
  type: ZodLiteral<"job.step">;
2871
2890
  jobId: ZodString;
@@ -2902,10 +2921,10 @@ declare const orgEventSchema: ZodDiscriminatedUnion<[ZodObject<{
2902
2921
  }, $strip>], "type">;
2903
2922
  type OrgEvent = output<typeof orgEventSchema>;
2904
2923
  /**
2905
- * Log entry data structure used by dashboard hooks and executor.
2924
+ * Log entry data structure used by dashboard hooks and runner.
2906
2925
  * Import from `@rendobar/shared/events/org-events`.
2907
2926
  *
2908
- * Matches executor's log event format.
2927
+ * Matches runner's log event format.
2909
2928
  */
2910
2929
  interface LogEntryData {
2911
2930
  timestamp: number;
@@ -2949,7 +2968,7 @@ declare function jobData<T>(job: JobResponse): T | null;
2949
2968
  * Per-job execution timing breakdown. Returned by `client.jobs.getTimings(id)`.
2950
2969
  *
2951
2970
  * All values are milliseconds, or `null` if the corresponding stage did not
2952
- * execute (e.g. a sync-completed job has no executor or queue timings).
2971
+ * execute (e.g. a sync-completed job has no runner or queue timings).
2953
2972
  */
2954
2973
  interface JobTimings {
2955
2974
  jobId: string;
@@ -3278,6 +3297,12 @@ interface JobSubscribeOptions {
3278
3297
  onComplete?: (event: Extract<OrgEvent, {
3279
3298
  type: "job.status";
3280
3299
  }>) => void;
3300
+ onMetrics?: (event: Extract<OrgEvent, {
3301
+ type: "job.metrics";
3302
+ }>) => void;
3303
+ onContext?: (event: Extract<OrgEvent, {
3304
+ type: "job.context";
3305
+ }>) => void;
3281
3306
  onError?: (error: Error) => void;
3282
3307
  }
3283
3308
  interface JobSubscription {
package/dist/index.mjs CHANGED
@@ -698,6 +698,8 @@ const KNOWN_EVENT_TYPES = new Set([
698
698
  "job.progress",
699
699
  "job.step",
700
700
  "job.log",
701
+ "job.metrics",
702
+ "job.context",
701
703
  "balance.updated",
702
704
  "subscription.updated",
703
705
  "notification",
@@ -786,6 +788,12 @@ function dispatchJobEvent(event, options) {
786
788
  case "job.result":
787
789
  options.onResult?.(event);
788
790
  break;
791
+ case "job.metrics":
792
+ options.onMetrics?.(event);
793
+ break;
794
+ case "job.context":
795
+ options.onContext?.(event);
796
+ break;
789
797
  }
790
798
  }
791
799
  //#endregion
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@rendobar/sdk",
3
- "version": "3.0.1",
3
+ "version": "3.1.0",
4
4
  "type": "module",
5
5
  "description": "TypeScript client for the Rendobar media processing API",
6
6
  "main": "./dist/index.cjs",