terrier-engine 4.30.0 → 4.31.0

package/data-dive/dives/dive-editor.ts

@@ -20,7 +20,7 @@ import Arrays from "tuff-core/arrays"
 import {FormFields} from "tuff-core/forms"
 import Fragments from "../../terrier/fragments"
 import {DiveDeliveryForm} from "./dive-delivery"
-import {DivePlotsForm} from "./dive-plots"
+import {DivePlotsForm} from "../plots/dive-plots"
 
 const log = new Logger("DiveEditor")
 

package/data-dive/dives/dives.ts

@@ -4,7 +4,7 @@ import Db from "../dd-db"
 import DdSession from "../dd-session"
 import {FilterInput} from "../queries/filters"
 import Tables from "../queries/tables"
-import {SchemaDef} from "../../terrier/schema";
+import {SchemaDef} from "../../terrier/schema"
 
 
 ////////////////////////////////////////////////////////////////////////////////

package/data-dive/gen/models.ts

@@ -1,4 +1,4 @@
-// This file was automatically generated on 2024-05-16 13:17:01 -0500, DO NOT EDIT IT MANUALLY!
+// This file was automatically generated on 2024-07-17 13:26:00 -0500, DO NOT EDIT IT MANUALLY!
 
 import { Query } from "../queries/queries"
 
@@ -10,6 +10,8 @@ import { Attachment } from "../../terrier/attachments"
 
 import { RegularSchedule } from "../../terrier/schedules"
 
+import { DivePlotTrace, DivePlotLayout } from "../plots/dive-plots"
+
 import { OptionalProps } from "tuff-core/types"
 
 export type DdDive = {
@@ -31,6 +33,7 @@ export type DdDive = {
     sort_order?: number
     query_data?: { queries: Query[] }
     dive_types: string[]
+    delivery_mode?: string
     delivery_recipients?: string[]
     delivery_schedule?: RegularSchedule
     created_by?: DdUser
@@ -59,6 +62,7 @@ export type UnpersistedDdDive = {
     sort_order?: number
     query_data?: { queries: Query[] }
     dive_types: string[]
+    delivery_mode?: string
     delivery_recipients?: string[]
     delivery_schedule?: RegularSchedule
     created_by?: DdUser
@@ -114,6 +118,44 @@ export type UnpersistedDdDiveGroup = {
     dd_dives?: OptionalProps<UnpersistedDdDive, "dd_dive_group_id">[]
 }
 
+export type DdDivePlot = {
+    id: string
+    created_at: string
+    updated_at: string
+    _state: number
+    created_by_id?: string
+    created_by_name: string
+    extern_id?: string
+    updated_by_id?: string
+    updated_by_name?: string
+    title: string
+    traces: DivePlotTrace[]
+    layout: DivePlotLayout
+    dd_dive_id: string
+    created_by?: DdUser
+    updated_by?: DdUser
+    dd_dive?: DdDive
+}
+
+export type UnpersistedDdDivePlot = {
+    id?: string
+    created_at?: string
+    updated_at?: string
+    _state?: number
+    created_by_id?: string
+    created_by_name?: string
+    extern_id?: string
+    updated_by_id?: string
+    updated_by_name?: string
+    title: string
+    traces: DivePlotTrace[]
+    layout: DivePlotLayout
+    dd_dive_id: string
+    created_by?: DdUser
+    updated_by?: DdUser
+    dd_dive?: DdDive
+}
+
 export type DdDiveRun = {
     id: string
     created_at: string
@@ -170,6 +212,7 @@ export const DdDiveRunEnumFields = {
 export type PersistedModelTypeMap = {
     dd_dive: DdDive
     dd_dive_group: DdDiveGroup
+    dd_dive_plot: DdDivePlot
     dd_dive_run: DdDiveRun
 }
 
@@ -179,6 +222,7 @@ export type PersistedModelTypeMap = {
 export type UnpersistedModelTypeMap = {
     dd_dive: UnpersistedDdDive
     dd_dive_group: UnpersistedDdDiveGroup
+    dd_dive_plot: UnpersistedDdDivePlot
     dd_dive_run: UnpersistedDdDiveRun
 }
 
@@ -188,6 +232,7 @@ export type UnpersistedModelTypeMap = {
 export type ModelIncludesMap = {
     dd_dive: "created_by" | "dd_dive_group" | "dd_dive_runs" | "owner" | "updated_by"
     dd_dive_group: "created_by" | "dd_dives" | "updated_by"
+    dd_dive_plot: "created_by" | "dd_dive" | "updated_by"
     dd_dive_run: "created_by" | "dd_dive" | "updated_by"
 }
 

package/data-dive/plots/dive-plots.ts

@@ -0,0 +1,29 @@
+import TerrierFormPart from "../../terrier/parts/terrier-form-part"
+import {DiveEditorState} from "../dives/dive-editor"
+import {PartTag} from "tuff-core/parts"
+import {MarkerStyle, TraceStyle, TraceType, YAxisName} from "tuff-plot/trace"
+import {PlotLayout} from "tuff-plot/layout"
+
+
+export type DivePlotTrace = {
+    id: string
+    type: TraceType
+    title: string
+    query_id: string
+    x: string
+    y: string
+    y_axis: YAxisName
+    style?: TraceStyle
+    marker?: MarkerStyle
+}
+
+// maybe we'll add more in the future
+export type DivePlotLayout = PlotLayout
+
+
+export class DivePlotsForm extends TerrierFormPart<DiveEditorState> {
+    render(parent: PartTag): any {
+        parent.h3(".coming-soon.glyp-developer").text("Coming Soon")
+    }
+
+}

package/package.json

@@ -4,7 +4,7 @@
   "files": [
     "*"
   ],
-  "version": "4.30.0",
+  "version": "4.31.0",
   "repository": {
     "type": "git",
     "url": "https://github.com/Terrier-Tech/terrier-engine"
@@ -19,6 +19,7 @@
     "dayjs": "^1.11.7",
     "inflection": "^2.0.1",
     "tuff-core": "latest",
+    "tuff-plot": "^0.2.0",
     "tuff-sortable": "latest",
     "turbolinks": "^5.2.0"
   },

package/terrier/gen/badges.ts

@@ -1,4 +1,4 @@
-// This file was automatically generated, DO NOT EDIT IT MANUALLY!
+// This file was automatically generated on 2024-07-17 08:41:32 -0500, DO NOT EDIT IT MANUALLY!
 
 import * as inflection from "inflection"
 

package/terrier/list-viewer.ts

@@ -14,6 +14,7 @@ const log = new Logger('List Viewer')
 export type ListItem = {
     listId: string
     listClickable?: boolean
+    listClear?: boolean
     listStyle?: 'none' | 'panel' | 'header'
 }
 
@@ -35,6 +36,9 @@ class ListItemPart<T extends ListItem> extends Part<T> {
                 itemView.class('clickable')
                 itemView.emitClick(this.viewer.itemClickedKey, {listId: this.state.listId})
             }
+            else if (this.state.listClear) {
+                itemView.emitClick(this.viewer.clearCurrentKey)
+            }
             if (isCurrent) {
                 itemView.class('current')
             }
@@ -128,6 +132,7 @@ class SideContainerPart extends Part<{viewer: ListViewerPart<any>}> {
         }
         else {
             log.debug(`[SideContainerPart] No details part to render`)
+            this.viewer.renderEmptyDetails(parent)
         }
     }
 
@@ -156,8 +161,25 @@ export abstract class ListViewerPart<T extends ListItem> extends TerrierPart<any
     items: T[] = []
     itemPartMap: Record<string, ListItemPart<T>> = {}
 
+    /**
+     * Emit this key when a specific item is clicked.
+     */
     itemClickedKey = Messages.typedKey<ListItem>()
 
+    /**
+     * Emit this key to clear the current selection.
+     */
+    clearCurrentKey = Messages.untypedKey()
+
+    /**
+     * Clears the currently selected item.
+     */
+    clearCurrent() {
+        this.detailsContext?.clear()
+        this.detailsContext = undefined
+        this.dirty()
+    }
+
     /**
      * A message with this key gets emitted whenever the details are shown.
      */
@@ -175,6 +197,11 @@ export abstract class ListViewerPart<T extends ListItem> extends TerrierPart<any
             log.debug(`Clicked on list item ${m.data.listId}`, m)
             this.showDetails(m.data.listId)
         })
+
+        this.onClick(this.clearCurrentKey, m => {
+            log.debug(`Clicked clear key`, m)
+            this.clearCurrent()
+        })
     }
 
 
@@ -185,6 +212,13 @@ export abstract class ListViewerPart<T extends ListItem> extends TerrierPart<any
      */
     abstract fetchItems(): Promise<T[]>
 
+    /**
+     * Subclasses can override this to automatically load the first item in the list.
+     */
+    get shouldLoadFirstItem(): boolean {
+        return false
+    }
+
     /**
      * Fetches the items with `fetchItems()` and re-renders the list.
      */
@@ -215,7 +249,7 @@ export abstract class ListViewerPart<T extends ListItem> extends TerrierPart<any
             log.info(`Showing item specified in params: ${id}`)
             this.showDetails(id)
         }
-        else {
+        else if (this.shouldLoadFirstItem) {
             const firstClickable = this.items.filter(item => item.listClickable)[0]
             if (firstClickable) {
                 log.info(`Showing first clickable item`)
@@ -257,6 +291,14 @@ export abstract class ListViewerPart<T extends ListItem> extends TerrierPart<any
      */
     abstract renderDetails(context: ListViewerDetailsContext<T>): any
 
+    /**
+     * Subclasses should override this to render custom content when there's no item selected (and layout=side).
+     * @param parent
+     */
+    renderEmptyDetails(parent: PartTag) {
+        parent.div(".text-center").text("Nothing to see here")
+    }
+
 
     // Details
 

package/data-dive/dives/dive-plots.ts

@@ -1,11 +0,0 @@
-import TerrierFormPart from "../../terrier/parts/terrier-form-part"
-import {DiveEditorState} from "./dive-editor"
-import {PartTag} from "tuff-core/parts"
-
-
-export class DivePlotsForm extends TerrierFormPart<DiveEditorState> {
-    render(parent: PartTag): any {
-        parent.h3(".coming-soon.glyp-developer").text("Coming Soon")
-    }
-
-}