dazscript-framework 0.2.5 → 0.3.2

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.2",
   "author": "Freddy Diaz",
   "license": "MPL-2.0",
   "description": "",
@@ -41,7 +41,7 @@
     "url": "git+https://github.com/fjdiazt/dazscript-framework.git"
   },
   "peerDependencies": {
-    "dazscript-types": "^0.2.3"
+    "dazscript-types": "^1.0.0"
   },
   "dependencies": {
     "@babel/core": "^7.23.2",
@@ -67,6 +67,7 @@
   },
   "devDependencies": {
     "@types/node": "^22.10.5",
+    "dazscript-types": "^1.0.1",
     "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/dialog/builders/list-view-builder.ts

@@ -384,7 +384,7 @@ const build = <TItem, TData>(context: ListViewBuilderContext<TItem, TData>): DzL
 
     if (context.doubleClicked) {
         listView.doubleClicked.scriptConnect((listItem) => {
-            context.doubleClicked.value = listItem?.getDataItem('data')
+            context.doubleClicked.value = listItem?.getDataItem('data') as TData
         })
     }
 

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

@@ -16,7 +16,7 @@ export default class SliderBuilder extends WidgetBuilderBase<DzFloatSlider | DzI
             value$.connect((value) => {
                 this.widget.value = value
             });
-            (this.widget.valueChanged as unknown as ISignalT<number>).scriptConnect((value) => {
+            (this.widget.valueChanged as unknown as ISignal<number>).scriptConnect((value) => {
                 value$.value = value
             })
         }

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
@@ -182,7 +195,7 @@ export const clearActionShorcut = (name: string) => {
     }
 }
 
-export const getActionPixmap = (action: string, icon: string, maxSize?: number): QPixmap | null => {
+export const getActionPixmap = (action: string, icon: string, maxSize?: number): Pixmap | null => {
     try {
         if (!action) return null;
         let isCustom = isCustomAction(action)
@@ -191,7 +204,7 @@ export const getActionPixmap = (action: string, icon: string, maxSize?: number):
             let image: DzImageTexture = (App.getImageMgr() as any)['getImage(QString)'](icon)
             if (image) {
                 let size = image.getOriginalImageSize();
-                let pixmap: QPixmap
+                let pixmap: Pixmap
                 // Only clamp if maxSize is provided and image is larger
                 if (maxSize && (size.width > maxSize || size.height > maxSize)) {
                     pixmap = image.getPreviewPixmap(Math.min(size.width, maxSize), Math.min(size.height, maxSize))