@uug-ai/models 1.7.62 → 1.7.64

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 (2) hide show
  1. package/dist/types.d.ts +250 -14
  2. package/package.json +1 -1
package/dist/types.d.ts CHANGED
@@ -31437,6 +31437,45 @@ export interface paths {
31437
31437
  patch?: never;
31438
31438
  trace?: never;
31439
31439
  };
31440
+ "/internal/workflowrunoverview": {
31441
+ parameters: {
31442
+ query?: never;
31443
+ header?: never;
31444
+ path?: never;
31445
+ cookie?: never;
31446
+ };
31447
+ /**
31448
+ * Get WorkflowRunOverview (schema generation only)
31449
+ * @description Internal endpoint used only to ensure WorkflowRunOverview schema is generated in OpenAPI spec
31450
+ */
31451
+ get: {
31452
+ parameters: {
31453
+ query?: never;
31454
+ header?: never;
31455
+ path?: never;
31456
+ cookie?: never;
31457
+ };
31458
+ requestBody?: never;
31459
+ responses: {
31460
+ /** @description OK */
31461
+ 200: {
31462
+ headers: {
31463
+ [name: string]: unknown;
31464
+ };
31465
+ content: {
31466
+ "application/json": components["schemas"]["api.WorkflowRunOverview"];
31467
+ };
31468
+ };
31469
+ };
31470
+ };
31471
+ put?: never;
31472
+ post?: never;
31473
+ delete?: never;
31474
+ options?: never;
31475
+ head?: never;
31476
+ patch?: never;
31477
+ trace?: never;
31478
+ };
31440
31479
  "/internal/workflowrunstage": {
31441
31480
  parameters: {
31442
31481
  query?: never;
@@ -31476,6 +31515,45 @@ export interface paths {
31476
31515
  patch?: never;
31477
31516
  trace?: never;
31478
31517
  };
31518
+ "/internal/workflowrunstagedecision": {
31519
+ parameters: {
31520
+ query?: never;
31521
+ header?: never;
31522
+ path?: never;
31523
+ cookie?: never;
31524
+ };
31525
+ /**
31526
+ * Get WorkflowRunStageDecision (schema generation only)
31527
+ * @description Internal endpoint used only to ensure WorkflowRunStageDecision schema is generated in OpenAPI spec
31528
+ */
31529
+ get: {
31530
+ parameters: {
31531
+ query?: never;
31532
+ header?: never;
31533
+ path?: never;
31534
+ cookie?: never;
31535
+ };
31536
+ requestBody?: never;
31537
+ responses: {
31538
+ /** @description OK */
31539
+ 200: {
31540
+ headers: {
31541
+ [name: string]: unknown;
31542
+ };
31543
+ content: {
31544
+ "application/json": components["schemas"]["models.WorkflowRunStageDecision"];
31545
+ };
31546
+ };
31547
+ };
31548
+ };
31549
+ put?: never;
31550
+ post?: never;
31551
+ delete?: never;
31552
+ options?: never;
31553
+ head?: never;
31554
+ patch?: never;
31555
+ trace?: never;
31556
+ };
31479
31557
  "/internal/workflowrunstageexecution": {
31480
31558
  parameters: {
31481
31559
  query?: never;
@@ -31554,6 +31632,45 @@ export interface paths {
31554
31632
  patch?: never;
31555
31633
  trace?: never;
31556
31634
  };
31635
+ "/internal/workflowrunstageneeddecision": {
31636
+ parameters: {
31637
+ query?: never;
31638
+ header?: never;
31639
+ path?: never;
31640
+ cookie?: never;
31641
+ };
31642
+ /**
31643
+ * Get WorkflowRunStageNeedDecision (schema generation only)
31644
+ * @description Internal endpoint used only to ensure WorkflowRunStageNeedDecision schema is generated in OpenAPI spec
31645
+ */
31646
+ get: {
31647
+ parameters: {
31648
+ query?: never;
31649
+ header?: never;
31650
+ path?: never;
31651
+ cookie?: never;
31652
+ };
31653
+ requestBody?: never;
31654
+ responses: {
31655
+ /** @description OK */
31656
+ 200: {
31657
+ headers: {
31658
+ [name: string]: unknown;
31659
+ };
31660
+ content: {
31661
+ "application/json": components["schemas"]["models.WorkflowRunStageNeedDecision"];
31662
+ };
31663
+ };
31664
+ };
31665
+ };
31666
+ put?: never;
31667
+ post?: never;
31668
+ delete?: never;
31669
+ options?: never;
31670
+ head?: never;
31671
+ patch?: never;
31672
+ trace?: never;
31673
+ };
31557
31674
  "/internal/workflowrunstatussummary": {
31558
31675
  parameters: {
31559
31676
  query?: never;
@@ -31593,6 +31710,45 @@ export interface paths {
31593
31710
  patch?: never;
31594
31711
  trace?: never;
31595
31712
  };
31713
+ "/internal/workflowruntriggermatch": {
31714
+ parameters: {
31715
+ query?: never;
31716
+ header?: never;
31717
+ path?: never;
31718
+ cookie?: never;
31719
+ };
31720
+ /**
31721
+ * Get WorkflowRunTriggerMatch (schema generation only)
31722
+ * @description Internal endpoint used only to ensure WorkflowRunTriggerMatch schema is generated in OpenAPI spec
31723
+ */
31724
+ get: {
31725
+ parameters: {
31726
+ query?: never;
31727
+ header?: never;
31728
+ path?: never;
31729
+ cookie?: never;
31730
+ };
31731
+ requestBody?: never;
31732
+ responses: {
31733
+ /** @description OK */
31734
+ 200: {
31735
+ headers: {
31736
+ [name: string]: unknown;
31737
+ };
31738
+ content: {
31739
+ "application/json": components["schemas"]["models.WorkflowRunTriggerMatch"];
31740
+ };
31741
+ };
31742
+ };
31743
+ };
31744
+ put?: never;
31745
+ post?: never;
31746
+ delete?: never;
31747
+ options?: never;
31748
+ head?: never;
31749
+ patch?: never;
31750
+ trace?: never;
31751
+ };
31596
31752
  "/internal/workflowstage": {
31597
31753
  parameters: {
31598
31754
  query?: never;
@@ -35037,7 +35193,7 @@ export interface components {
35037
35193
  };
35038
35194
  "api.ListWorkflowRunsResponse": {
35039
35195
  pagination?: components["schemas"]["api.CursorPagination"];
35040
- runs?: components["schemas"]["models.WorkflowRun"][];
35196
+ runs?: components["schemas"]["api.WorkflowRunOverview"][];
35041
35197
  summary?: components["schemas"]["api.WorkflowRunStatusSummary"];
35042
35198
  };
35043
35199
  "api.ListWorkflowRunsSuccessResponse": {
@@ -35416,6 +35572,9 @@ export interface components {
35416
35572
  "api.RunWorkflowRequest": {
35417
35573
  attachmentIds?: string[];
35418
35574
  mediaIds?: string[];
35575
+ /** @description Surface is case (the default) or redaction. The workflow must expose a
35576
+ * manual trigger on this surface; all case/media access checks still apply. */
35577
+ surface?: components["schemas"]["models.WorkflowTriggerSurface"];
35419
35578
  workflowId?: string;
35420
35579
  };
35421
35580
  "api.RunWorkflowResponse": {
@@ -36282,6 +36441,33 @@ export interface components {
36282
36441
  to?: number;
36283
36442
  workflowIds?: string[];
36284
36443
  };
36444
+ "api.WorkflowRunOverview": {
36445
+ caseMediaId?: string;
36446
+ deviceKey?: string;
36447
+ deviceName?: string;
36448
+ dispatched?: number;
36449
+ durationMs?: number;
36450
+ end?: number;
36451
+ hasResults?: boolean;
36452
+ key?: string;
36453
+ mediaId?: string;
36454
+ operations?: components["schemas"]["models.WorkflowRunOperationStatus"][];
36455
+ origin?: components["schemas"]["models.WorkflowRunOrigin"];
36456
+ recordingTimestamp?: number;
36457
+ resolved?: number;
36458
+ runId?: string;
36459
+ /** @enum {string} */
36460
+ sourceAccess?: "available" | "restricted" | "unavailable";
36461
+ sourceLabel?: string;
36462
+ sourceRef?: string;
36463
+ /** @enum {string} */
36464
+ sourceType?: "media" | "case";
36465
+ stageExecutions?: components["schemas"]["models.WorkflowRunStageExecution"][];
36466
+ start?: number;
36467
+ state?: components["schemas"]["models.WorkflowRunState"];
36468
+ workflowId?: string;
36469
+ workflowName?: string;
36470
+ };
36285
36471
  "api.WorkflowRunStatusSummary": {
36286
36472
  completed?: number;
36287
36473
  noResult?: number;
@@ -36310,7 +36496,7 @@ export interface components {
36310
36496
  userId?: string;
36311
36497
  };
36312
36498
  /** @enum {string} */
36313
- "models.AccessTokenScope": "media.read" | "media.update" | "media.export" | "media.share" | "media.redact" | "media.delete" | "application" | "workflow-runs.create" | "workflow-runs.read" | "workflow-runs.update" | "cases.read" | "cases.create" | "cases.update" | "cases.share" | "cases.export" | "cases.runWorkflow" | "cases.delete" | "days.read" | "markers.read" | "markers.write" | "markers.all" | "workflows.read" | "workflows.create" | "workflows.update" | "workflows.delete";
36499
+ "models.AccessTokenScope": "days.read" | "markers.read" | "markers.write" | "markers.all" | "cases.read" | "cases.create" | "cases.update" | "cases.share" | "cases.export" | "cases.runWorkflow" | "cases.delete" | "media.read" | "media.update" | "media.export" | "media.share" | "media.redact" | "media.delete" | "workflows.read" | "workflows.create" | "workflows.update" | "workflows.delete" | "application" | "workflow-runs.create" | "workflow-runs.read" | "workflow-runs.update";
36314
36500
  "models.Account": {
36315
36501
  account?: components["schemas"]["models.AccountBody"];
36316
36502
  };
@@ -38762,7 +38948,7 @@ export interface components {
38762
38948
  videowall?: components["schemas"]["models.Videowall"];
38763
38949
  };
38764
38950
  /** @enum {string} */
38765
- "models.Permission": "media.read" | "media.update" | "media.export" | "media.share" | "media.redact" | "media.delete" | "application" | "workflow-runs.create" | "workflow-runs.read" | "workflow-runs.update" | "cases.read" | "cases.create" | "cases.update" | "cases.share" | "cases.export" | "cases.runWorkflow" | "cases.delete" | "days.read" | "markers.read" | "markers.write" | "markers.all" | "workflows.read" | "workflows.create" | "workflows.update" | "workflows.delete";
38951
+ "models.Permission": "days.read" | "markers.read" | "markers.write" | "markers.all" | "cases.read" | "cases.create" | "cases.update" | "cases.share" | "cases.export" | "cases.runWorkflow" | "cases.delete" | "media.read" | "media.update" | "media.export" | "media.share" | "media.redact" | "media.delete" | "workflows.read" | "workflows.create" | "workflows.update" | "workflows.delete" | "application" | "workflow-runs.create" | "workflow-runs.read" | "workflow-runs.update";
38766
38952
  /** @enum {integer} */
38767
38953
  "models.PermissionLevel": 1 | 2 | 3 | 4 | 2 | 3 | 4 | 5 | 2 | 3 | 2 | 2 | 3 | 2 | 3 | 4;
38768
38954
  "models.Permissions": {
@@ -39118,6 +39304,7 @@ export interface components {
39118
39304
  "models.StageParam": {
39119
39305
  /** @description Default is applied when a node supplies no value for this parameter. */
39120
39306
  default?: unknown;
39307
+ description?: string;
39121
39308
  label?: string;
39122
39309
  name?: string;
39123
39310
  /** @description Options enumerates the permitted values when Type is StageParamSelect. */
@@ -39126,7 +39313,7 @@ export interface components {
39126
39313
  type?: components["schemas"]["models.StageParamType"];
39127
39314
  };
39128
39315
  /** @enum {string} */
39129
- "models.StageParamType": "string" | "number" | "boolean" | "select";
39316
+ "models.StageParamType": "string" | "number" | "boolean" | "select" | "secret";
39130
39317
  "models.StagePort": {
39131
39318
  label?: string;
39132
39319
  name?: string;
@@ -40057,7 +40244,7 @@ export interface components {
40057
40244
  data?: {
40058
40245
  [key: string]: unknown;
40059
40246
  };
40060
- /** @description Devices scopes a device node to recordings from these devices. Empty means
40247
+ /** @description Devices scopes an automatic root to recordings from these devices. Empty means
40061
40248
  * every device the workflow's owner can see. Ignored on stage nodes. */
40062
40249
  devices?: components["schemas"]["models.DeviceKey"][];
40063
40250
  /** @description Id is this instance's identity within the workflow. It is the stable
@@ -40067,15 +40254,19 @@ export interface components {
40067
40254
  label?: string;
40068
40255
  /** @description StageRef is the referenced stage's Operation key (the catalog key shared
40069
40256
  * by platform- and user-defined stages), not its Mongo Id. Set on every
40070
- * stage node and resolved at compile time; empty on a device node. */
40257
+ * stage node and resolved at compile time; empty on a root node. */
40071
40258
  stageRef?: string;
40259
+ /** @description Trigger is required on Start nodes. Automatic settings and inactive manual
40260
+ * surface selections are retained here; NormalizeTriggers derives runtime
40261
+ * triggers without exposing inactive settings. */
40262
+ trigger?: components["schemas"]["models.WorkflowTrigger"];
40072
40263
  /** @description Type is what the node represents; empty means WorkflowNodeStage. */
40073
40264
  type?: components["schemas"]["models.WorkflowNodeType"];
40074
40265
  x?: number;
40075
40266
  y?: number;
40076
40267
  };
40077
40268
  /** @enum {string} */
40078
- "models.WorkflowNodeType": "stage" | "device";
40269
+ "models.WorkflowNodeType": "stage" | "device" | "start";
40079
40270
  "models.WorkflowPredicate": {
40080
40271
  op?: components["schemas"]["models.ConditionOp"];
40081
40272
  path?: string;
@@ -40094,6 +40285,7 @@ export interface components {
40094
40285
  stage?: components["schemas"]["models.WorkflowStageReference"];
40095
40286
  };
40096
40287
  "models.WorkflowRun": {
40288
+ caseMediaId?: string;
40097
40289
  /** @description Device identifies the recording the run derives from, with the few fields
40098
40290
  * vault-override resolution and logging need (device key/name and where the
40099
40291
  * media is stored/served from). Copied from the recording at hand-off time.
@@ -40111,7 +40303,6 @@ export interface components {
40111
40303
  dispatchedOperations?: string[];
40112
40304
  durationMs?: number;
40113
40305
  end?: number;
40114
- endedAtMs?: number;
40115
40306
  hasResults?: boolean;
40116
40307
  /** @description Inputs is the immutable start context the run opens with, keyed by the
40117
40308
  * upstream operation that produced it (e.g. "classify" → the classification
@@ -40146,6 +40337,17 @@ export interface components {
40146
40337
  * be filtered by how they started. Empty is treated as automatic for runs
40147
40338
  * opened before origins existed. */
40148
40339
  origin?: components["schemas"]["models.WorkflowRunOrigin"];
40340
+ /** @description Params carries the per-placement parameter values the workflow editor
40341
+ * stored for the dispatched stage (WorkflowNode.Data, declared by the
40342
+ * stage's WorkflowStage.Params). The engine resolves them from the workflow
40343
+ * definition on every engine→worker dispatch, so a worker such as the
40344
+ * forwarder can let a tenant override deployment defaults. Values may include
40345
+ * StageParamSecret credentials, so `bson:"-"` is load-bearing — like Storage,
40346
+ * they never persist in run state — and a worker must never echo them back
40347
+ * or copy them into anything it forwards. */
40348
+ params?: {
40349
+ [key: string]: unknown;
40350
+ };
40149
40351
  /** @description Payload is the self-describing block envelope a delegated-ingest worker
40150
40352
  * hands back for the platform to persist: one or more typed blocks (e.g. a
40151
40353
  * "detection" block carrying a PostDetectionsRequest, optionally followed by
@@ -40224,12 +40426,17 @@ export interface components {
40224
40426
  * and short-lived, so — like Storage — it is wire-only and never lands in the
40225
40427
  * run's persisted state; a stage dispatched after a reload fetches via Storage. */
40226
40428
  signedUrl?: string;
40429
+ sourceAccess?: string;
40430
+ sourceLabel?: string;
40227
40431
  /** @description SourceRef ties a manual run back to the thing it was launched from — e.g.
40228
40432
  * the case id when launched from a case surface — so sibling runs fanned out
40229
40433
  * from one user action (one seed per selected media key) can be grouped above
40230
40434
  * the run. Empty for automatic runs. It generalises to any run-grouping handle
40231
40435
  * (a case id today; a temporal device-series id is a forward-looking twin). */
40232
40436
  sourceRef?: string;
40437
+ /** @description SourceType disambiguates case launches from media launch-group references.
40438
+ * Legacy readers infer case ownership from SourceRef and case input metadata. */
40439
+ sourceType?: string;
40233
40440
  /** @description StageExecutions reads the legacy split timeline. NormalizeStages moves
40234
40441
  * matched summaries into Stages, retaining unmatched history without
40235
40442
  * reconstructing missing routing. Serialization does not normalize implicitly.
@@ -40241,13 +40448,9 @@ export interface components {
40241
40448
  * split lifecycle summaries. Nil means no captured routing (legacy fallback);
40242
40449
  * an explicit empty slice is an authoritative zero-stage plan. */
40243
40450
  stages?: components["schemas"]["models.WorkflowRunStage"][];
40244
- /** @description Start and End stamp the run's lifecycle (unix seconds). They remain for
40245
- * compatibility with existing runs and list indexes. */
40451
+ /** @description Start and End stamp the run's lifecycle in Unix milliseconds. Readers
40452
+ * normalize legacy runs whose values were persisted in Unix seconds. */
40246
40453
  start?: number;
40247
- /** @description StartedAtMs and EndedAtMs are the millisecond-precision counterparts of the
40248
- * legacy Start and End fields. New writers populate both pairs; readers fall
40249
- * back to Start/End for runs created before these fields existed. */
40250
- startedAtMs?: number;
40251
40454
  /** @description The fields below are API read projections. They are derived or joined by
40252
40455
  * the service after loading a run and never persist back into workflow state. */
40253
40456
  state?: components["schemas"]["models.WorkflowRunState"];
@@ -40261,6 +40464,11 @@ export interface components {
40261
40464
  /** @description TraceId continues the distributed trace across the workflow tail and lets
40262
40465
  * authorized detail surfaces correlate the durable run with telemetry. */
40263
40466
  traceId?: string;
40467
+ /** @description TriggerMatch records the first automatic trigger that selected this run.
40468
+ * It is immutable engine-owned provenance, not stage execution state. Nil
40469
+ * means no captured match (legacy or a launch that bypassed automatic matching).
40470
+ * Readers must not reconstruct it from Origin or today's workflow definition. */
40471
+ triggerMatch?: components["schemas"]["models.WorkflowRunTriggerMatch"];
40264
40472
  /** @description User is the curated, secret-free account context a run needs: the
40265
40473
  * organisation that owns the recording (for logging/scoping) and the account
40266
40474
  * Storage block used to resolve a per-recording vault override. Copied (and
@@ -40279,6 +40487,8 @@ export interface components {
40279
40487
  workflowName?: string;
40280
40488
  };
40281
40489
  /** @enum {string} */
40490
+ "models.WorkflowRunDecisionOutcome": "passed" | "failed" | "waiting" | "notEvaluated";
40491
+ /** @enum {string} */
40282
40492
  "models.WorkflowRunOperationState": "dispatched" | "resolved";
40283
40493
  "models.WorkflowRunOperationStatus": {
40284
40494
  operation?: string;
@@ -40297,6 +40507,11 @@ export interface components {
40297
40507
  operation?: string;
40298
40508
  queue?: string;
40299
40509
  };
40510
+ "models.WorkflowRunStageDecision": {
40511
+ eligible?: boolean;
40512
+ evaluatedAtMs?: number;
40513
+ needs?: components["schemas"]["models.WorkflowRunStageNeedDecision"][];
40514
+ };
40300
40515
  "models.WorkflowRunStageExecution": {
40301
40516
  dependencies?: string[];
40302
40517
  dispatchAttempts?: number;
@@ -40311,6 +40526,10 @@ export interface components {
40311
40526
  state?: components["schemas"]["models.WorkflowRunStageState"];
40312
40527
  };
40313
40528
  "models.WorkflowRunStageExecutionDetails": {
40529
+ /** @description Decision is the latest captured routing evaluation while waiting, then the
40530
+ * decision associated with dispatch. Nil means no decision was captured.
40531
+ * Writers preserve the dispatch decision; readers never infer it from state. */
40532
+ decision?: components["schemas"]["models.WorkflowRunStageDecision"];
40314
40533
  dispatchAttempts?: number;
40315
40534
  dispatchedAtMs?: number;
40316
40535
  durationMs?: number;
@@ -40320,10 +40539,23 @@ export interface components {
40320
40539
  resolvedAtMs?: number;
40321
40540
  state?: components["schemas"]["models.WorkflowRunStageState"];
40322
40541
  };
40542
+ "models.WorkflowRunStageNeedDecision": {
40543
+ index?: number;
40544
+ outcome?: components["schemas"]["models.WorkflowRunDecisionOutcome"];
40545
+ };
40323
40546
  /** @enum {string} */
40324
40547
  "models.WorkflowRunStageState": "waiting" | "retrying" | "dispatched" | "resolved" | "dispatchFailed" | "timedOut" | "skipped";
40325
40548
  /** @enum {string} */
40326
40549
  "models.WorkflowRunState": "running" | "completed" | "noResult";
40550
+ "models.WorkflowRunTriggerMatch": {
40551
+ /** @description EvaluatedAtMs is the Unix-millisecond instant used for schedule matching
40552
+ * (usually recording time), not when the engine processed or opened the run. */
40553
+ evaluatedAtMs?: number;
40554
+ /** @description Index is zero-based in the normalized trigger list at selection time.
40555
+ * It is historical context, not a stable ID into an edited definition. */
40556
+ index?: number;
40557
+ trigger?: components["schemas"]["models.WorkflowTrigger"];
40558
+ };
40327
40559
  /** @enum {string} */
40328
40560
  "models.WorkflowSource": "user" | "config";
40329
40561
  "models.WorkflowStage": {
@@ -40788,8 +41020,11 @@ export declare namespace models {
40788
41020
  type WorkflowRun = components['schemas']['models.WorkflowRun'];
40789
41021
  type WorkflowRunOperationStatus = components['schemas']['models.WorkflowRunOperationStatus'];
40790
41022
  type WorkflowRunStage = components['schemas']['models.WorkflowRunStage'];
41023
+ type WorkflowRunStageDecision = components['schemas']['models.WorkflowRunStageDecision'];
40791
41024
  type WorkflowRunStageExecution = components['schemas']['models.WorkflowRunStageExecution'];
40792
41025
  type WorkflowRunStageExecutionDetails = components['schemas']['models.WorkflowRunStageExecutionDetails'];
41026
+ type WorkflowRunStageNeedDecision = components['schemas']['models.WorkflowRunStageNeedDecision'];
41027
+ type WorkflowRunTriggerMatch = components['schemas']['models.WorkflowRunTriggerMatch'];
40793
41028
  type WorkflowStage = components['schemas']['models.WorkflowStage'];
40794
41029
  type WorkflowStageReference = components['schemas']['models.WorkflowStageReference'];
40795
41030
  type WorkflowStorage = components['schemas']['models.WorkflowStorage'];
@@ -41260,5 +41495,6 @@ export declare namespace api {
41260
41495
  type WarningResponse = components['schemas']['api.WarningResponse'];
41261
41496
  type WorkflowFilter = components['schemas']['api.WorkflowFilter'];
41262
41497
  type WorkflowRunFilter = components['schemas']['api.WorkflowRunFilter'];
41498
+ type WorkflowRunOverview = components['schemas']['api.WorkflowRunOverview'];
41263
41499
  type WorkflowRunStatusSummary = components['schemas']['api.WorkflowRunStatusSummary'];
41264
41500
  }
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@uug-ai/models",
3
- "version": "1.7.62",
3
+ "version": "1.7.64",
4
4
  "description": "TypeScript type definitions for Go models",
5
5
  "main": "dist/types.js",
6
6
  "types": "dist/types.d.ts",