dazscript-framework 1.0.9 → 1.0.11

package/README.md

@@ -302,8 +302,9 @@ Custom action icons are selected from `action(...)` metadata and sibling image f
 Setup dialog header assets are optional and are discovered beside `src/Setup.dsa.ts`:
 
 1. `src/Setup.header.png`
-2. `src/Setup.png`
-3. `src/Setup.dsa.png` legacy fallback
+2. `src/Setup.tip.png`
+3. `src/Setup.png`
+4. `src/Setup.dsa.png` legacy fallback
 
 Header text can be placed in `src/Setup.header.html`, `src/Setup.header.md`, or `src/Setup.header.txt`, with `src/Setup.html`, `src/Setup.md`, and `src/Setup.txt` as script-named fallbacks. The installer generator embeds that text into `Setup.dsa.ts`, so Daz Studio does not need to read the text file at setup time. The setup dialog renders the header body with `DzTextBrowser` rich text support; no Markdown conversion is performed. The image remains a deployed PNG asset and is resolved relative to the generated setup script at runtime.
 

package/dist/scripts/install-generator.js

@@ -279,6 +279,7 @@ function toPosix(filePath) {
 function resolveSetupHeaderImage(workdir) {
   const candidates = [
     path.join(workdir, 'src', 'Setup.header.png'),
+    path.join(workdir, 'src', 'Setup.tip.png'),
     path.join(workdir, 'src', 'Setup.png'),
     path.join(workdir, 'src', 'Setup.dsa.png'),
   ];

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "dazscript-framework",
-  "version": "1.0.9",
+  "version": "1.0.11",
   "author": "Freddy Diaz",
   "license": "MPL-2.0",
   "description": "",

package/src/dialog/builders/dialog-builder.ts

@@ -30,11 +30,17 @@ export class DialogBuilder extends WidgetsBuilder {
     private resize() {
         let dialogWidget = this.context.dialog.getWidget();
         let sizeHint = dialogWidget.minimumSizeHint;
+        let maxHeight = this.properties.maxHeight;
         let height = this.properties.height ?? sizeHint.height;
-        this.context.dialog.minHeight = sizeHint.height;
+        if (maxHeight !== undefined && height > maxHeight) height = maxHeight;
+        this.context.dialog.minHeight = maxHeight !== undefined
+            ? Math.min(sizeHint.height, maxHeight)
+            : sizeHint.height;
         this.context.dialog.height = height;
 
         if (this.properties.width) this.context.dialog.width = this.properties.width;
+        if (this.properties.maxWidth !== undefined) this.context.dialog.maxWidth = this.properties.maxWidth;
+        if (maxHeight !== undefined) this.context.dialog.maxHeight = maxHeight;
 
         if (this.properties.resizable === true) {
             this.context.dialog.sizeGripEnabled = true;

package/src/dialog/builders/dialog-header-builder.ts

@@ -1,6 +1,7 @@
 import LayoutBuilder from './layout-builder'
 import { createWidget } from './widget-builder'
 import { WidgetBuilderContext } from './widgets-builder'
+import { getScriptPath } from '@dsf/helpers/script-helper'
 
 export type DialogHeaderOptions = {
     image?: Pixmap
@@ -20,13 +21,21 @@ const escapeHtml = (value: string): string =>
         .replace(/'/g, ''')
         .replace(/\r?\n/g, '<br>')
 
+const resolveImagePath = (filePath: string): string => {
+    const value = String(filePath ?? '').replace(/\\/g, '/')
+    if (!value) return ''
+    if (value.indexOf(':') >= 0 || value.charAt(0) === '/') return value
+
+    return `${getScriptPath()}/${value.replace(/^\.\//, '')}`
+}
+
 export class DialogHeaderBuilder {
     constructor(
         private readonly context: WidgetBuilderContext,
         private readonly options: DialogHeaderOptions
     ) { }
 
-    build(): DzHBoxLayout {
+    build(): DzWidget {
         const height = this.options.height ?? 96
         const imageWidth = this.options.imageWidth ?? height
         const html = this.options.html ?? (
@@ -35,18 +44,23 @@ export class DialogHeaderBuilder {
                 : ''
         )
 
-        return LayoutBuilder
-            .create(this.context)
-            .direction('horizontal')
-            .build(() => {
-                this.buildImage(height, imageWidth)
-                this.buildText(html, height)
-            }) as DzHBoxLayout
+        return createWidget(this.context).build(DzWidget, (container) => {
+            container.setFixedHeight(height)
+
+            LayoutBuilder
+                .create(this.context)
+                .parent(container)
+                .direction('horizontal')
+                .build(() => {
+                    this.buildImage(height, imageWidth)
+                    this.buildText(html, height)
+                })
+        })
     }
 
     private buildImage(height: number, imageWidth: number): void {
         const pixmap = this.options.image ?? (
-            this.options.imagePath ? new Pixmap(this.options.imagePath) : null
+            this.options.imagePath ? new Pixmap(resolveImagePath(this.options.imagePath)) : null
         )
         if (!pixmap) return
 

package/src/dialog/builders/groupbox-builder.ts

@@ -13,6 +13,7 @@ export default class GroupBoxBuilder implements IWidgetBuilder<DzGroupBox> {
     private _columns: number = 1
     private _height: number | null = null
     private _minHeight: number | null = null
+    private _maxHeight: number | null = null
 
     constructor(private context: WidgetBuilderContext) {
     }
@@ -73,6 +74,11 @@ export default class GroupBoxBuilder implements IWidgetBuilder<DzGroupBox> {
         return this
     }
 
+    maxHeight(value: number): this {
+        this._maxHeight = value
+        return this
+    }
+
     columns(value: number): this {
         this._columns = value
         return this
@@ -86,6 +92,7 @@ export default class GroupBoxBuilder implements IWidgetBuilder<DzGroupBox> {
         groupBox.columns = this._columns
         if (this._height !== null) groupBox.height = this._height
         if (this._minHeight !== null) groupBox.minHeight = this._minHeight
+        if (this._maxHeight !== null) groupBox.maxHeight = this._maxHeight
 
         this._title?.connect((text) => {
             groupBox.title = text

package/src/dialog/builders/list-view-builder.ts

@@ -44,6 +44,11 @@ export class ListViewBuilder<TItem, TData> implements IWidgetBuilder<DzListView>
         return this
     }
 
+    maxHeight(value: number): this {
+        this.context.maxHeight = value
+        return this
+    }
+
     /**
      * Binds the list rows to a collection of items
      * @param items
@@ -135,6 +140,7 @@ class ListViewBuilderContext<TItem, TData> {
     visible: Observable<boolean> = new Observable(true)
     height: number | null = null
     minHeight: number | null = null
+    maxHeight: number | null = null
     decorated: boolean
     flat: Observable<boolean>
     refreshWhat: ListViewRefreshOptions = ListViewRefreshOptions.All
@@ -228,6 +234,10 @@ const build = <TItem, TData>(context: ListViewBuilderContext<TItem, TData>): DzL
         listView.minHeight = context.minHeight
     }
 
+    if (context.maxHeight !== null) {
+        listView.maxHeight = context.maxHeight
+    }
+
     const buildColumns = (columns: string[]) => {
         clearColumns(listView)
         columns.forEach(column => {
@@ -320,22 +330,44 @@ const build = <TItem, TData>(context: ListViewBuilderContext<TItem, TData>): DzL
             existingByPath[path] = li
         })
 
+        const itemKey = (item: TreeNode<TItem>) => {
+            const data = context.data?.(item) as any
+            return data?.id ?? item.path
+        }
+
         const incomingPaths: Record<string, boolean> = {}
-        items.forEach((item) => {
-            incomingPaths[item.path] = true
-            const existing = existingByPath[item.path]
+        const markIncoming = (item: TreeNode<TItem>) => {
+            incomingPaths[itemKey(item)] = true
+            item.children.forEach(markIncoming)
+        }
+        items.forEach(markIncoming)
+
+        const updateItem = (item: TreeNode<TItem>, parent: DzListView | DzListViewItem) => {
+            const key = itemKey(item)
+            const existing = existingByPath[key]
             if (existing) {
                 context.text(item).forEach((text, idx) => {
+                    if (idx >= context.columns.value.length) return
                     existing.setText(idx, text ?? '')
                 })
                 const data = context.data?.(item)
                 if (data) setDataItem(existing, data)
+                item.children.forEach((child) => {
+                    updateItem(child, context.flat?.value === true ? listView : existing)
+                })
             } else {
-                buildItem(item, listView)
+                buildItem(item, parent)
             }
-        })
-
-        listView.getItems(DzListView.All).forEach((li) => {
+        }
+        items.forEach((item) => updateItem(item, listView))
+
+        listView.getItems(DzListView.All).sort((left, right) => {
+            const leftData = getDataItem<any>(left)
+            const rightData = getDataItem<any>(right)
+            const leftPath = leftData?.id ?? String(left.id)
+            const rightPath = rightData?.id ?? String(right.id)
+            return rightPath.length - leftPath.length
+        }).forEach((li) => {
             const data = getDataItem<any>(li)
             const path = data?.id ?? String(li.id)
             if (!incomingPaths[path]) listView.deleteItem(li)

package/src/dialog/builders/tab-builder.ts

@@ -11,6 +11,7 @@ export class TabBuilder implements IWidgetBuilder<DzTabWidget> {
     private currentChanged: (index: number) => void;
     private height_: number | null = null;
     private minHeight_: number | null = null;
+    private maxHeight_: number | null = null;
 
     constructor(private layoutBuilder: LayoutBuilder, private context: TabBuilderContext) {
     }
@@ -32,6 +33,11 @@ export class TabBuilder implements IWidgetBuilder<DzTabWidget> {
         return this
     }
 
+    maxHeight(value: number): this {
+        this.maxHeight_ = value
+        return this
+    }
+
     static create(context: TabBuilderContext): TabBuilder {
         return new TabBuilder(new LayoutBuilder(context.widgetContext), context)
     }
@@ -65,6 +71,7 @@ export class TabBuilder implements IWidgetBuilder<DzTabWidget> {
         return this.context.add((tabWidget) => {
             if (this.height_ !== null) tabWidget.height = this.height_
             if (this.minHeight_ !== null) tabWidget.minHeight = this.minHeight_
+            if (this.maxHeight_ !== null) tabWidget.maxHeight = this.maxHeight_
             let tab = new DzWidget(this.context.widgetContext.dialog)
             tabWidget.addTab(tab, this.titleText)
             this.context.widgetContext.layout.addWidget(tabWidget)

package/src/dialog/builders/widget-builder.ts

@@ -77,6 +77,11 @@ export abstract class WidgetBuilderBase<T extends DzWidget> implements IWidgetBu
         return this
     }
 
+    maxHeight(value: number): this {
+        this.widget.maxHeight = value
+        return this
+    }
+
     build(): T {
         return this.widget
     }
@@ -86,6 +91,7 @@ export interface IWidgetBuilder<T extends DzWidget> {
     visible(value: boolean | Observable<boolean>): this
     height(value: number): this
     minHeight(value: number): this
+    maxHeight(value: number): this
     build(): T
 }
 

package/src/dialog/shared.ts

@@ -4,5 +4,7 @@ export type Direction = 'vertical' | 'horizontal';
 export class DialogProperties {
     width?: number;
     height?: number;
+    maxWidth?: number;
+    maxHeight?: number;
     resizable?: boolean;
 }

package/src/scripts/install-generator.test.ts

@@ -113,11 +113,25 @@ describe('install generator setup header', () => {
         const projectDir = makeProject()
         writeScript(projectDir, 'render-tools')
         writePng(projectDir, 'Setup.header.png')
+        writePng(projectDir, 'Setup.tip.png')
         writePng(projectDir, 'Setup.png')
 
         const setup = generateSetup(projectDir)
 
         expect(setup).toContain('"headerImagePath":"./Setup.header.png"')
+        expect(setup).not.toContain('"headerImagePath":"./Setup.tip.png"')
+        expect(setup).not.toContain('"headerImagePath":"./Setup.png"')
+    })
+
+    it('uses the setup tip image before the generic setup image', () => {
+        const projectDir = makeProject()
+        writeScript(projectDir, 'render-tools')
+        writePng(projectDir, 'Setup.tip.png')
+        writePng(projectDir, 'Setup.png')
+
+        const setup = generateSetup(projectDir)
+
+        expect(setup).toContain('"headerImagePath":"./Setup.tip.png"')
         expect(setup).not.toContain('"headerImagePath":"./Setup.png"')
     })