dazscript-framework 1.0.6 → 1.0.7

package/README.md

@@ -238,6 +238,7 @@ action({ text: 'My Script' }, MyScript);
 | `toolbar` | Toolbar name the action should appear on |
 | `group` | Grouping label for related actions in Daz Studio |
 | `description` | Longer description for the action |
+| `icon` | Image path used for the installed custom action. Overrides discovered icon files. |
 | `bundle` | Generates a setup script beside the action. `true` → `Setup.dsa.ts`, a string → `Setup <name>.dsa.ts` |
 
 ---
@@ -289,6 +290,15 @@ Applying the dialog:
 - Affected toolbars are rebuilt; empty framework-created toolbars are removed
 - Selected keyboard shortcut rows are applied after actions are installed
 
+Custom action icons are selected from `action(...)` metadata and sibling image files in this order:
+
+1. Explicit `action({ icon: '...' })`
+2. `scriptname.action.png`
+3. `scriptname.png`
+4. `scriptname.dsa.png` legacy fallback
+
+`scriptname.action.png` is the installed custom action icon. Daz Studio uses the same action icon for menu and toolbar placements. `scriptname.png` is the preferred script/content icon fallback. `scriptname.dsa.png` is a legacy fallback kept for older projects and will be removed in a future breaking release.
+
 This replaces the older `Install.dsa.ts` / `Uninstall.dsa.ts` pattern. The installer generator removes those legacy files if they exist.
 
 ### Setup Keyboard Shortcuts

package/dist/scripts/install-generator.js

@@ -21,6 +21,54 @@ function stringOrDefault(str, defaultValue) {
   return str !== undefined && str !== null && str !== '' ? str : defaultValue;
 }
 
+function replaceEntrySourceSuffix(filePath, suffix) {
+  if (filePath.endsWith('.dsa.ts')) {
+    return `${filePath.slice(0, -'.dsa.ts'.length)}${suffix}`;
+  }
+
+  return filePath.replace(/\.ts$/, suffix);
+}
+
+function replaceEntryOutputSuffix(filePath, suffix) {
+  if (filePath.endsWith('.dsa')) {
+    return `${filePath.slice(0, -'.dsa'.length)}${suffix}`;
+  }
+
+  return `${filePath}${suffix}`;
+}
+
+function getActionIconPath(filePath, decorator) {
+  if (decorator.icon) {
+    return decorator.icon;
+  }
+
+  const actionIcon = replaceEntrySourceSuffix(filePath, '.action.png');
+  const scriptIcon = replaceEntrySourceSuffix(filePath, '.png');
+  const legacyScriptIcon = filePath.replace('.ts', '.png');
+
+  if (!fs.existsSync(actionIcon) && !fs.existsSync(scriptIcon) && !fs.existsSync(legacyScriptIcon)) {
+    return undefined;
+  }
+
+  const isBundleAction = decorator.bundle !== undefined;
+
+  if (fs.existsSync(actionIcon)) {
+    return isBundleAction
+      ? replaceEntryOutputSuffix(path.parse(filePath).name, '.action.png')
+      : replaceEntryOutputSuffix(getPartialPath(filePath), '.action.png');
+  }
+
+  if (fs.existsSync(scriptIcon)) {
+    return isBundleAction
+      ? replaceEntryOutputSuffix(path.parse(filePath).name, '.png')
+      : replaceEntryOutputSuffix(getPartialPath(filePath), '.png');
+  }
+
+  return isBundleAction
+    ? path.parse(filePath).name.replace('.dsa', '.dsa.png')
+    : `${getPartialPath(filePath)}.png`;
+}
+
 function generateInstallerTemplate(data, options) {
   return `
 import { showSetupCustomActionsDialog as setup } from '@dsf/helpers/custom-action-installer-helper';
@@ -178,12 +226,9 @@ function processScript(filePath, container, defaultMenuPath, setupOptions) {
     toolbar: stringOrDefault(decorator.toolbar, undefined),
   };
 
-  const icon = filePath.replace('.ts', '.png');
-  if (fs.existsSync(icon)) {
-    script.icon =
-      decorator.bundle === undefined
-        ? `${getPartialPath(filePath)}.png`
-        : fileInfo.name.replace('.dsa', '.dsa.png');
+  const icon = getActionIconPath(filePath, decorator);
+  if (icon) {
+    script.icon = icon;
   }
 
   script.text = stringOrDefault(decorator.text, script.text);
@@ -364,4 +409,5 @@ if (require.main === module) {
 module.exports = {
   generateInstallerFiles,
   findActionEntryFiles,
+  getActionIconPath,
 };

package/package.json

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

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

@@ -0,0 +1,105 @@
+import fs from 'node:fs'
+import os from 'node:os'
+import path from 'node:path'
+import { afterEach, describe, expect, it } from 'vitest'
+
+const { generateInstallerFiles } = require('../../dist/scripts/install-generator')
+
+const tempDirs: string[] = []
+
+const makeProject = (): string => {
+    const projectDir = fs.mkdtempSync(path.join(os.tmpdir(), 'dsf-install-generator-'))
+    tempDirs.push(projectDir)
+    fs.mkdirSync(path.join(projectDir, 'src'), { recursive: true })
+    fs.writeFileSync(
+        path.join(projectDir, 'dazscript.config.cjs'),
+        "module.exports = { appDataPath: 'Test/ActionIcons' }\n"
+    )
+    return projectDir
+}
+
+const writeScript = (projectDir: string, name: string, actionOptions: string = ''): void => {
+    fs.writeFileSync(
+        path.join(projectDir, 'src', `${name}.dsa.ts`),
+        `action({ text: '${name}'${actionOptions} }, function() {})\n`
+    )
+}
+
+const writePng = (projectDir: string, fileName: string): void => {
+    fs.writeFileSync(path.join(projectDir, 'src', fileName), 'png')
+}
+
+const generateSetup = (projectDir: string): string => {
+    const previousCwd = process.cwd()
+    process.chdir(projectDir)
+    try {
+        generateInstallerFiles(projectDir, {
+            scriptsPath: './src',
+            defaultMenuPath: '/Test',
+            appDataPath: undefined,
+        })
+    } finally {
+        process.chdir(previousCwd)
+    }
+    return fs.readFileSync(path.join(projectDir, 'src', 'Setup.dsa.ts'), 'utf8')
+}
+
+afterEach(() => {
+    while (tempDirs.length > 0) {
+        const dir = tempDirs.pop()
+        if (dir) fs.rmSync(dir, { recursive: true, force: true })
+    }
+})
+
+describe('install generator action icons', () => {
+    it('prefers the action icon convention over the script icon fallback', () => {
+        const projectDir = makeProject()
+        writeScript(projectDir, 'render-tools')
+        writePng(projectDir, 'render-tools.action.png')
+        writePng(projectDir, 'render-tools.png')
+        writePng(projectDir, 'render-tools.dsa.png')
+
+        const setup = generateSetup(projectDir)
+
+        expect(setup).toContain('"icon": "./render-tools.action.png"')
+        expect(setup).not.toContain('"icon": "./render-tools.png"')
+        expect(setup).not.toContain('"icon": "./render-tools.dsa.png"')
+    })
+
+    it('falls back to the script icon when no action icon exists', () => {
+        const projectDir = makeProject()
+        writeScript(projectDir, 'power-menu')
+        writePng(projectDir, 'power-menu.png')
+        writePng(projectDir, 'power-menu.dsa.png')
+
+        const setup = generateSetup(projectDir)
+
+        expect(setup).toContain('"icon": "./power-menu.png"')
+        expect(setup).not.toContain('"icon": "./power-menu.dsa.png"')
+    })
+
+    it('keeps the dsa-named script icon as a legacy fallback', () => {
+        const projectDir = makeProject()
+        writeScript(projectDir, 'legacy-icon')
+        writePng(projectDir, 'legacy-icon.dsa.png')
+
+        const setup = generateSetup(projectDir)
+
+        expect(setup).toContain('"icon": "./legacy-icon.dsa.png"')
+    })
+
+    it('lets explicit action icon metadata override discovered icon files', () => {
+        const projectDir = makeProject()
+        writeScript(projectDir, 'custom-icon', ", icon: 'icons/custom-action.png'")
+        writePng(projectDir, 'custom-icon.action.png')
+        writePng(projectDir, 'custom-icon.png')
+        writePng(projectDir, 'custom-icon.dsa.png')
+
+        const setup = generateSetup(projectDir)
+
+        expect(setup).toContain('"icon": "icons/custom-action.png"')
+        expect(setup).not.toContain('"icon": "custom-icon.action.png"')
+        expect(setup).not.toContain('"icon": "custom-icon.png"')
+        expect(setup).not.toContain('"icon": "custom-icon.dsa.png"')
+    })
+})