@uug-ai/models 1.6.7 → 1.6.8

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 +69 -7
  2. package/package.json +1 -1
package/dist/types.d.ts CHANGED
@@ -32744,7 +32744,21 @@ export interface components {
32744
32744
  name?: string;
32745
32745
  nodes?: components["schemas"]["models.WorkflowNode"][];
32746
32746
  organisation_id?: string;
32747
+ /**
32748
+ * @description Trigger is the legacy single-trigger field kept only so workflows persisted
32749
+ * before Triggers existed still decode (and are not silently dropped on
32750
+ * re-save). New code should read and write Triggers; call NormalizeTriggers to
32751
+ * fold any legacy value into Triggers.
32752
+ *
32753
+ * Deprecated: use Triggers.
32754
+ */
32747
32755
  trigger?: components["schemas"]["models.WorkflowTrigger"];
32756
+ /**
32757
+ * @description Triggers is the set of activation modes for this workflow. A workflow may
32758
+ * carry both an automatic and a manual trigger so it runs on its own for
32759
+ * matching recordings and can also be launched on demand from a surface.
32760
+ */
32761
+ triggers?: components["schemas"]["models.WorkflowTrigger"][];
32748
32762
  updated_at?: number;
32749
32763
  user_id?: string;
32750
32764
  username?: string;
@@ -32842,6 +32856,16 @@ export interface components {
32842
32856
  * disambiguate a dispatch from a result.
32843
32857
  */
32844
32858
  operation?: string;
32859
+ /**
32860
+ * @description Origin records how this run was opened — the run-side counterpart of the
32861
+ * Workflow's trigger Type. An automatic run was teed off the pipeline by
32862
+ * analysis for a matching recording; a manual run was launched on demand by a
32863
+ * user from a surface. The engine reads it to skip automatic selection/time
32864
+ * gating for on-demand runs; it is persisted so "all runs for a media key" can
32865
+ * be filtered by how they started. Empty is treated as automatic for runs
32866
+ * opened before origins existed.
32867
+ */
32868
+ origin?: components["schemas"]["models.WorkflowRunOrigin"];
32845
32869
  /**
32846
32870
  * @description Payload is the self-describing block envelope a delegated-ingest worker
32847
32871
  * hands back for the platform to persist: one or more typed blocks (e.g. a
@@ -32898,6 +32922,12 @@ export interface components {
32898
32922
  * is empty on the analysis hand-off — the run is keyed by Key until the
32899
32923
  * engine opens it — and set on every engine→worker dispatch. The persisted
32900
32924
  * identity is Id, so RunId itself is wire-only.
32925
+ *
32926
+ * It is never set by hand: MarshalJSON derives it from Id whenever a run that
32927
+ * has been opened (its _id is set) is serialized, so a producer only has to
32928
+ * stamp Id and the two representations can never drift. A run without an Id
32929
+ * yet (the analysis hand-off) keeps whatever RunId it was given (normally
32930
+ * empty, so runId is omitted).
32901
32931
  */
32902
32932
  runId?: string;
32903
32933
  /**
@@ -32912,6 +32942,14 @@ export interface components {
32912
32942
  * run's persisted state; a stage dispatched after a reload fetches via Storage.
32913
32943
  */
32914
32944
  signedUrl?: string;
32945
+ /**
32946
+ * @description SourceRef ties a manual run back to the thing it was launched from — e.g.
32947
+ * the case id when launched from a case surface — so sibling runs fanned out
32948
+ * from one user action (one seed per selected media key) can be grouped above
32949
+ * the run. Empty for automatic runs. It generalises to any run-grouping handle
32950
+ * (a case id today; a temporal device-series id is a forward-looking twin).
32951
+ */
32952
+ sourceRef?: string;
32915
32953
  /**
32916
32954
  * @description Storage carries the credentials a dispatched stage worker needs to fetch
32917
32955
  * the media (global Kerberos Storage plus any resolved per-recording vault
@@ -32947,6 +32985,8 @@ export interface components {
32947
32985
  */
32948
32986
  workflowName?: string;
32949
32987
  };
32988
+ /** @enum {string} */
32989
+ "models.WorkflowRunOrigin": "automatic" | "manual";
32950
32990
  "models.WorkflowStage": {
32951
32991
  /** @description Description explains what the stage does, for the catalog UI. */
32952
32992
  description?: string;
@@ -33049,14 +33089,36 @@ export interface components {
33049
33089
  vaultOverrideUri?: string;
33050
33090
  };
33051
33091
  "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[];
33092
+ /**
33093
+ * @description Devices restricts the automatic trigger to recordings from the listed
33094
+ * devices, matched by DeviceKey.Key. An empty list means every device is
33095
+ * eligible. Mirrors the alert device selection (see CustomAlert.DevicesList).
33096
+ */
33097
+ devices?: components["schemas"]["models.DeviceKey"][];
33098
+ /**
33099
+ * @description Surfaces lists the UI surfaces a manual trigger can be launched from
33100
+ * (manual). Ignored for automatic triggers.
33101
+ */
33102
+ surfaces?: components["schemas"]["models.WorkflowTriggerSurface"][];
33103
+ /**
33104
+ * @description Type is the activation mode. An empty Type is treated as
33105
+ * WorkflowTriggerAutomatic for backwards compatibility with triggers authored
33106
+ * before manual triggers existed.
33107
+ */
33108
+ type?: components["schemas"]["models.WorkflowTriggerType"];
33109
+ /**
33110
+ * @description WeeklySchedule bounds the automatic trigger to recurring weekly windows,
33111
+ * each with its own day, time segments and IANA Timezone. An empty schedule
33112
+ * means any time is eligible. Reuses the alert weekly-schedule shape so the
33113
+ * same editor and evaluation semantics apply. The Timezone on each entry is
33114
+ * the user's timezone captured when the schedule was authored.
33115
+ */
33116
+ weeklySchedule?: components["schemas"]["models.WeeklySchedule"][];
33059
33117
  };
33118
+ /** @enum {string} */
33119
+ "models.WorkflowTriggerSurface": "case" | "media";
33120
+ /** @enum {string} */
33121
+ "models.WorkflowTriggerType": "automatic" | "manual";
33060
33122
  "models.WorkflowUser": {
33061
33123
  organisationId?: string;
33062
33124
  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.8",
4
4
  "description": "TypeScript type definitions for Go models",
5
5
  "main": "dist/types.js",
6
6
  "types": "dist/types.d.ts",