dazscript-framework 0.2.5 → 0.3.1

package/README.md

@@ -14,6 +14,8 @@ The **DazScript Framework** is a TypeScript-based framework for writing Daz Stud
 
 - TypeScript support with full IntelliSense.
 - A lightweight `action(...)` entrypoint plus helper methods for building interactive scripts.
+- A generated setup dialog for installing, updating, and removing custom action registrations.
+- Setup generation is fully automated from `action(...)` metadata, including menu path, toolbar, shortcut, description, grouping, icons, and bundle-based setup outputs.
 - Easy integration with Daz Studio for quick script deployment.
 
 ## Installation
@@ -65,9 +67,12 @@ export default defineConfig({
   outDir: './out',
   defaultMenuPath: '/MyScripts',
   appDataPath: 'YourName/my-project',
+  bundleName: 'My Project',
 });
 ```
 
+`bundleName` is optional display metadata for generated setup dialogs. If omitted, the dialog falls back to `Setup Scripts`. `dazscript init` now scaffolds it automatically from the project folder name.
+
 Built action outputs now use stable launcher shims by default:
 
 - `out/<script>.dsa` is the stable launcher registered with Daz Studio menus, toolbars, and shortcuts
@@ -129,7 +134,7 @@ Common `action(...)` parameters:
 - `toolbar`: the toolbar name used when the action should appear on a toolbar.
 - `group`: an optional grouping label used by Daz Studio for related actions.
 - `description`: a longer description for the action.
-- `bundle`: generates installer and uninstaller entries as a package bundle instead of a single action entry.
+- `bundle`: generates an additional setup script next to the action file. Use `true` for `Setup.dsa.ts` or a string for `Setup <bundle>.dsa.ts`.
 
 When an action is built, the framework emits two files for it:
 
@@ -140,6 +145,57 @@ Generated installers register the launcher path, so menu placement, toolbars, sh
 
 If the local `lib/` implementation is missing, the launcher falls back to the configured `appDataPath`. Builds now require this value and validate it as a unique `Author/Product` style path.
 
+### Generated Setup Script
+
+Running `npm run installer` generates `src/Setup.dsa.ts` for the project.
+
+This flow is completely automated. The installer generator scans runnable `.dsa.ts` entry files, reads the top-level `action(...)` call, and derives the setup dialog rows and registration behavior directly from that metadata. In practice, the menu path, toolbar target, shortcut, description, grouping, icon usage, and bundle-specific setup outputs all come from the action definition rather than from separate installer code you have to maintain by hand.
+
+The generated setup script:
+
+- Scans all runnable top-level `.dsa.ts` files under `scriptsPath`
+- Reads `action(...)` metadata directly from the source
+- Normalizes default menu paths relative to `defaultMenuPath`
+- Derives action labels, descriptions, shortcuts, toolbar targets, grouping, and icons from the action definition
+- Writes one searchable setup entry per discovered action
+- Uses `appDataPath/Installer` as the installer settings namespace
+- Passes `bundleName` through so the dialog title can be project-specific
+
+The setup dialog initializes from the current Daz Studio install state rather than assuming a clean install. It checks which actions are already installed, which ones are present in menus or toolbars, and what shortcut is currently assigned.
+
+Current setup dialog behavior:
+
+- Shows an install checkbox plus the columns `Action`, `Shortcut`, `Description`, `Menu`, and `Toolbar`
+- Includes a search box that filters by action name, shortcut, description, menu path, and toolbar
+- Supports `Select All` and `Deselect All` for the currently visible rows
+- Lets the user right-click an action to set a shortcut or reset it to the default shortcut
+- Shows shortcut overrides with an `[ovr]` marker
+- Displays the configured toolbar name directly instead of a generic yes/no flag
+- Uses the configured `bundleName` in the window title when available
+
+Applying the setup dialog does both install and cleanup work:
+
+- Selected rows are installed or updated through the framework custom action helpers
+- Unselected rows are removed from supported menu and toolbar targets
+- Affected toolbars are rebuilt after removal so remaining selected actions stay grouped correctly
+- Empty toolbars created by the framework are cleaned up automatically
+
+The generated project-level setup file replaces the older generated `Install.dsa.ts` and `Uninstall.dsa.ts` flow. The installer generator now removes those legacy files if they still exist.
+
+### Action-Level Bundles
+
+The `bundle` property on `action(...)` is separate from project `bundleName`.
+
+- `bundleName` in `dazscript.config.ts` is project metadata used for the setup dialog title
+- `bundle` in an action definition changes installer generation behavior for that action
+
+When `bundle` is set on an action, the installer generator also writes a setup script beside that action:
+
+- `bundle: true` writes `Setup.dsa.ts`
+- `bundle: 'Utilities'` writes `Setup Utilities.dsa.ts`
+
+Those bundle-generated setup files use the same setup dialog helper and now also receive the project `bundleName`.
+
 ### Building UIs with Observables & Dialogs
 
 The framework uses a **Model-View pattern** with reactive data bindings:

package/dist/scripts/app-data-path.js

@@ -0,0 +1,50 @@
+'use strict';
+
+function toPosix(filePath) {
+  return filePath.replace(/\\/g, '/');
+}
+
+function validateAppDataPath(appDataPath, workdir) {
+  if (!appDataPath || typeof appDataPath !== 'string') {
+    throw new Error(
+      `[dazscript] Missing required appDataPath in ${workdir}. ` +
+      `Set appDataPath: 'Author/Product' in dazscript.config.ts.`
+    );
+  }
+
+  const normalized = toPosix(appDataPath).trim().replace(/^\/+|\/+$/g, '');
+  const segments = normalized.split('/').filter(Boolean);
+
+  if (segments.length < 2) {
+    throw new Error(
+      `[dazscript] Invalid appDataPath "${appDataPath}" in ${workdir}. ` +
+      `Use at least two segments, for example 'Author/Product'.`
+    );
+  }
+
+  const blockedSegments = new Set([
+    'appdata',
+    'cache',
+    'data',
+    'lib',
+    'libs',
+    'script',
+    'scripts',
+    'temp',
+    'tmp',
+  ]);
+
+  const invalidSegment = segments.find((segment) => blockedSegments.has(segment.toLowerCase()));
+  if (invalidSegment) {
+    throw new Error(
+      `[dazscript] Invalid appDataPath "${appDataPath}" in ${workdir}. ` +
+      `Path segments like "${invalidSegment}" are too generic. Use a unique Author/Product path.`
+    );
+  }
+
+  return normalized;
+}
+
+module.exports = {
+  validateAppDataPath,
+};

package/dist/scripts/init.js

@@ -50,10 +50,19 @@ export default defineConfig({
   outDir: '${options.outDir}',
   defaultMenuPath: '${options.menuPath}',
   appDataPath: '${options.appDataPath}',
+  bundleName: '${options.bundleName}',
 });
 `;
 }
 
+function toBundleName(projectName) {
+  return projectName
+    .split(/[-_\s]+/)
+    .filter(Boolean)
+    .map((part) => part.charAt(0).toUpperCase() + part.slice(1))
+    .join(' ');
+}
+
 function buildTsconfigContent() {
   return `{
   "extends": "./node_modules/dazscript-framework/tsconfig.json",
@@ -102,6 +111,7 @@ function initProject(workdir, rawOptions) {
     scriptsPath: normalizePath(rawOptions.scriptsPath, './src'),
     outDir: normalizePath(rawOptions.outDir, './out'),
     appDataPath: normalizePath(rawOptions.appDataPath, `YourName/${projectName}`),
+    bundleName: toBundleName(projectName),
   };
 
   writeFileIfNeeded(

package/dist/scripts/install-generator.js

@@ -2,6 +2,8 @@ const ts = require('typescript');
 const fs = require('fs');
 const path = require('path');
 const glob = require('glob');
+const { loadConfig } = require('./config-loader');
+const { validateAppDataPath } = require('./app-data-path');
 
 const nameofActionFunction = 'action';
 
@@ -19,19 +21,14 @@ function stringOrDefault(str, defaultValue) {
   return str !== undefined && str !== null && str !== '' ? str : defaultValue;
 }
 
-function generateInstallerTemplate(data) {
+function generateInstallerTemplate(data, settingsPath, bundleName) {
   return `
-import { installCustomActions as install } from '@dsf/helpers/custom-action-helper';
+import { showSetupCustomActionsDialog as setup } from '@dsf/helpers/custom-action-installer-helper';
 
-install(${data});
-`;
-}
-
-function generateUninstallerTemplate(data) {
-  return `
-import { uninstallCustomActions as uninstall } from '@dsf/helpers/custom-action-helper';
-
-uninstall(${data});
+setup(${data}, ${JSON.stringify({
+    settingsPath,
+    bundleName,
+  })});
 `;
 }
 
@@ -154,7 +151,7 @@ function findActionEntryFiles(workdir, options) {
   });
 }
 
-function processScript(filePath, container, defaultMenuPath) {
+function processScript(filePath, container, defaultMenuPath, settingsPath, bundleName) {
   const fileInfo = path.parse(filePath);
   const content = fs.readFileSync(filePath, 'utf-8').toString();
   const actionCall = findTopLevelActionCall(content, filePath);
@@ -208,38 +205,29 @@ function processScript(filePath, container, defaultMenuPath) {
   container.scripts.push(script);
 
   if (decorator.bundle !== undefined) {
-    let packageInstallerFilePath = `Install.dsa.ts`;
-    let packageUninstallerFilePath = `Uninstall.dsa.ts`;
+    let packageSetupFilePath = `Setup.dsa.ts`;
 
     if (decorator.bundle !== true) {
-      packageInstallerFilePath = `Install ${decorator.bundle}.dsa.ts`;
-      packageUninstallerFilePath = `Uninstall ${decorator.bundle}.dsa.ts`;
+      packageSetupFilePath = `Setup ${decorator.bundle}.dsa.ts`;
     }
 
     let bundleScriptContent = generateInstallerTemplate(
-      JSON.stringify(container.scripts, null, 4)
+      JSON.stringify(container.scripts, null, 4),
+      settingsPath,
+      bundleName
     );
     let bundleScriptFilePath = path.join(
       path.parse(filePath).dir,
-      packageInstallerFilePath
-    );
-    fs.writeFileSync(bundleScriptFilePath, bundleScriptContent);
-
-    bundleScriptContent = generateUninstallerTemplate(
-      JSON.stringify(container.scripts, null, 4)
-    );
-    bundleScriptFilePath = path.join(
-      path.parse(filePath).dir,
-      packageUninstallerFilePath
+      packageSetupFilePath
     );
     fs.writeFileSync(bundleScriptFilePath, bundleScriptContent);
   }
 }
 
-function processScripts(paths, container, defaultMenuPath) {
+function processScripts(paths, container, defaultMenuPath, settingsPath, bundleName) {
   paths.forEach((filePath) => {
     console.log(`Processing ${filePath}`);
-    processScript(filePath, container, defaultMenuPath);
+    processScript(filePath, container, defaultMenuPath, settingsPath, bundleName);
   });
 }
 
@@ -247,10 +235,16 @@ function generateInstallerFiles(workdir, options) {
   const defaultMenuPath = options.defaultMenuPath.endsWith('/')
     ? options.defaultMenuPath
     : `${options.defaultMenuPath}/`;
+  const { config } = loadConfig(workdir);
+  const appDataPath = validateAppDataPath(options.appDataPath || config.appDataPath, workdir);
+  const settingsPath = `${appDataPath}/Installer`;
+  const bundleName = typeof config.bundleName === 'string' && config.bundleName.trim()
+    ? config.bundleName.trim()
+    : undefined;
   const container = { scripts: [] };
   const matches = findActionEntryFiles(workdir, options);
 
-  processScripts(matches, container, defaultMenuPath);
+  processScripts(matches, container, defaultMenuPath, settingsPath, bundleName);
 
   container.scripts = container.scripts.sort((a, b) => {
     const aKey = a.menuPath + a.filePath;
@@ -259,17 +253,16 @@ function generateInstallerFiles(workdir, options) {
   });
 
   const installerScriptContent = generateInstallerTemplate(
-    JSON.stringify(container.scripts, null, 4)
+    JSON.stringify(container.scripts, null, 4),
+    settingsPath,
+    bundleName
   );
-  fs.writeFileSync(path.join(workdir, 'src', 'Install.dsa.ts'), installerScriptContent);
+  fs.writeFileSync(path.join(workdir, 'src', 'Setup.dsa.ts'), installerScriptContent);
 
-  const uninstallerScriptContent = generateUninstallerTemplate(
-    JSON.stringify(container.scripts, null, 4)
-  );
-  fs.writeFileSync(
-    path.join(workdir, 'src', 'Uninstall.dsa.ts'),
-    uninstallerScriptContent
-  );
+  const installPath = path.join(workdir, 'src', 'Install.dsa.ts');
+  const uninstallPath = path.join(workdir, 'src', 'Uninstall.dsa.ts');
+  if (fs.existsSync(installPath)) fs.unlinkSync(installPath);
+  if (fs.existsSync(uninstallPath)) fs.unlinkSync(uninstallPath);
 }
 
 if (require.main === module) {
@@ -277,6 +270,7 @@ if (require.main === module) {
   const options = {
     scriptsPath: './src',
     defaultMenuPath: 'My Scripts',
+    appDataPath: undefined,
   };
 
   for (let index = 0; index < args.length; index += 1) {
@@ -294,6 +288,12 @@ if (require.main === module) {
       continue;
     }
 
+    if (arg === '--app-data-path') {
+      options.appDataPath = args[index + 1];
+      index += 1;
+      continue;
+    }
+
     throw new Error(`Unknown option: ${arg}`);
   }
 

package/dist/scripts/launchers.js

@@ -3,6 +3,7 @@
 const fs = require('fs');
 const path = require('path');
 const { findActionEntryFiles } = require('./install-generator');
+const { validateAppDataPath } = require('./app-data-path');
 
 function toPosix(filePath) {
   return filePath.replace(/\\/g, '/');
@@ -25,47 +26,6 @@ function getImplementationRelativePath(outputRelativePath) {
   return path.posix.join(implementationDirectory, 'script.dsa');
 }
 
-function validateAppDataPath(appDataPath, workdir) {
-  if (!appDataPath || typeof appDataPath !== 'string') {
-    throw new Error(
-      `[dazscript] Missing required appDataPath in ${workdir}. ` +
-      `Set appDataPath: 'Author/Product' in dazscript.config.ts.`
-    );
-  }
-
-  const normalized = toPosix(appDataPath).trim().replace(/^\/+|\/+$/g, '');
-  const segments = normalized.split('/').filter(Boolean);
-
-  if (segments.length < 2) {
-    throw new Error(
-      `[dazscript] Invalid appDataPath "${appDataPath}" in ${workdir}. ` +
-      `Use at least two segments, for example 'Author/Product'.`
-    );
-  }
-
-  const blockedSegments = new Set([
-    'appdata',
-    'cache',
-    'data',
-    'lib',
-    'libs',
-    'script',
-    'scripts',
-    'temp',
-    'tmp',
-  ]);
-
-  const invalidSegment = segments.find((segment) => blockedSegments.has(segment.toLowerCase()));
-  if (invalidSegment) {
-    throw new Error(
-      `[dazscript] Invalid appDataPath "${appDataPath}" in ${workdir}. ` +
-      `Path segments like "${invalidSegment}" are too generic. Use a unique Author/Product path.`
-    );
-  }
-
-  return normalized;
-}
-
 function makeLauncherSource(implementationRelativePath, appDataImplementationRelativePath) {
   return [
     '// Auto-generated launcher shim.',
@@ -158,5 +118,4 @@ function createActionLaunchers(workdir, options) {
 
 module.exports = {
   createActionLaunchers,
-  validateAppDataPath,
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "dazscript-framework",
-  "version": "0.2.5",
+  "version": "0.3.1",
   "author": "Freddy Diaz",
   "license": "MPL-2.0",
   "description": "",
@@ -67,6 +67,7 @@
   },
   "devDependencies": {
     "@types/node": "^22.10.5",
+    "dazscript-types": "^0.2.4",
     "eslint": "^9.17.0",
     "typescript": "^5.7.3"
   }

package/src/{Install.dsa.ts → Setup.dsa.ts}

@@ -1,7 +1,7 @@
 
-import { installCustomActions as install } from '@dsf/helpers/custom-action-helper';
+import { showSetupCustomActionsDialog as setup } from '@dsf/helpers/custom-action-installer-helper';
 
-install([
+setup([
     {
         "name": null,
         "text": "Hello World",
@@ -16,4 +16,4 @@ install([
         "menuPath": "/DazScriptFramework/samples",
         "description": "sample-dialog"
     }
-]);
+], {"settingsPath":"DazScriptFramework/samples/Installer","bundleName":"Samples"});

package/src/helpers/action-helper.ts

@@ -37,7 +37,7 @@ const shortcutTokenMap: { [key: string]: string } = {
     'DOWN': 'Down',
 }
 
-const normalizeShortcut = (shortcut: string): string => {
+export const normalizeShortcut = (shortcut: string): string => {
     if (!shortcut) return ''
 
     return shortcut
@@ -53,6 +53,19 @@ const normalizeShortcut = (shortcut: string): string => {
         .join('+')
 }
 
+export const getActionShortcut = (name: string): string => {
+    const action = findAction(name)
+    if (!action) return ''
+
+    if (isCustomAction(action)) {
+        const index = actionMgr.findCustomAction(name)
+        if (index < 0) return ''
+        return normalizeShortcut(String(actionMgr.getCustomActionShortcut(index) ?? '').trim())
+    }
+
+    return normalizeShortcut(String(action.shortcut?.toString() ?? '').trim())
+}
+
 type ActionShortcutEntry = {
     action: DzAction
     shortcut: string