dazscript-framework 0.1.8 → 0.1.10

package/README.md

@@ -1 +1,93 @@
 # DazScript Framework
+
+The **DazScript Framework** is a TypeScript-based framework for writing Daz Studio scripts. It provides all the advantages of a typed language such as autocompletion, error checking, and method parameter documentation and hinting. The framework also includes a set of dialog helpers for rapid UI development.
+
+## Benefits
+
+- **Autocompletion:** Take advantage of IDE autocompletion for faster and more efficient script development.
+- **Error Checking:** Catch potential errors early in the development process with TypeScript's static analysis.
+- **Method Documentation & Hinting:** Get contextual documentation and hints for methods, classes, and parameters.
+
+## Features
+
+- TypeScript support with full IntelliSense.
+- A powerful set of decorators and helper methods for building interactive scripts.
+- Easy integration with Daz Studio for quick script deployment.
+
+## Installation
+
+To install the **DazScript Framework**, run the following command:
+
+```bash
+npm install dazscript-framework
+```
+
+## Setup
+
+After installing the package, you will need to configure a few files for your project.
+
+1. **babel.config.js**
+
+   Create the file and add the following content:
+
+   ```javascript
+   const sharedBabelConfig = require('dazscript-framework/babel');
+
+   module.exports = {
+     ...sharedBabelConfig,
+     presets: [...sharedBabelConfig.presets],
+     plugins: [...sharedBabelConfig.plugins],
+   };
+   ```
+
+2. **package.json**
+
+   Add the following scripts to your package.json:
+
+   ```json
+   "scripts": {
+       "prebuild": "npm run installer",
+       "build": "webpack --env outputPath=./out",
+       "postbuild": "npm run icons",
+       "watch": "webpack --env outputPath=./out --watch",
+       "icons": "copyfiles -u 1 src/**/*.png out/",
+       "installer": "node ./node_modules/dazscript-framework/dist/scripts/install-generator.js -p ./src/scripts -m /My Scripts"
+   }
+   ```
+
+3. **tsconfig.json**
+
+   Create the file and add the following content:
+
+   ```json
+   {
+     "extends": "./node_modules/dazscript-framework/tsconfig.json",
+     "compilerOptions": {
+       "baseUrl": "./",
+       "paths": {
+         "shared/*": ["src/shared/*"],
+         "@dst/*": ["node_modules/dazscript-types/*"],
+         "@dsf/*": ["node_modules/dazscript-framework/src/*"]
+       }
+     },
+     "include": ["node_modules/dazscript-types/**/*", "src/**/*"]
+   }
+   ```
+
+4. **webpack.config.js**
+   Create the file and add the following content:
+
+   ```javascript
+   const sharedWebpackConfig = require('dazscript-framework/webpack');
+
+   module.exports = (env, argv) => {
+     const sharedConfig = sharedWebpackConfig(env, argv);
+
+     return {
+       ...sharedConfig,
+       // You can override or add more customizations here if needed
+     };
+   };
+   ```
+
+## Usage

package/package.json

@@ -1,9 +1,17 @@
 {
   "name": "dazscript-framework",
-  "version": "0.1.8",
+  "version": "0.1.10",
   "author": "Freddy Diaz",
   "license": "MPL-2.0",
   "description": "",
+  "scripts": {
+    "prebuild": "npm run installer",
+    "build": "webpack --env outputPath=./out",
+    "postbuild": "npm run icons",
+    "watch": "webpack --env outputPath=./out --watch",
+    "icons": "copyfiles -u 1 src/**/*.png out/",
+    "installer": "node ./dist/scripts/install-generator.js -p ./src/samples -m /DazScriptFramework"
+  },
   "keywords": [
     "daz3d",
     "daz studio",
@@ -20,7 +28,7 @@
   },
   "files": [
     "tsconfig.json",
-    "webpack.config",
+    "webpack.config.js",
     "babel.config.js",
     "dist/**/*",
     "src/**/*"
@@ -53,5 +61,10 @@
     "typescript": "^5.2.2",
     "webpack": "^5.88.2",
     "webpack-cli": "^5.1.4"
+  },
+  "devDependencies": {
+    "@types/node": "^22.10.5",
+    "eslint": "^9.17.0",
+    "typescript": "^5.7.3"
   }
 }

package/src/Install.dsa.ts

@@ -0,0 +1,19 @@
+
+import { installCustomActions as install } from '@dsf/helpers/custom-action-helper';
+
+install([
+    {
+        "name": null,
+        "text": "Hello World",
+        "filePath": "samples/hello-world.dsa",
+        "menuPath": "/DazScriptFramework/samples",
+        "description": "hello-world"
+    },
+    {
+        "name": null,
+        "text": "Sample Dialog",
+        "filePath": "samples/sample-dialog.dsa",
+        "menuPath": "/DazScriptFramework/samples",
+        "description": "sample-dialog"
+    }
+]);

package/src/Uninstall.dsa.ts

@@ -0,0 +1,19 @@
+
+import { uninstallCustomActions as uninstall } from '@dsf/helpers/custom-action-helper';
+
+uninstall([
+    {
+        "name": null,
+        "text": "Hello World",
+        "filePath": "samples/hello-world.dsa",
+        "menuPath": "/DazScriptFramework/samples",
+        "description": "hello-world"
+    },
+    {
+        "name": null,
+        "text": "Sample Dialog",
+        "filePath": "samples/sample-dialog.dsa",
+        "menuPath": "/DazScriptFramework/samples",
+        "description": "sample-dialog"
+    }
+]);

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

@@ -74,7 +74,7 @@ export default class LineEditBuilder extends WidgetBuilderBase<DzLineEdit> {
         return this
     }
 
-    text(text_: string | Observable<string>): this {
+    value(text_: string | Observable<string>): this {
         if (typeof text_ === 'string') {
             this.widget.text = text_
         }

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

@@ -31,13 +31,25 @@ export class NodeSelectionComboBoxBuilder extends WidgetBuilderBase<DzNodeSelect
         return this
     }
 
-    bind(node: Observable<DzNode>): this {
+    value(node: Observable<DzNode>): this {
         this.widget.nodeSelectionChanged.scriptConnect(() => {
             node.value = this.widget.getSelectedNode()
         })
+        this.selected(node)
         return this
     }
 
+    changed(then: (node: DzNode) => void): this {
+        this.widget.nodeSelectionChanged.scriptConnect(() => {
+            then(this.widget.getSelectedNode())
+        })
+        return this
+    }
+
+    refresh(): void {
+        this.widget.update()
+    }
+
     build(then?: (comboBox: DzNodeSelectionComboBox) => void): DzNodeSelectionComboBox {
         return super.build()
     }

package/src/dialog/input-dialog.ts

@@ -23,6 +23,6 @@ export class InputDialog extends BasicDialog {
     protected build(): void {
         let add = this.add
 
-        add.edit().text(this.model.value$).validator(this.model.validator).focus()
+        add.edit().value(this.model.value$).validator(this.model.validator).focus()
     }
 }

package/src/samples/config.ts

@@ -0,0 +1,3 @@
+export const config = {
+    author: 'DazScriptFramework'
+}

package/src/samples/hello-world.dsa.ts

@@ -0,0 +1,13 @@
+import { debug } from '@dsf/common/log';
+import { action } from '@dsf/core/action-decorator';
+import { BaseScript } from '@dsf/core/base-script';
+import { info } from '@dsf/helpers/message-box-helper';
+
+@action({ text: 'Hello World' })
+class HelloWorldScript extends BaseScript {
+    protected run(): void {
+        debug('Hello World!');
+        info('Hello World!');
+    }
+}
+new HelloWorldScript().exec();

package/src/samples/sample-dialog.dsa.ts

@@ -0,0 +1,52 @@
+import { debug, dump } from '@dsf/common/log';
+import { action } from '@dsf/core/action-decorator';
+import { BaseScript } from '@dsf/core/base-script';
+import { error } from '@dsf/helpers/message-box-helper';
+import { getNodes, getSelectedNode } from '@dsf/helpers/scene-helper';
+import { SampleDialog, SampleDialogModel } from './sample-dialog';
+
+@action({ text: 'Sample Dialog' })
+class SampleDialogScript extends BaseScript {
+    protected run(): void {
+        let sceneNodes = getNodes()
+        let selectedNode = getSelectedNode()
+        if (!selectedNode) {
+            error('Please select a node.')
+            return
+        }
+
+        let model = new SampleDialogModel()
+        model.nodes$.value = sceneNodes
+
+        model.nodeLabel$.connect((label) => {
+            if (label === model.selectedNode$.value.getLabel()) return
+            model.selectedNode$.value.setLabel(label)
+            model.nodes$.value = getNodes()
+        })
+
+        let dialog = new SampleDialog(model)
+
+        model.selectedNode$.connect((node) => {
+            if (!node) return
+            debug(`Selected Node: ${node.getLabel()}`)
+            node.select(true)
+            model.nodeLabel$.value = node.getLabel()
+            model.showNode$.value = node.isVisible()
+            model.hideNode$.value = !node.isVisible()
+        })
+        dialog.onNodeVisibilityChanged = (node, visible) => {
+            node.setVisible(visible)
+        }
+
+        model.selectedNode$.value = selectedNode
+
+        if (!dialog.run()) {
+            debug(`Dialog Cancelled`)
+            return
+        }
+
+        debug(`Dialog Closed`)
+        dump(model)
+    }
+}
+new SampleDialogScript().exec();

package/src/samples/sample-dialog.ts

@@ -0,0 +1,49 @@
+import { BasicDialog } from '@dsf/dialog/basic-dialog';
+import { Observable } from '@dsf/lib/observable';
+import { AppSettings } from '@dsf/lib/settings';
+import { config } from './config';
+
+export class SampleDialogModel extends AppSettings {
+    constructor() {
+        super(`${config.author}/SampleDialog`);
+    }
+
+    selectedNode$ = new Observable<DzNode>()
+    nodes$ = new Observable<DzNode[]>()
+    nodeLabel$ = new Observable<string>()
+    showNode$ = new Observable<boolean>()
+    hideNode$ = new Observable<boolean>()
+}
+
+export class SampleDialog extends BasicDialog {
+    constructor(private readonly model: SampleDialogModel) {
+        super(`Sample Dialog`);
+    }
+
+    public onNodeChanged?: (node: DzNode) => void
+
+    public onNodeVisibilityChanged?: (node: DzNode, visible: boolean) => void
+
+    protected build(): void {
+        let add = this.add
+        let model = this.model
+        this.dialog.showAcceptButton(false)
+        this.dialog.setCancelButtonText(`Close`)
+
+        add.tab('General').build(() => {
+            add.group(`Selected Node`).build(() => {
+                add.nodeSelection().nodes(model.nodes$).value(model.selectedNode$)
+                add.horizontal((layout) => {
+                    add.label(`Label:`)
+                    layout.addSpacing(10)
+                    add.edit().value(model.nodeLabel$)
+                })
+
+                add.group(`Visibility`).horizontal().build(() => {
+                    add.radio(`Show`).value(model.showNode$).toolTip(`Show the selected node.`).toggled((checked) => { this.onNodeVisibilityChanged(model.selectedNode$.value, checked) })
+                    add.radio(`Hide`).value(model.hideNode$).toolTip(`Hide the selected node.`)
+                })
+            })
+        })
+    }
+}

package/src/shared/set-keyboard-shortcut.ts

@@ -63,14 +63,14 @@ class KeyboardShortcutDialog extends BasicDialog {
 
         add.group('Assign Keyboard Shortcut').build((layout) => {
             layout.spacing = 5
-            add.edit().text(model.actionLabel).readOnly(true)
+            add.edit().value(model.actionLabel).readOnly(true)
             add.comboEdit().focus().items([...letters, ...keys]).changed(this.key).edited(this.key)
             add.checkbox('Control').value(model.control)
             add.checkbox('Option / Alt').value(model.alt)
             add.checkbox('Shift').value(model.shift)
             add.checkbox('Command / Windows').value(model.windows)
             add.group('Shortcut:').style({ flat: true }).build(() => {
-                add.edit().text(model.shortcut).readOnly(true)
+                add.edit().value(model.shortcut).readOnly(true)
             })
         })
     }

package/webpack.config.js

@@ -0,0 +1,70 @@
+const path = require('path');
+const glob = require('glob');
+const TsconfigPathsPlugin = require('tsconfig-paths-webpack-plugin');
+
+module.exports = (env, argv) => {
+  const isFileSpecified = env && env.file;
+  const entryFiles = isFileSpecified
+    ? [`./src/${env.file}.dsa.ts`]
+    : glob.sync('./src/**/*.dsa.ts');
+
+  const outputPath =
+    env && env.outputPath
+      ? path.resolve(env.outputPath)
+      : path.resolve(__dirname, 'out');
+
+  return {
+    mode: 'production',
+    optimization: {
+      usedExports: true,
+    },
+    entry: entryFiles.reduce((acc, filePath) => {
+      const entry = filePath.replace('.dsa.ts', '').replace('src/', '');
+      acc[entry] = `./${filePath}`;
+      return acc;
+    }, {}),
+    module: {
+      rules: [
+        {
+          test: /\.ts$/,
+          use: [
+            {
+              loader: 'babel-loader',
+            },
+            {
+              loader: 'ts-loader',
+              options: {
+                allowTsInNodeModules: true,
+              },
+            },
+          ],
+          exclude: [
+            {
+              and: [path.resolve(__dirname, 'node_modules')],
+              not: [
+                path.resolve(__dirname, 'node_modules/dazscript-framework/src'),
+              ],
+            },
+          ],
+        },
+      ],
+    },
+    resolve: {
+      extensions: ['.ts'],
+      plugins: [new TsconfigPathsPlugin()],
+    },
+    output: {
+      filename: '[name].dsa',
+      path: outputPath,
+      environment: {
+        arrowFunction: false,
+        bigIntLiteral: false,
+        const: false,
+        destructuring: false,
+        dynamicImport: false,
+        forOf: true,
+        module: false,
+      },
+    },
+  };
+};