dazscript-framework 1.0.5 → 1.0.7

package/README.md

@@ -53,7 +53,7 @@ npm install dazscript-framework dazscript-types
 npx dazscript init
 ```
 
-Follow the prompt for your AppData author namespace (e.g. `YourName/my-project`). This creates `dazscript.config.ts`, `tsconfig.json`, and wires the `build`, `build:encrypted`, `watch`, `encrypt`, `icons`, and `installer` scripts into `package.json`.
+Follow the prompt for your AppData author namespace (e.g. `YourName/my-project`). This creates `dazscript.config.ts`, `tsconfig.json`, and wires the `build`, `build:encrypted`, `build:release`, `watch`, `encrypt`, `icons`, and `installer` scripts into `package.json`.
 
 ### 3. Write the script
 
@@ -160,6 +160,7 @@ This generates:
 - `dazscript.config.ts`
 - `tsconfig.json`
 - `package.json` script wiring for `build`, `build:encrypted`, `watch`, `encrypt`, `icons`, and `installer`
+- `build:release` uses `--log-level warn` before encryption so release packages suppress debug and trace output
 
 Available `init` flags:
 
@@ -174,6 +175,8 @@ npx dazscript init --menu-path /MyScripts --scripts-path ./src --out-dir ./out -
 | `--out-dir` | Where `build` writes `.dsa` files and copies icons |
 | `--app-data-path` | AppData namespace for launcher fallback (`Author/Product` format) |
 
+Builds also accept `--log-level <trace|debug|info|warn|error|off>`. This sets the minimum runtime log level for the compiled scripts. Use `debug` or `trace` during development and `warn` for release packages.
+
 Use `--scripts-path ./src/scripts` when runnable files live under a subfolder; use `--scripts-path ./src` when they are at the source root.
 
 ---
@@ -235,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` |
 
 ---
@@ -286,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
@@ -517,6 +530,7 @@ Files ending in `.dsa.ts` are treated as runnable entry points and compiled to `
 | Command | What it does |
 |---|---|
 | `npm run build` | Compile TypeScript → Daz Script |
+| `npm run build:release` | Build with `--log-level warn`, then encrypt implementation bundles |
 | `npm run watch` | Recompile on every save |
 | `npm run installer` | Generate the setup dialog |
 | `npm run icons` | Copy icon assets to the output folder |

package/dist/scripts/build.js

@@ -8,6 +8,7 @@ function runWebpack(workdir, options) {
   const env = {
     context: workdir,
     outputPath: options.outDir || './out',
+    logLevel: options.logLevel || '',
   };
 
   if (options.file) {

package/dist/scripts/cli.js

@@ -26,6 +26,7 @@ Options:
   --scripts-path <path> Source directory to scan. Default: ./src
   --out-dir <path>      Build output directory. Default: ./out
   --app-data-path <path> AppData namespace used by launcher fallbacks. Example: Author/Product
+  --log-level <level>   Minimum runtime log level: trace, debug, info, warn, error, off
   --daz-studio <path>   Daz Studio executable for encrypt
   --keep-source         Keep source script.dsa files after encrypting
   --timeout-ms <value>  Daz Studio encrypt timeout. Default: 300000
@@ -115,6 +116,12 @@ function parseOptions(args, defaults) {
       continue;
     }
 
+    if (arg === '--log-level') {
+      options.logLevel = args[index + 1];
+      index += 1;
+      continue;
+    }
+
     if (arg === '--daz-studio') {
       options.dazStudio = args[index + 1];
       index += 1;
@@ -179,6 +186,7 @@ async function main(argv) {
     scriptsPath: undefined,
     outDir: undefined,
     appDataPath: undefined,
+    logLevel: undefined,
     file: undefined,
     dazStudio: undefined,
     keepSource: false,

package/dist/scripts/init.js

@@ -94,6 +94,7 @@ function updatePackageJson(workdir, options) {
     prebuild: 'npm run installer',
     build: 'dazscript build',
     'build:encrypted': 'npm run build && npm run encrypt',
+    'build:release': 'npm run build -- --log-level warn && npm run encrypt',
     postbuild: 'npm run icons',
     watch: 'dazscript watch',
     encrypt: 'dazscript encrypt --out-dir ./out --daz-studio "C:\\Program Files\\DAZ 3D\\DAZStudio4\\DAZStudio.exe"',

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.5",
+  "version": "1.0.7",
   "author": "Freddy Diaz",
   "license": "MPL-2.0",
   "description": "",

package/src/common/log.test.ts

@@ -0,0 +1,45 @@
+import { beforeEach, describe, expect, it, vi } from 'vitest'
+import { debug, error, getLogLevel, info, setLogLevel, shouldLog, trace, warn } from './log'
+
+describe('log levels', () => {
+    beforeEach(() => {
+        ;(globalThis as any).App = {
+            debug: vi.fn(),
+            log: vi.fn(),
+            warning: vi.fn(),
+            flushLogBuffer: vi.fn(),
+            statusLine: vi.fn()
+        }
+        setLogLevel('debug')
+    })
+
+    it('filters messages below the active level', () => {
+        setLogLevel('warn')
+
+        debug('hidden debug')
+        info('hidden info')
+        warn('visible warn')
+        error('visible error')
+
+        expect((globalThis as any).App.debug).not.toHaveBeenCalled()
+        expect((globalThis as any).App.log).not.toHaveBeenCalled()
+        expect((globalThis as any).App.warning).toHaveBeenCalledTimes(2)
+    })
+
+    it('allows trace only when active level is trace', () => {
+        setLogLevel('debug')
+        trace('hidden trace')
+
+        setLogLevel('trace')
+        trace('visible trace')
+
+        expect((globalThis as any).App.debug).toHaveBeenCalledTimes(1)
+    })
+
+    it('normalizes invalid levels to debug', () => {
+        setLogLevel('not-a-level')
+
+        expect(getLogLevel()).toBe('debug')
+        expect(shouldLog('debug')).toBe(true)
+    })
+})

package/src/common/log.ts

@@ -1,32 +1,73 @@
-import * as global from '@dsf/core/global'
+export type LogLevel = 'trace' | 'debug' | 'info' | 'warn' | 'error' | 'off'
+
+declare const __DAZSCRIPT_LOG_LEVEL__: string | undefined
+
+const logLevels: LogLevel[] = ['trace', 'debug', 'info', 'warn', 'error', 'off']
+const logLevelWeights: { [key in LogLevel]: number } = {
+    trace: 0,
+    debug: 1,
+    info: 2,
+    warn: 3,
+    error: 4,
+    off: 5
+}
+
+let currentLogLevel: LogLevel = normalizeLogLevel(
+    typeof __DAZSCRIPT_LOG_LEVEL__ === 'string'
+        ? __DAZSCRIPT_LOG_LEVEL__
+        : 'debug'
+)
+
+export const setLogLevel = (level: string): LogLevel => {
+    currentLogLevel = normalizeLogLevel(level)
+    return currentLogLevel
+}
+
+export const getLogLevel = (): LogLevel => currentLogLevel
+
+export function normalizeLogLevel(level: string): LogLevel {
+    if (!level) return 'debug'
+    const normalized = level.toLowerCase() as LogLevel
+    return logLevels.indexOf(normalized) >= 0 ? normalized : 'debug'
+}
+
+export const shouldLog = (level: LogLevel): boolean => {
+    return logLevelWeights[level] >= logLevelWeights[currentLogLevel]
+        && currentLogLevel !== 'off'
+}
 
 export const debug = (message: any) => {
-    App.debug(format(message))
-    App.flushLogBuffer()
+    if (!shouldLog('debug')) return
+    app().debug(format(message))
+    flush()
 }
 
 export const info = (message: any) => {
-    global.app.log(format(message))
-    App.flushLogBuffer()
+    if (!shouldLog('info')) return
+    app().log(format(message))
+    flush()
 }
 
 export const error = (message: any) => {
-    App.warning(format(message, "ERROR"))
-    App.flushLogBuffer()
+    if (!shouldLog('error')) return
+    app().warning(format(message, "ERROR"))
+    flush()
 }
 
 export const warn = (message: any) => {
-    App.warning(message)
-    App.flushLogBuffer()
+    if (!shouldLog('warn')) return
+    app().warning(message)
+    flush()
 }
 
 export const trace = (message: any) => {
-    App.debug(format(message, "TRACE"))
-    App.flushLogBuffer()
+    if (!shouldLog('trace')) return
+    app().debug(format(message, "TRACE"))
+    flush()
 }
 
 export const status = (message: any, log: boolean = true) => {
-    App.statusLine(message, log)
+    app().statusLine(message, log)
 }
 
 /**
@@ -39,8 +80,9 @@ export const raise = (err: string) => {
 }
 
 export const dump = (obj: any) => {
-    App.debug(`[DUMP]\r\n${JSON.stringify(obj, null, 2)}`)
-    App.flushLogBuffer()
+    if (!shouldLog('debug')) return
+    app().debug(`[DUMP]\r\n${JSON.stringify(obj, null, 2)}`)
+    flush()
 }
 
 const format = (message: string, level?: 'ERROR' | 'TRACE' | 'DUMP' | 'INFO') => {
@@ -54,3 +96,9 @@ const format = (message: string, level?: 'ERROR' | 'TRACE' | 'DUMP' | 'INFO') =>
     return text
 }
 
+const app = (): any => App
+
+const flush = () => {
+    app().flushLogBuffer()
+}
+

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"')
+    })
+})

package/webpack.config.js

@@ -1,5 +1,6 @@
 const path = require('path');
 const glob = require('glob');
+const webpack = require('webpack');
 const TsconfigPathsPlugin = require('tsconfig-paths-webpack-plugin');
 const { createActionLaunchers } = require('./dist/scripts/launchers');
 const { validateAppDataPath } = require('./dist/scripts/app-data-path');
@@ -29,6 +30,7 @@ module.exports = (env, argv) => {
     (env && env.appDataPath) || projectConfig.appDataPath,
     projectRoot
   );
+  const logLevel = (env && env.logLevel) || '';
   const sourceRoot = path.resolve(projectRoot, 'src');
   const projectNodeModules = path.resolve(projectRoot, 'node_modules');
   const frameworkSourceRoot = path.resolve(
@@ -120,6 +122,9 @@ module.exports = (env, argv) => {
       },
     },
     plugins: [
+      new webpack.DefinePlugin({
+        __DAZSCRIPT_LOG_LEVEL__: JSON.stringify(logLevel),
+      }),
       new ActionLauncherPlugin({
         workdir: projectRoot,
         outDir: outputPath,