dazscript-framework 0.1.14 → 0.1.16

package/src/common/dz-dump.ts

@@ -1,121 +1,121 @@
-import { any } from '@dsf/helpers/array-helper';
-import { contains, count, remove } from '@dsf/helpers/string-helper';
-
-function isUpperCase(myString: string) {
-    return (myString === myString.toUpperCase());
-}
-
-var lines = [];
-function processLine(x: string): void {
-    x = remove(x, "*");
-    x = x.replace("const ", "");
-    x = x.replace(/\(([a-zA-Z0-9]*),/, "(#{arg}:$1,");
-    x = x.replace(/,([a-zA-Z0-9]*)\)/, ", #{arg}:$1)");
-    x = x.replace(/,([a-zA-Z0-9]\w*)/g, ", #{arg}:$1");
-    while (contains(x, "#{arg}")) {
-        var n = count(x, "#{arg}") - 1;
-        x = x.replace(new RegExp('#{arg}(?!.*#{arg})'), `p${n}`);
-    }
-    x = x.replace(/(int|float)/g, "number");
-    x = x.replace(/(bool)/g, "boolean");
-    x = x.replace(/(QString)/g, "string");
-    x = x.replace(/(QPonumber)/g, "number");
-    x = x.replace(/\((\w*\))/, "(p0:$1");
-    x = x.replace(/\((\w*\))/, "(p0:$1");
-    x = x.replace("p0:)", ")");
-    lines.push("    " + x + ": any;");
-};
-
-// Keep track of classes avoiding duplicates
-var classesFound = {};
-
-export function dz_dump(obj: any) {
-    if (!obj || obj === null) {
-        print('null object');
-        App.flushLogBuffer()
-        return;
-    }
-
-    var className = null;
-    var enumerations = [];
-    var properties = [];
-    var functions = [];
-    var signals = [];
-
-    // is DAZ object?
-    if (obj["className"]) {
-        className = obj.className();
-    }
-
-    // already seen? leave
-    if (classesFound[className]) return;
-
-    for (var name in obj) {
-        var o = obj[name];
-        if (typeof o == "function") {
-            if (any(["Changed", "Requested", "Renamed", "Clicked", "Pressed"], x => contains(name, x)))
-                signals.push(name);
-            else
-                functions.push(name);
-        }
-        else {
-            if (isUpperCase(name[0]))
-                enumerations.push(name);
-            else
-                properties.push(name);
-        }
-    }
-    properties.sort();
-    functions.sort();
-    signals.sort();
-
-    lines.push("");
-    lines.push("/**");
-    lines.push(" * class " + className);
-    lines.push(" */");
-    lines.push("declare class " + className + " {");
-
-    if (enumerations.length > 0) {
-        lines.push("");
-        lines.push("    //#region Enumerations");
-        enumerations.forEach(function (x) {
-            lines.push("    static " + x + ": " + typeof obj[x] + "; // " + (obj[x]));
-        });
-    }
-    lines.push("    //#endregion");
-    lines.push("");
-    lines.push("    // Properties");
-
-    properties.forEach(function (x) {
-        lines.push("    " + x + ": " + typeof obj[x] + "; // " + (obj[x]));
-    });
-    lines.push("");
-    lines.push("    // Methods");
-
-    // Process LineFunctions
-    functions.forEach(processLine);
-
-    // Process Signals
-    if (signals.length > 0) {
-        lines.push("");
-        lines.push("    // Signals");
-        signals.forEach(processLine);
-    }
-    lines.push("}");
-
-    classesFound[className] = lines.join('\r\n');
-
-    // output classes found
-    for (var name in classesFound) {
-        print(classesFound[name]);
-    }
-
-}
-
-// =======================================
-// =======================================
-// =======================================
-//dump(new DzERCLink());
-// =======================================
-// =======================================
+import { any } from '@dsf/helpers/array-helper';
+import { contains, count, remove } from '@dsf/helpers/string-helper';
+
+function isUpperCase(myString: string) {
+    return (myString === myString.toUpperCase());
+}
+
+var lines = [];
+function processLine(x: string): void {
+    x = remove(x, "*");
+    x = x.replace("const ", "");
+    x = x.replace(/\(([a-zA-Z0-9]*),/, "(#{arg}:$1,");
+    x = x.replace(/,([a-zA-Z0-9]*)\)/, ", #{arg}:$1)");
+    x = x.replace(/,([a-zA-Z0-9]\w*)/g, ", #{arg}:$1");
+    while (contains(x, "#{arg}")) {
+        var n = count(x, "#{arg}") - 1;
+        x = x.replace(new RegExp('#{arg}(?!.*#{arg})'), `p${n}`);
+    }
+    x = x.replace(/(int|float)/g, "number");
+    x = x.replace(/(bool)/g, "boolean");
+    x = x.replace(/(QString)/g, "string");
+    x = x.replace(/(QPonumber)/g, "number");
+    x = x.replace(/\((\w*\))/, "(p0:$1");
+    x = x.replace(/\((\w*\))/, "(p0:$1");
+    x = x.replace("p0:)", ")");
+    lines.push("    " + x + ": any;");
+};
+
+// Keep track of classes avoiding duplicates
+var classesFound = {};
+
+export default function dz_dump(obj: any): void {
+    if (!obj || obj === null) {
+        print('null object');
+        App.flushLogBuffer()
+        return;
+    }
+
+    var className = null;
+    var enumerations = [];
+    var properties = [];
+    var functions = [];
+    var signals = [];
+
+    // is DAZ object?
+    if (obj["className"]) {
+        className = obj.className();
+    }
+
+    // already seen? leave
+    if (classesFound[className]) return;
+
+    for (var name in obj) {
+        var o = obj[name];
+        if (typeof o == "function") {
+            if (any(["Changed", "Requested", "Renamed", "Clicked", "Pressed"], x => contains(name, x)))
+                signals.push(name);
+            else
+                functions.push(name);
+        }
+        else {
+            if (isUpperCase(name[0]))
+                enumerations.push(name);
+            else
+                properties.push(name);
+        }
+    }
+    properties.sort();
+    functions.sort();
+    signals.sort();
+
+    lines.push("");
+    lines.push("/**");
+    lines.push(" * class " + className);
+    lines.push(" */");
+    lines.push("declare class " + className + " {");
+
+    if (enumerations.length > 0) {
+        lines.push("");
+        lines.push("    //#region Enumerations");
+        enumerations.forEach(function (x) {
+            lines.push("    static " + x + ": " + typeof obj[x] + "; // " + (obj[x]));
+        });
+    }
+    lines.push("    //#endregion");
+    lines.push("");
+    lines.push("    // Properties");
+
+    properties.forEach(function (x) {
+        lines.push("    " + x + ": " + typeof obj[x] + "; // " + (obj[x]));
+    });
+    lines.push("");
+    lines.push("    // Methods");
+
+    // Process LineFunctions
+    functions.forEach(processLine);
+
+    // Process Signals
+    if (signals.length > 0) {
+        lines.push("");
+        lines.push("    // Signals");
+        signals.forEach(processLine);
+    }
+    lines.push("}");
+
+    classesFound[className] = lines.join('\r\n');
+
+    // output classes found
+    for (var name in classesFound) {
+        print(classesFound[name]);
+    }
+
+}
+
+// =======================================
+// =======================================
+// =======================================
+//dump(new DzERCLink());
+// =======================================
+// =======================================
 // =======================================

package/src/common/log.ts

@@ -1,57 +1,56 @@
-import * as global from '@dsf/core/global'
-
-export const debug = (message: any) => {
-    App.debug(format(message))
-    App.flushLogBuffer()
-}
-
-export const info = (message: any) => {
-    global.app.log(format(message))
-    App.flushLogBuffer()
-}
-
-export const error = (message: any) => {
-    App.warning(format(message, "ERROR"))
-    App.flushLogBuffer()
-}
-
-export const warn = (message: any) => {
-    App.warning(message)
-    App.flushLogBuffer()
-}
-
-export const trace = (message: any) => {
-    App.debug(format(message, "TRACE"))
-    App.flushLogBuffer()
-}
-
-export const status = (message: any, log: boolean = true) => {
-    App.statusLine(message, log)
-}
-
-/**
- * Log the error and raise an exception
- * @param err
- */
-export const raise = (err: string) => {
-    error(err)
-    throw Error(err)
-}
-
-export const dump = (obj: any) => {
-    App.debug(`[DUMP]\r\n${JSON.stringify(obj, null, 2)}`)
-    App.flushLogBuffer()
-}
-
-
-const format = (message: string, level?: 'ERROR' | 'TRACE' | 'DUMP' | 'INFO') => {
-    if (message == null) {
-        return ''
-    }
-
-    let text = message
-
-    if (level) text = `[${level}] ${text}`
-    return text
-}
-
+import * as global from '@dsf/core/global'
+
+export const debug = (message: any) => {
+    App.debug(format(message))
+    App.flushLogBuffer()
+}
+
+export const info = (message: any) => {
+    global.app.log(format(message))
+    App.flushLogBuffer()
+}
+
+export const error = (message: any) => {
+    App.warning(format(message, "ERROR"))
+    App.flushLogBuffer()
+}
+
+export const warn = (message: any) => {
+    App.warning(message)
+    App.flushLogBuffer()
+}
+
+export const trace = (message: any) => {
+    App.debug(format(message, "TRACE"))
+    App.flushLogBuffer()
+}
+
+export const status = (message: any, log: boolean = true) => {
+    App.statusLine(message, log)
+}
+
+/**
+ * Log the error and raise an exception
+ * @param err
+ */
+export const raise = (err: string) => {
+    error(err)
+    throw Error(err)
+}
+
+export const dump = (obj: any) => {
+    App.debug(`[DUMP]\r\n${JSON.stringify(obj, null, 2)}`)
+    App.flushLogBuffer()
+}
+
+const format = (message: string, level?: 'ERROR' | 'TRACE' | 'DUMP' | 'INFO') => {
+    if (message == null) {
+        return ''
+    }
+
+    let text = message
+
+    if (level) text = `[${level}] ${text}`
+    return text
+}
+

package/src/common/trace.ts

@@ -1,26 +1,26 @@
-import { app } from '@dsf/core/global';
-
-export function trace(enabled: boolean = true) {
-    return function (target: any, key?: string, descriptor?: PropertyDescriptor) {
-        if (key !== undefined && descriptor !== undefined) {
-            // Applied to a method
-            if (!enabled)
-                return descriptor
-
-            const originalMethod = descriptor.value;
-            descriptor.value = function (...args: any[]) {
-                app.debug(`[TRACE] Entering method: ${key}`);
-                app.flushLogBuffer()
-                const result = originalMethod.apply(this, args);
-                app.debug(`[TRACE] Exiting method: ${key}`);
-                app.flushLogBuffer()
-                return result;
-            };
-
-            return descriptor;
-        } else if (key === undefined && descriptor === undefined) {
-            // Applied to a class
-            return target;
-        }
-    }
-}
+import { app } from '@dsf/core/global';
+
+export function trace(enabled: boolean = true) {
+    return function (target: any, key?: string, descriptor?: PropertyDescriptor) {
+        if (key !== undefined && descriptor !== undefined) {
+            // Applied to a method
+            if (!enabled)
+                return descriptor
+
+            const originalMethod = descriptor.value;
+            descriptor.value = function (...args: any[]) {
+                app.debug(`[TRACE] Entering method: ${key}`);
+                app.flushLogBuffer()
+                const result = originalMethod.apply(this, args);
+                app.debug(`[TRACE] Exiting method: ${key}`);
+                app.flushLogBuffer()
+                return result;
+            };
+
+            return descriptor;
+        } else if (key === undefined && descriptor === undefined) {
+            // Applied to a class
+            return target;
+        }
+    }
+}

package/src/core/action-decorator.ts

@@ -1,16 +1,16 @@
-class CustomActionDefinition {
-    text?: string
-    description?: string
-    icon?: string
-    menuPath?: string | boolean
-    toolbar?: string
-    sort?: number
-    group?: string
-    shortcut?: string
-    bundle?: string | boolean
-}
-
-export const action = (action?: CustomActionDefinition) => {
-    return (target: Function) => {
-    }
+class CustomActionDefinition {
+    text?: string
+    description?: string
+    icon?: string
+    menuPath?: string | boolean
+    toolbar?: string
+    sort?: number
+    group?: string
+    shortcut?: string
+    bundle?: string | boolean
+}
+
+export const action = (action?: CustomActionDefinition) => {
+    return (target: Function) => {
+    }
 }

package/src/core/base-script.ts

@@ -1,30 +1,30 @@
-import { debug, error, raise } from '@dsf/common/log';
-import { acceptUndo } from '@dsf/helpers/undo-helper';
-
-export abstract class BaseScript {
-    protected readonly scriptName: string
-    protected anounceExecution: boolean = true
-
-    constructor() {
-        this.scriptName = (<any>this.constructor).name;
-    }
-
-    protected abstract run(): void
-
-    exec() {
-        if (this.anounceExecution) {
-            debug(`=== Running script "${this.scriptName}" ===`)
-        }
-
-        try {
-            this.run()
-        } catch (err) {
-            error(`There was an error while running the script "${this.scriptName}"`)
-            raise(err)
-        }
-    }
-
-    protected acceptUndo(callback: () => void) {
-        acceptUndo(this.scriptName, callback);
-    }
-}
+import { debug, error, raise } from '@dsf/common/log';
+import { acceptUndo } from '@dsf/helpers/undo-helper';
+
+export abstract class BaseScript {
+    protected readonly scriptName: string
+    protected anounceExecution: boolean = true
+
+    constructor() {
+        this.scriptName = (<any>this.constructor).name;
+    }
+
+    protected abstract run(): void
+
+    exec() {
+        if (this.anounceExecution) {
+            debug(`=== Running script "${this.scriptName}" ===`)
+        }
+
+        try {
+            this.run()
+        } catch (err) {
+            error(`There was an error while running the script "${this.scriptName}"`)
+            raise(err)
+        }
+    }
+
+    protected acceptUndo(callback: () => void) {
+        acceptUndo(this.scriptName, callback);
+    }
+}

package/src/core/custom-action.ts

@@ -1,12 +1,12 @@
-export class CustomAction {
-    name: string
-    text: string
-    description: string
-    filePath: string
-    menuPath: string
-    icon?: string
-    toolbar?: string
-    sort?: number
-    group?: string
-    shortcut?: string
+export class CustomAction {
+    name?: string | null
+    text?: string | null
+    description?: string | null
+    filePath?: string | null
+    menuPath?: string | null
+    icon?: string | null
+    toolbar?: string | null
+    sort?: number | null
+    group?: string | null
+    shortcut?: string | null
 }

package/src/core/global.ts

@@ -1,5 +1,5 @@
-export const app = App
-export const scene = Scene
-export const mainWindow = MainWindow
-export const sceneHelper = new DzSceneHelper()
+export const app = App
+export const scene = Scene
+export const mainWindow = MainWindow
+export const sceneHelper = new DzSceneHelper()
 export const arrayHelper = new DzArrayHelper()

package/src/dialog/basic-dialog.ts

@@ -1,32 +1,40 @@
-import { DialogBuilder } from '@dsf/dialog/builders/dialog-builder';
-
-export abstract class BasicDialog {
-    protected dialog: DzBasicDialog
-    protected readonly builder: DialogBuilder
-
-    protected get add(): DialogBuilder {
-        return this.builder
-    }
-
-    constructor(name: string, id?: string) {
-        this.builder = new DialogBuilder(name, id)
-    }
-
-    protected abstract build(): void
-
-    protected init() {
-        this.builder.build(() => {
-            this.dialog = this.builder.context.dialog
-            this.build()
-        })
-    }
-
-    run(): boolean {
-        this.init()
-        return this.dialog.exec()
-    }
-
-    close() {
-        this.dialog.close()
-    }
-}
+import { DialogBuilder } from '@dsf/dialog/builders/dialog-builder';
+
+export abstract class BasicDialog {
+    protected dialog: DzBasicDialog
+    protected readonly builder: DialogBuilder
+
+    protected get add(): DialogBuilder {
+        return this.builder
+    }
+
+    constructor(name: string, id?: string) {
+        this.builder = new DialogBuilder(name, id)
+    }
+
+    protected abstract build(): void
+
+    protected init() {
+        this.builder.build(() => {
+            this.dialog = this.builder.context.dialog
+            this.build()
+        })
+    }
+
+    run(): boolean {
+        this.init()
+        return this.dialog.exec()
+    }
+
+    ok(): boolean {
+        return this.run() === true
+    }
+
+    cancel(): boolean {
+        return this.run() === false
+    }
+
+    close() {
+        this.dialog.close()
+    }
+}