@uug-ai/models 1.6.7 → 1.6.9

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 +93 -7
  2. package/package.json +1 -1
package/dist/types.d.ts CHANGED
@@ -32744,7 +32744,43 @@ export interface components {
32744
32744
  name?: string;
32745
32745
  nodes?: components["schemas"]["models.WorkflowNode"][];
32746
32746
  organisation_id?: string;
32747
+ /**
32748
+ * @description Source is the workflow's provenance and availability (see WorkflowSource).
32749
+ * Empty means WorkflowSourceUser: an ordinary user workflow scoped to its
32750
+ * OrganisationId. WorkflowSourceConfig marks a helm-seeded, deployment-global,
32751
+ * read-only workflow. Every workflow persisted before this field existed
32752
+ * decodes as user.
32753
+ */
32754
+ source?: components["schemas"]["models.WorkflowSource"];
32755
+ /**
32756
+ * @description Stages is the workflow's executable stage set: the runtime-authoritative
32757
+ * projection the engine dispatches against. When set it is used as-is (config
32758
+ * workflows author it directly in the helm registry form: operation, dispatch,
32759
+ * needs, needsMode); when empty it is derived from Nodes+Edges on demand (UI
32760
+ * workflows author the graph and CompileStages projects it). Read it through
32761
+ * CompileStages, never directly, so both authoring styles resolve uniformly.
32762
+ *
32763
+ * Only the routing fields (Operation, Dispatch, Needs, NeedsMode) are
32764
+ * meaningful here; a stage's deployment fields (image, queue, replicas, …) are
32765
+ * resolved by Operation against the shared deployed catalog, not per workflow.
32766
+ * Operations need only be unique within a single workflow, not globally.
32767
+ */
32768
+ stages?: components["schemas"]["models.WorkflowStage"][];
32769
+ /**
32770
+ * @description Trigger is the legacy single-trigger field kept only so workflows persisted
32771
+ * before Triggers existed still decode (and are not silently dropped on
32772
+ * re-save). New code should read and write Triggers; call NormalizeTriggers to
32773
+ * fold any legacy value into Triggers.
32774
+ *
32775
+ * Deprecated: use Triggers.
32776
+ */
32747
32777
  trigger?: components["schemas"]["models.WorkflowTrigger"];
32778
+ /**
32779
+ * @description Triggers is the set of activation modes for this workflow. A workflow may
32780
+ * carry both an automatic and a manual trigger so it runs on its own for
32781
+ * matching recordings and can also be launched on demand from a surface.
32782
+ */
32783
+ triggers?: components["schemas"]["models.WorkflowTrigger"][];
32748
32784
  updated_at?: number;
32749
32785
  user_id?: string;
32750
32786
  username?: string;
@@ -32842,6 +32878,16 @@ export interface components {
32842
32878
  * disambiguate a dispatch from a result.
32843
32879
  */
32844
32880
  operation?: string;
32881
+ /**
32882
+ * @description Origin records how this run was opened — the run-side counterpart of the
32883
+ * Workflow's trigger Type. An automatic run was teed off the pipeline by
32884
+ * analysis for a matching recording; a manual run was launched on demand by a
32885
+ * user from a surface. The engine reads it to skip automatic selection/time
32886
+ * gating for on-demand runs; it is persisted so "all runs for a media key" can
32887
+ * be filtered by how they started. Empty is treated as automatic for runs
32888
+ * opened before origins existed.
32889
+ */
32890
+ origin?: components["schemas"]["models.WorkflowRunOrigin"];
32845
32891
  /**
32846
32892
  * @description Payload is the self-describing block envelope a delegated-ingest worker
32847
32893
  * hands back for the platform to persist: one or more typed blocks (e.g. a
@@ -32898,6 +32944,12 @@ export interface components {
32898
32944
  * is empty on the analysis hand-off — the run is keyed by Key until the
32899
32945
  * engine opens it — and set on every engine→worker dispatch. The persisted
32900
32946
  * identity is Id, so RunId itself is wire-only.
32947
+ *
32948
+ * It is never set by hand: MarshalJSON derives it from Id whenever a run that
32949
+ * has been opened (its _id is set) is serialized, so a producer only has to
32950
+ * stamp Id and the two representations can never drift. A run without an Id
32951
+ * yet (the analysis hand-off) keeps whatever RunId it was given (normally
32952
+ * empty, so runId is omitted).
32901
32953
  */
32902
32954
  runId?: string;
32903
32955
  /**
@@ -32912,6 +32964,14 @@ export interface components {
32912
32964
  * run's persisted state; a stage dispatched after a reload fetches via Storage.
32913
32965
  */
32914
32966
  signedUrl?: string;
32967
+ /**
32968
+ * @description SourceRef ties a manual run back to the thing it was launched from — e.g.
32969
+ * the case id when launched from a case surface — so sibling runs fanned out
32970
+ * from one user action (one seed per selected media key) can be grouped above
32971
+ * the run. Empty for automatic runs. It generalises to any run-grouping handle
32972
+ * (a case id today; a temporal device-series id is a forward-looking twin).
32973
+ */
32974
+ sourceRef?: string;
32915
32975
  /**
32916
32976
  * @description Storage carries the credentials a dispatched stage worker needs to fetch
32917
32977
  * the media (global Kerberos Storage plus any resolved per-recording vault
@@ -32947,6 +33007,10 @@ export interface components {
32947
33007
  */
32948
33008
  workflowName?: string;
32949
33009
  };
33010
+ /** @enum {string} */
33011
+ "models.WorkflowRunOrigin": "automatic" | "manual";
33012
+ /** @enum {string} */
33013
+ "models.WorkflowSource": "user" | "config";
32950
33014
  "models.WorkflowStage": {
32951
33015
  /** @description Description explains what the stage does, for the catalog UI. */
32952
33016
  description?: string;
@@ -33049,14 +33113,36 @@ export interface components {
33049
33113
  vaultOverrideUri?: string;
33050
33114
  };
33051
33115
  "models.WorkflowTrigger": {
33052
- endAt?: string;
33053
- /** @description Selection is the set of devices/streams the workflow applies to. */
33054
- selection?: string;
33055
- /** @description StartAt and EndAt bound a daily time window (e.g. "08:00"/"18:00"). */
33056
- startAt?: string;
33057
- /** @description Weekdays restricts the workflow to the listed days of week. */
33058
- weekdays?: number[];
33116
+ /**
33117
+ * @description Devices restricts the automatic trigger to recordings from the listed
33118
+ * devices, matched by DeviceKey.Key. An empty list means every device is
33119
+ * eligible. Mirrors the alert device selection (see CustomAlert.DevicesList).
33120
+ */
33121
+ devices?: components["schemas"]["models.DeviceKey"][];
33122
+ /**
33123
+ * @description Surfaces lists the UI surfaces a manual trigger can be launched from
33124
+ * (manual). Ignored for automatic triggers.
33125
+ */
33126
+ surfaces?: components["schemas"]["models.WorkflowTriggerSurface"][];
33127
+ /**
33128
+ * @description Type is the activation mode. An empty Type is treated as
33129
+ * WorkflowTriggerAutomatic for backwards compatibility with triggers authored
33130
+ * before manual triggers existed.
33131
+ */
33132
+ type?: components["schemas"]["models.WorkflowTriggerType"];
33133
+ /**
33134
+ * @description WeeklySchedule bounds the automatic trigger to recurring weekly windows,
33135
+ * each with its own day, time segments and IANA Timezone. An empty schedule
33136
+ * means any time is eligible. Reuses the alert weekly-schedule shape so the
33137
+ * same editor and evaluation semantics apply. The Timezone on each entry is
33138
+ * the user's timezone captured when the schedule was authored.
33139
+ */
33140
+ weeklySchedule?: components["schemas"]["models.WeeklySchedule"][];
33059
33141
  };
33142
+ /** @enum {string} */
33143
+ "models.WorkflowTriggerSurface": "case" | "media";
33144
+ /** @enum {string} */
33145
+ "models.WorkflowTriggerType": "automatic" | "manual";
33060
33146
  "models.WorkflowUser": {
33061
33147
  organisationId?: string;
33062
33148
  storage?: components["schemas"]["models.Storage"];
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@uug-ai/models",
3
- "version": "1.6.7",
3
+ "version": "1.6.9",
4
4
  "description": "TypeScript type definitions for Go models",
5
5
  "main": "dist/types.js",
6
6
  "types": "dist/types.d.ts",