terrier-engine 4.32.0 → 4.32.1

package/data-dive/gen/models.ts

@@ -1,4 +1,4 @@
-// This file was automatically generated on 2024-07-17 13:26:00 -0500, DO NOT EDIT IT MANUALLY!
+// This file was automatically generated on 2024-07-25 17:02:53 -0500, DO NOT EDIT IT MANUALLY!
 
 import { Query } from "../queries/queries"
 
@@ -171,6 +171,7 @@ export type DdDiveRun = {
     output_data?: object
     output_file_data?: Attachment | { path: string }
     status: "initial" | "running" | "success" | "error"
+    delivery_mode?: string
     delivery_recipients?: string[]
     delivery_data?: object
     created_by?: DdUser
@@ -194,6 +195,7 @@ export type UnpersistedDdDiveRun = {
     output_data?: object
     output_file_data?: Attachment | { path: string }
     status: "initial" | "running" | "success" | "error"
+    delivery_mode?: string
     delivery_recipients?: string[]
     delivery_data?: object
     created_by?: DdUser

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

@@ -0,0 +1,62 @@
+import {AxisType} from "tuff-plot/axis"
+import {TerrierFormFields} from "../../terrier/forms"
+import {PartTag} from "tuff-core/parts"
+import TerrierPart from "../../terrier/parts/terrier-part"
+import {DbErrors} from "../../terrier/db-client"
+import * as inflection from "inflection"
+
+
+// let's not worry about a top axis for now
+const axisSides = ['left', 'bottom', 'right'] as const
+export type AxisSide = typeof axisSides[number]
+
+export type DivePlotAxisType = AxisType | 'none'
+
+export type DivePlotAxis = {
+    type: DivePlotAxisType
+    title: string
+}
+
+const axisTypeOptions = [
+    {value: 'none', title: 'None'},
+    {value: 'number', title: 'Number'},
+    {value: 'time', title: 'Date/Time'},
+    {value: 'group', title: 'Grouped Bars'},
+    {value: 'stack', title: 'Stacked Bars'},
+]
+
+export class DivePlotAxisFields extends TerrierFormFields<DivePlotAxis> {
+
+    constructor(part: TerrierPart<any>, axis: DivePlotAxis, readonly side: AxisSide, errors?: DbErrors<DivePlotAxis>) {
+        super(part, axis, errors)
+    }
+
+    render(parent: PartTag) {
+        parent.div(`.dd-dive-plot-axis-fields.tt-form.shrink.${this.side}`, container => {
+            container.div('.side').text(`${inflection.titleize(this.side)} Axis:`)
+
+            // title
+            this.textInput(container, "title", {placeholder: "Title"})
+
+            // type
+            const typeDir = this.side == 'bottom' ? 'row' : 'column'
+            container.div(`.tt-flex.wrapped.small-gap.${typeDir}`, flex => {
+                axisTypeOptions.forEach(option => {
+                    if ((this.side == 'bottom' || this.side == 'left') && option.value == 'none') {
+                        return // don't let them not have a bottom or left axis
+                    }
+                    flex.label(".caption-size", label => {
+                        this.radio(label, 'type', option.value)
+                        label.span().text(option.title)
+                    })
+                })
+            })
+        })
+    }
+}
+
+
+const DivePlotAxes = {
+    axisSides
+}
+export default DivePlotAxes

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

@@ -3,12 +3,13 @@ import {ModalPart} from "../../terrier/modals"
 import {DiveEditorState} from "../dives/dive-editor"
 import {UnpersistedDdDivePlot} from "../gen/models"
 import {TerrierFormFields} from "../../terrier/forms"
-import {DivePlotTrace} from "./dive-plots"
 import Messages from "tuff-core/messages"
 import {Logger} from "tuff-core/logging"
 import DivePlotList from "./dive-plot-list"
 import Db from "../dd-db"
 import DivePlotRenderPart from "./dive-plot-render-part"
+import {DivePlotAxis, DivePlotAxisFields} from "./dive-plot-axes"
+import {DivePlotTrace} from "./dive-plot-trace"
 
 const log = new Logger("DivePlotList")
 
@@ -16,12 +17,13 @@ export type DivePlotEditorState = DiveEditorState & {
     plot: UnpersistedDdDivePlot
 }
 
-
-
 export default class DivePlotEditor extends ModalPart<DivePlotEditorState> {
 
     plot!: UnpersistedDdDivePlot
     fields!: TerrierFormFields<UnpersistedDdDivePlot>
+    leftAxisFields!: DivePlotAxisFields
+    rightAxisFields!: DivePlotAxisFields
+    bottomAxisFields!: DivePlotAxisFields
     traces: DivePlotTrace[] = []
     renderPart!: DivePlotRenderPart
     saveKey = Messages.untypedKey()
@@ -39,6 +41,15 @@ export default class DivePlotEditor extends ModalPart<DivePlotEditorState> {
 
         this.fields = new TerrierFormFields<UnpersistedDdDivePlot>(this, this.plot)
 
+        // axis fields
+        const axes = this.plot.layout.axes || {}
+        const leftAxis: DivePlotAxis = axes['left'] || {type: 'number', title: ''}
+        this.leftAxisFields = new DivePlotAxisFields(this, leftAxis, 'left')
+        const rightAxis: DivePlotAxis = axes['right'] || {type: 'none', title: ''}
+        this.rightAxisFields = new DivePlotAxisFields(this, rightAxis, 'right')
+        const bottomAxis: DivePlotAxis = axes['bottom'] || {type: 'number', title: ''}
+        this.bottomAxisFields = new DivePlotAxisFields(this, bottomAxis, 'bottom')
+
         this.traces = this.plot.traces || []
 
         this.renderPart = this.makePart(DivePlotRenderPart, this.state)
@@ -57,12 +68,20 @@ export default class DivePlotEditor extends ModalPart<DivePlotEditorState> {
 
     renderContent(parent: PartTag): void {
         parent.div(".tt-flex.column.padded.gap", mainColumn => {
-            this.fields.compoundField(mainColumn, field => {
-                field.label(".required").text("Title")
-                this.fields.textInput(field, 'title')
+
+            mainColumn.div(".dd-plot-axes-and-preview.tt-flex.column.gap", axesAndPreview => {
+                this.fields.compoundField(axesAndPreview, field => {
+                    field.label(".required").text("Title")
+                    this.fields.textInput(field, 'title', {class: 'shrink plot-title'})
+                }).class('plot-title-field')
+                axesAndPreview.div('.tt-flex.gap', row => {
+                    this.leftAxisFields.render(row)
+                    row.part(this.renderPart)
+                    this.rightAxisFields.render(row)
+                })
+                this.bottomAxisFields.render(axesAndPreview)
             })
 
-            mainColumn.part(this.renderPart)
 
             mainColumn.h3(".glyp-items").text("Traces")
 
@@ -72,6 +91,13 @@ export default class DivePlotEditor extends ModalPart<DivePlotEditorState> {
     async save() {
         const plotData = await this.fields.serialize()
         const plot = {...this.plot, title: plotData.title}
+
+        plot.layout.axes = {
+            left: await this.leftAxisFields.serialize(),
+            bottom: await this.bottomAxisFields.serialize(),
+            right: await this.rightAxisFields.serialize()
+        }
+
         log.info("Saving plot", plot)
 
         const res = await Db().upsert('dd_dive_plot', plot)

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

@@ -0,0 +1,16 @@
+import {MarkerStyle, TraceStyle, TraceType, YAxisName} from "tuff-plot/trace";
+
+/**
+ * Similar to the tuff-plot Trace but not strongly typed to the data type since it's dynamically assigned to a query.
+ */
+export type DivePlotTrace = {
+    id: string
+    type: TraceType
+    title: string
+    query_id: string
+    x: string
+    y: string
+    y_axis: YAxisName
+    style?: TraceStyle
+    marker?: MarkerStyle
+}

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

@@ -1,27 +1,19 @@
-
-import {MarkerStyle, TraceStyle, TraceType, YAxisName} from "tuff-plot/trace"
-import {PlotLayout} from "tuff-plot/layout"
 import {DdDive, DdDivePlot} from "../gen/models"
 import Db from "../dd-db"
+import {DivePlotAxis} from "./dive-plot-axes"
 
-/**
- * Similar to the tuff-plot Trace but not strongly typed to the data type since it's dynamically assigned to a query.
- */
-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
+// mimic PlotLayout but with our own types
+export type DivePlotLayout = {
+    pad?: number
+    axes?: {
+        left?: DivePlotAxis
+        top?: DivePlotAxis
+        right?: DivePlotAxis
+        bottom?: DivePlotAxis
+    }
 
+}
 /**
  * Get all plots for the given dive.
  * @param dive

package/package.json

@@ -4,7 +4,7 @@
   "files": [
     "*"
   ],
-  "version": "4.32.0",
+  "version": "4.32.1",
   "repository": {
     "type": "git",
     "url": "https://github.com/Terrier-Tech/terrier-engine"

package/terrier/forms.ts

@@ -150,7 +150,7 @@ export class TerrierFormFields<T extends FormPartData> extends FormFields<T> {
      * @param fun a function that accepts the field as an argument, to actually populate the field
      */
     compoundField(parent: PartTag, fun: (field: DivTag) => any) {
-        parent.div(".tt-compound-field", field => {
+        return parent.div(".tt-compound-field", field => {
             fun(field)
         })
     }

package/terrier/parts/page-part.ts

@@ -150,8 +150,6 @@ export default abstract class PagePart<TState> extends ContentPart<TState> {
         if (!this._breadcrumbs.length && !this._title?.length) return
 
         parent.h1('.breadcrumbs', h1 => {
-            const crumbs = Array.from(this._breadcrumbs)
-
             // add a breadcrumb for the page title
             if (this._title?.length) {
                 const titleCrumb: Action = {
@@ -164,10 +162,10 @@ export default abstract class PagePart<TState> extends ContentPart<TState> {
                 if (this._titleClasses?.length) {
                     titleCrumb.classes = this._titleClasses
                 }
-                crumbs.push(titleCrumb)
+                this.addBreadcrumb(titleCrumb)
             }
 
-            this.app.theme.renderActions(h1, crumbs)
+            this.app.theme.renderActions(h1, Array.from(this._breadcrumbs))
         })
     }