@nexrender/core 1.46.1 → 1.46.4

package/package.json

@@ -1,13 +1,14 @@
 {
   "name": "@nexrender/core",
-  "version": "1.46.1",
+  "version": "1.46.4",
   "main": "src/index.js",
   "author": "Inlife",
   "homepage": "https://www.nexrender.com",
   "bugs": "https://github.com/inlife/nexrender/issues",
   "repository": "https://github.com/inlife/nexrender.git",
   "scripts": {
-    "pkg-prelink": "node ../../misc/prelink.js"
+    "pkg-prelink": "node ../../misc/prelink.js",
+    "test": "mocha"
   },
   "dependencies": {
     "@nexrender/types": "^1.45.6",
@@ -15,13 +16,12 @@
     "file-uri-to-path": "^2.0.0",
     "is-wsl": "^2.2.0",
     "make-fetch-happen": "^11.0.2",
-    "match-all": "^1.2.5",
     "mime-types": "^2.1.29",
     "mkdirp": "^1.0.4",
     "nanoid": "^3.2.0",
-    "posthog-node": "^3.1.1",
     "requireg": "^0.2.1",
     "rimraf": "^3.0.2",
+    "strip-comments": "^2.0.1",
     "systeminformation": "^5.18.3"
   },
   "peerDependencies": {
@@ -36,5 +36,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "9286b0383ee0c7f54fec91a7c37b1e6714b71e3e"
+  "gitHead": "e997bcd889a5d6ea61f2dd30cfd1fd382dcaf1e5"
 }

package/src/helpers/analytics.js

@@ -5,7 +5,6 @@ const crypto       = require('crypto')
 
 const si           = require('systeminformation')
 const { nanoid }   = require('nanoid')
-const {PostHog}    = require('posthog-node')
 const childProcess = require('child_process')
 
 const { version }  = require('../../package.json')
@@ -15,13 +14,6 @@ const hash = (data, salt) => crypto
     .update(data)
     .digest('hex');
 
-const analyticsPublicKey = 'phc_AWcZMlCOqHJiFyFKSoxT9WSrRkdKDFxpiFn8Ww0ZMHu';
-const analytics = new PostHog(analyticsPublicKey, {
-    host: 'https://eu.posthog.com',
-    flushAt: 1,
-    flushInterval: 0,
-    disableGeoip: true,
-});
 
 /**
  * A helper function to force syncronous tracking
@@ -186,8 +178,11 @@ const track = async (settings, event, properties = {}) => {
 
     // console.log('tracking event:', params)
 
-    analytics.capture(params);
-    await analytics.flush();
+
+    // removed posthog for now
+    params.foo = 1;
+    // analytics.capture(params);
+    // await analytics.flush();
 }
 
 if (process.argv[2] === 'child') {

package/src/tasks/script/EnhancedScript.js

@@ -0,0 +1,280 @@
+const fs = require('fs')
+const strip = require('strip-comments');
+
+const escapeForRegex = (str) => {
+    return str.replace(/[.*+?^${}()|[\]\\]/g, '\\$&'); // $& means the whole matched string
+}
+
+// Find instances of a function inside a single-line string.
+const REGEX_FN_DETECT = new RegExp(/(?:(?:(?:function *(?:[a-zA-Z0-9_]+)?) *(?:\((?:.*)\)) *(?:\{(?:.*)\}))|(?:(?:.*) *(?:=>) *(?:\{)(?:.*?)?\}))/);
+
+
+// This regex will detect a self-invoking function like (function(){})() and will catch the invoking parameters in a single string for further inspection.
+const REGEX_SELF_INVOKING_FN = new RegExp(/(?:(?:^\() *(?:.*?)(?:} *\)))(?: *(?:\() *(.*?) *(?:\) *$))/, "gm");
+
+/**
+ * Parse method from parameter
+ * @description                    Given a parameter detect whether it should be casted as a function in the final argument injection.
+ * @param param                (string|number|boolean|null|object|array) The parameter to parse a method from.
+ * @return bool                (Boolean) If a method is detected then it's stripped from String quotes, else it's returned in it's original type.
+*/
+const isMethod = (param) => {
+    if (typeof param == "string") {
+        return (param.match(REGEX_FN_DETECT) ? true : false);
+    }
+    return false
+}
+
+const getSearchUsageByMethodRegex = (keyword = 'NX', method = "set", flags = "g") => {
+    const str = `(?<!(?:[\\/\\s]))(?<!(?:[\\*\\s]))(?:\\s*${keyword}\\s*\\.)\\s*(${method})\\s*(?:\\()(?:["']{1})([a-zA-Z0-9._-]+)(?:["']{1})(?:\\))`;
+    return new RegExp(str, flags);
+}
+
+function EnhancedScript (
+            dest,
+            src,
+            parameters = [],
+            keyword = "NX",
+            defaults = {
+                global: "null",
+                string: "",
+                number: 0,
+                array: [],
+                boolean: false,
+                object: {},
+                function: function (){},
+                null: null
+            },
+            jobID,
+            logger
+    ) {
+        this.scriptPath = src;
+        this.script = fs.readFileSync(dest, 'utf8');
+        this.keyword = keyword;
+        this.defaults = defaults;
+        this.jobID = jobID;
+        this.logger = logger;
+        this.jsonParameters = parameters;
+
+        /** @type { key: string
+         *   isVar: boolean
+         *   isFn: boolean
+         *   needsDefault: boolean.
+         *  }
+        */
+        this.missingJSONParams = [];
+    }
+
+    /**
+     * Get Default Value
+     * @description                Retrieves a default value parameter based on a key.
+     * @param key                  (String)("string"|"number"|"array"|"object"|"null"|"function") The key to the required default parameter. Defaults to "null".
+     * @returns default            The value from this.defaults array.
+     */
+    EnhancedScript.prototype.getDefaultValue = function(key) { return key in this.defaults ? this.defaults[key] : this.defaults[this.defaults.global]; }
+
+    EnhancedScript.prototype.parseMethod = function (parameter) {
+        const selfInvokingFn = [...parameter.value.matchAll(REGEX_SELF_INVOKING_FN)];
+        if (selfInvokingFn ) {
+            return this.parseMethodWithArgs(parameter);
+        }
+        return parameter.value;
+    }
+
+    EnhancedScript.prototype.matchAsJSONParameterKey = function( key ) {
+        const parameterMatch = this.jsonParameters.find(o => o.key == key);
+        return parameterMatch ? parameterMatch.value : key;
+    }
+
+    EnhancedScript.prototype.parseMethodWithArgs = function (parameter) {
+        let value = parameter.value;
+        const methodArgs = [...parameter.value.matchAll(getSearchUsageByMethodRegex(this.keyword, 'arg', "gm"))];
+
+        if (methodArgs.length > 0 ) {
+            this.logger.log("We found a self-invoking method with arguments!");
+            this.logger.log(JSON.stringify(methodArgs));
+
+            let arg, fullMatch;
+            const foundArgument = methodArgs.filter( argMatch => {
+                fullMatch = argMatch[0]
+                arg = argMatch[2];
+
+                return parameter.arguments && parameter.arguments.find(o => o.key == arg);
+            });
+
+            if (foundArgument) {
+                // Search if argument is present in JSON and has `arguments` array to match against the results.
+                // And do a replacement with either the found argument on the array or a global default value.
+                let argReplacement = parameter.arguments && parameter.arguments.find(o => o.key == arg).value || this.getStringifiedDefaultValue(this.defaults.global);
+                const fullMatchRegex = new RegExp(escapeForRegex(fullMatch), "gm");
+                value = parameter.value.replace(fullMatchRegex, argReplacement);
+            }
+        }
+
+        return value;
+    }
+
+    EnhancedScript.prototype.detectValueType = function (parameter) {
+        return isMethod(parameter.value) ? this.parseMethod(parameter) : JSON.stringify(parameter.value);
+    }
+
+    /**
+     * Get Default Value as String
+     * @description                Retrieves a default value parameter based on a key.
+     * @param key                  (String)("string"|"number"|"array"|"object"|"null"|"function") The key to the required default parameter. Defaults to "null".
+     * @returns default            (String) A template literal string with the embedded default parameter. If it's a string then it's wrapped with quotes.
+     */
+    EnhancedScript.prototype.getStringifiedDefaultValue = function (key) {
+        return JSON.stringify(this.getDefaultValue(key))
+    }
+
+    /**
+     * Find Missing Matches in JSX Script
+     * ====================
+     * @description                RegEx Searches a given JSX script to find occurences and saves an object with keys
+     * @return bool                (Boolean)           Whether or not there are any variables to inject. Defaults to false.
+     */
+    EnhancedScript.prototype.findMissingMatchesInJSX = function () {
+        const script = strip(this.script);
+
+        // Parse all occurrences of the usage of NX on the provided script.
+        const nxMatches = [...script.matchAll(getSearchUsageByMethodRegex(this.keyword, "get", "gm"))];
+
+        if (nxMatches && nxMatches.length > 0 ) {
+            nxMatches.forEach( match => {
+                const keyword = match[2];
+
+                var nxMatch = {
+                    key: keyword.replace(/\s/g, ''),
+                    isVar: false,
+                    isFn: false,
+                    value: this.getDefaultValue(match.default ? match.default : this.defaults.global)
+                };
+                if (this.jsonParameters.filter( o => o.key == nxMatch.key ).length == 0) { // If the parameter doesn't have a value defined in JSON
+                    this.missingJSONParams.push(nxMatch);
+                }
+            });
+        }
+
+        const numMissing = this.missingJSONParams.length;
+        if (numMissing > 0) {
+            this.logger.log(`[${this.jobID}] ${this.displayAlert()}`);
+        }
+        return numMissing > 0;
+    }
+
+
+    /**
+     * Generated Placeholder Parameters
+     * ================================
+     * @description            Generates placeholder for "parameters" JSON Object based on keys from an array.
+     * @return string          (String)    JSON "parameters" object.
+     */
+     EnhancedScript.prototype.generatePlaceholderParameters = function ( ) {
+        const template = (key) => `
+                {
+                    "key" : "${key}",
+                    "value" : ${this.getStringifiedDefaultValue(this.defaults.global)}
+                }\n
+        `;
+        return `
+            "parameters" : [
+                ${this.missingJSONParams.map((k) => template(k.key)).join("\n")}
+            ]
+        `
+    }
+
+    /** 
+     * Display Missing Alert
+     * =====================
+     * @description              Display a log message if theres any missing parameter set on the JSON configuration but is being referred in the script.
+     * @return string           (String)   The template literal string displaying all the occurences if any.
+    */
+    EnhancedScript.prototype.displayAlert = function () {
+        const keyword = this.keyword;
+
+        return ` -- W A R N I N G --
+        The following parameters used in the script were NOT found on the JSON "parameters" object of your script asset ${this.scriptPath }
+
+            ${this.missingJSONParams.map(o => o.key).join(", ")}
+
+        Please set defaults in your JSX script (see documentation) or copy the following placeholder JSON code snippet and replace the values with your own:
+
+        ${this.generatePlaceholderParameters()}
+
+        Remember to always use a fallback default value for any use of the ${keyword} object to have the ability to run this script on After Effects directly.
+        Example:
+            const dogName = ${keyword} && ${keyword}.get("doggo") || "Doggo";
+        `
+    }
+
+    EnhancedScript.prototype.injectParameters = function () {
+        return [...this.jsonParameters, ...this.missingJSONParams].map( param => {
+            let value = param.type ? this.getStringifiedDefaultValue(param.type) : this.getDefaultValue(this.defaults.global);
+
+            if (param.value ) {
+                value = this.detectValueType(param);
+            }
+
+            return `${this.keyword}.set('${param.key}', ${value});`
+        }).join("\n");
+    }
+
+    EnhancedScript.prototype.buildParameterConfigurator = function () {
+        const defaultGlobalValue = this.getStringifiedDefaultValue( this.defaults.global );
+        // const defaultFnValue = this.getDefaultValue( this.defaults.function );
+        const createParameterConfigurator = () => `
+            function ParameterConfigurator () {
+                this.params = [];
+            }
+
+            ParameterConfigurator.prototype.set = function (k, v) {
+                this.params.push({
+                    key: k,
+                    value: v
+                });
+            };
+
+            ParameterConfigurator.prototype.call = function ( key, args ) {
+                for (var i = 0; i < this.params.length; i++) {
+                    if (this.params[i].key == key) {
+                        if (typeof this.params[i].value == "function") return this.params[i].value.apply(this, args && args.length > 0 ? args : []);
+                    }
+                }
+                return null;
+            }
+
+            ParameterConfigurator.prototype.get = function ( key, args ) {
+                for (var i = 0; i < this.params.length; i++) {
+                    if (this.params[i].key == key) {
+                        if (typeof this.params[i].value == "function") return this.call(key, args || []);
+                        return this.params[i].value;
+                    };
+                }
+                return ${ defaultGlobalValue }
+            };
+            var ${ this.keyword } = new ParameterConfigurator();
+
+            // Parameter injection from job configuration
+            ${ this.injectParameters() }
+        `;
+
+        return createParameterConfigurator();
+    }
+
+    EnhancedScript.prototype.build = function () {
+        this.findMissingMatchesInJSX();
+
+        // Et voilà!
+        const enhancedScript = `(function() {
+            ${this.buildParameterConfigurator()}
+            ${this.script}
+        })();\n`;
+
+        // do not log the script (can be uncommented for debugging)
+        // this.logger.log(enhancedScript);
+        return enhancedScript;
+}
+
+
+module.exports = EnhancedScript

package/src/tasks/script/EnhancedScript.spec.js

@@ -0,0 +1,115 @@
+// simple syntax test
+const path = require('path')
+const fs = require('fs')
+const os = require("os");
+const chai = require('chai')
+const expect = chai.expect
+
+describe('tasks/script/EnhancedScript', () => {
+    const EnhancedScript = require('./EnhancedScript')
+
+    const testJsxFilePath = path.join(os.tmpdir(), 'unittest.jsx')
+
+    it("Finds parameters in jsx with missing values in json and injects", () => {
+        fs.writeFileSync(testJsxFilePath,`
+        /* var c = NX.get('unittest_undefined_parameter_multi_line_comment')
+        */
+        // var d = NX.get('unittest_undefined_parameter_single_line_comment')
+        var a = NX.get('unittest_undefined_parameter')
+        var b = NX.get('unittest_defined_parameter')
+    `);
+
+    const enhancedScript = new EnhancedScript(testJsxFilePath, 'src', [
+        {
+            key: 'unittest_defined_parameter',
+            value: 'VALUE'
+        },
+    ], 'NX', {}, 'unittest', console);
+
+        const anyMissing = enhancedScript.findMissingMatchesInJSX();
+        expect(anyMissing).true;
+        expect(enhancedScript.missingJSONParams.map((o) => { return o.key})).to.have.members(['unittest_undefined_parameter'])
+
+        expect(enhancedScript.injectParameters()).to.equal(
+            [`NX.set('unittest_defined_parameter', "VALUE");`,
+            `NX.set('unittest_undefined_parameter', undefined);`].join('\n'));
+
+    })
+
+    it("injects functions and functions with arguments", () => {
+
+        //FIXME: NX.get('unittest_undefined_function', 'arg1')  is currently not found and no warning is given
+        fs.writeFileSync(testJsxFilePath,`
+            var a = NX.get('unittest_undefined_function', 'arg1') 
+            var b = NX.get('eventInvitation')
+        `);
+
+        const enhancedScript = new EnhancedScript(testJsxFilePath, 'src', [
+            {
+                "key" : "invitees",
+                "value": ["Steve", "Natasha", "Tony", "Bruce", "Wanda", "Thor", "Peter", "Clint" ]
+            },
+            {
+                "key" : "eventInvitation",
+                "value": `(function (venue) { alert( 'This years' Avengers Gala is on the prestigious ' + venue.name + ' located at ' + venue.location + '. Our special guests ' + NX.get('invitees').value.map(function (a, i) { return (i == NX.get('invitees').value.length - 1) ? ' and ' + a + ' (whoever that is)' : a + ', '; }).join('') + '  going to be present for the ceremony!');
+        })({ name: NX.arg('venue'), location: NX.arg('location') })`,
+                "arguments": [
+                    {
+                        "key" : "venue",
+                        "value" : "Smithsonian Museum of Natural History"
+                    },
+                    {
+                        "key" : "location",
+                        "value": "10th St. & Constitution Ave."
+                    },
+                ]
+            },
+            {
+                "type": "array",
+                "key" : "dogs",
+                "value": [ "Captain Sparkles", "Summer", "Neptune"]
+            },
+            {
+                "type" : "number",
+                "key" : "anAmount"
+            },
+            {
+                "type": "function",
+                "key": "getDogsCount",
+                "value" : "function() { return NX.get('dogs').length; }"
+            },
+            {
+                "type": "function",
+                "key": "exampleFn",
+                "value": "function ( parameter ) { return parameter; }"
+            },
+            {
+                "type" : "function",
+                "key" : "dogCount",
+                "value" : "(function(length) { return length })(NX.arg('dogCount'))",
+                "arguments": [
+                    {
+                        "key" : "dogCount",
+                        "value": ["NX.call('exampleFn', [NX.call('getDogsCount') + NX.get('anAmount')])"]
+                    }
+                ]
+            }
+        ], 'NX', {}, 'unittest', console);
+
+        const anyMissing = enhancedScript.findMissingMatchesInJSX();
+        expect(anyMissing).false;
+
+        const injected = enhancedScript.injectParameters();
+
+        expect(injected).to.equal([
+            `NX.set('invitees', ["Steve","Natasha","Tony","Bruce","Wanda","Thor","Peter","Clint"]);`,
+            `NX.set('eventInvitation', (function (venue) { alert( 'This years' Avengers Gala is on the prestigious ' + venue.name + ' located at ' + venue.location + '. Our special guests ' + NX.get('invitees').value.map(function (a, i) { return (i == NX.get('invitees').value.length - 1) ? ' and ' + a + ' (whoever that is)' : a + ', '; }).join('') + '  going to be present for the ceremony!');
+        })({ name: NX.arg('venue'), location:10th St. & Constitution Ave. }));`,
+            `NX.set('dogs', ["Captain Sparkles","Summer","Neptune"]);`,
+            `NX.set('anAmount', undefined);`,
+            `NX.set('getDogsCount', function() { return NX.get('dogs').length; });`,
+            `NX.set('exampleFn', function ( parameter ) { return parameter; });`,
+            `NX.set('dogCount', (function(length) { return length })(NX.call('exampleFn', [NX.call('getDogsCount') + NX.get('anAmount')])));`
+        ].join('\n'))
+    })
+})

package/src/tasks/script/helpers.js

@@ -0,0 +1,18 @@
+const escape = str => {
+    str = JSON.stringify(str)
+    str = str.substring(1, str.length-1)
+    str = `'${str.replace(/'/g, '\\\'')}'`
+    return str
+}
+
+const selectLayers = (job, { composition, layerName, layerIndex }, callbackString) => {
+    const method = layerName ? 'selectLayersByName' : 'selectLayersByIndex';
+    const compo  = composition === undefined ? 'null' : escape(composition);
+    const value  = layerName ? escape(layerName) : layerIndex;
+    return (`nexrender.${method}(${compo}, ${value}, ${callbackString}, null, ${job.template.continueOnMissing});`);
+}
+
+module.exports = {
+    escape,
+    selectLayers,
+}

package/src/tasks/script/index.js

@@ -0,0 +1,52 @@
+const fs     = require('fs')
+const path   = require('path')
+const script = require('../../assets/nexrender.jsx')
+
+const wrapFootage = require('./wrap-footage')
+const wrapData    = require('./wrap-data')
+const wrapEnhancedScript = require('./wrap-enhanced-script')
+
+module.exports = (job, settings) => {
+    settings.logger.log(`[${job.uid}] running script assemble...`);
+
+    const data = [];
+    const base = job.workpath;
+
+    job.assets.map(asset => {
+        settings.trackCombined('Asset Script Wraps', {
+            job_id: job.uid, // anonymized internally
+            script_type: asset.type,
+            script_compostion_set: asset.composition !== undefined,
+            script_layer_strat: asset.layerName ? 'name' : 'index',
+            script_value_strat:
+                asset.value !== undefined ? 'value' : // eslint-disable-line no-nested-ternary, multiline-ternary
+                asset.expression !== undefined ? 'expression' : // eslint-disable-line multiline-ternary
+                undefined,
+        })
+
+        switch (asset.type) {
+            case 'video':
+            case 'audio':
+            case 'image':
+                data.push(wrapFootage(job, settings, asset));
+                break;
+
+            case 'data':
+                data.push(wrapData(job, settings, asset));
+                break;
+
+            case 'script':
+                data.push(wrapEnhancedScript(job, settings, asset));
+                break;
+        }
+    });
+
+    /* write out assembled custom script file in the workpath */
+    job.scriptfile = path.join(base, `nexrender-${job.uid}-script.jsx`);
+    fs.writeFileSync(job.scriptfile, script
+        .replace('/*COMPOSITION*/', job.template.composition)
+        .replace('/*USERSCRIPT*/', () => data.join('\n'))
+    );
+
+    return Promise.resolve(job)
+}

package/src/tasks/script/wrap-data.js

@@ -0,0 +1,22 @@
+const { selectLayers } = require('./helpers')
+
+const renderIf = (value, string) => {
+    const encoded = typeof value == 'string' ? escape(value) : JSON.stringify(value);
+    return value === undefined ? '' : string.replace('$value', () => encoded);
+}
+
+const partsOfKeypath = (keypath) => {
+    var parts = keypath.split('->');
+    return (parts.length === 1) ? keypath.split('.') : parts
+}
+
+const wrapData = (job, settings, { property, value, expression, ...asset }) => (`(function() {
+    ${selectLayers(job, asset, `function(layer) {
+        var parts = ${JSON.stringify(partsOfKeypath(property))};
+        ${renderIf(value, `var value = { "value": $value }`)}
+        ${renderIf(expression, `var value = { "expression": $value }`)}
+        nexrender.changeValueForKeypath(layer, parts, value);
+    }`)}
+})();\n`)
+
+module.exports = wrapData

package/src/tasks/script/wrap-enhanced-script.js

@@ -0,0 +1,25 @@
+const EnhancedScript = require('./EnhancedScript')
+
+/**
+ *   Wrap Enhanced Script
+ *   ====================
+ *   @author Dilip Ramírez (https://github.com/dukuo | https://notimetoexplain.co)
+ *   @autor Based on the work of Potat (https://github.com/dukuo/potat)
+ *   @description        Parse a script from a source, and injects a configuration object named ${keyword} based on the "parameters" array of the script asset if any.
+ *
+ *                       If parameters or functions deriving from the configuration object are being used in the script, but no parameters are set, then it succeeds but
+ *                       displays a warning with the missing JSX/JSON matches, and sets all the missing ones to null for a soft fault tolerance at runtime.
+ *
+ *   @param src                 The JSX script
+ *   @param parameters          (Array<Object>)  Argument array described in the Asset JSON object inside the Job description
+ *   @param keyword             (String)         Name for the exported variable holding configuration parameters. Defaults to NX as in NeXrender.
+ *   @param defaults.null  (Any)            The default value in case the user setted key name on any given `parameter` child object. Defaults to `null`
+ *
+ *   @return string             (String)         The compiled script with parameter injection outside its original scope to avoid user-defined defaults collision.
+ */
+const wrapEnhancedScript = (job, settings, { dest, src, parameters = [], keyword, defaults,  /* ...asset */ }) => {
+    const enhancedScript = new EnhancedScript(dest, src, parameters, keyword, defaults, job.uid, settings.logger);
+    return enhancedScript.build();
+}
+
+module.exports = wrapEnhancedScript

package/src/tasks/script/wrap-footage.js

@@ -0,0 +1,10 @@
+const { selectLayers } = require('./helpers')
+const { checkForWSL } = require('../../helpers/path')
+
+const wrapFootage = (job, settings, { dest, ...asset }) => (`(function() {
+    ${selectLayers(job, asset, `function(layer) {
+        nexrender.replaceFootage(layer, '${checkForWSL(dest.replace(/\\/g, "\\\\"), settings)}')
+    }`)}
+})();\n`)
+
+module.exports = wrapFootage

package/test/index.js

@@ -1,2 +1,2 @@
 // simple syntax test
-require('../src')
+require('../src')

package/src/tasks/script.js

@@ -1,471 +0,0 @@
-const fs     = require('fs')
-const path   = require('path')
-const script = require('../assets/nexrender.jsx')
-const matchAll = require('match-all')
-const { checkForWSL } = require('../helpers/path')
-
-/* helpers */
-const escape = str => {
-    str = JSON.stringify(str)
-    str = str.substring(1, str.length-1)
-    str = `'${str.replace(/'/g, '\\\'')}'`
-    return str
-}
-
-const selectLayers = (job, settings, { composition, layerName, layerIndex }, callbackString) => {
-    const method = layerName ? 'selectLayersByName' : 'selectLayersByIndex';
-    const compo  = composition === undefined ? 'null' : escape(composition);
-    const value  = layerName ? escape(layerName) : layerIndex;
-    return (`nexrender.${method}(${compo}, ${value}, ${callbackString}, null, ${job.template.continueOnMissing});`);
-}
-
-const renderIf = (value, string) => {
-    const encoded = typeof value == 'string' ? escape(value) : JSON.stringify(value);
-    return value === undefined ? '' : string.replace('$value', () => encoded);
-}
-
-const partsOfKeypath = (keypath) => {
-    var parts = keypath.split('->');
-    return (parts.length === 1) ? keypath.split('.') : parts
-}
-
-/* scripting wrappers */
-const wrapFootage = (job, settings, { dest, ...asset }) => (`(function() {
-    ${selectLayers(job, settings, asset, `function(layer) {
-        nexrender.replaceFootage(layer, '${checkForWSL(dest.replace(/\\/g, "\\\\"), settings)}')
-    }`)}
-})();\n`)
-
-const wrapData = (job, settings, { property, value, expression, ...asset }) => (`(function() {
-    ${selectLayers(job, settings, asset, `function(layer) {
-        var parts = ${JSON.stringify(partsOfKeypath(property))};
-        ${renderIf(value, `var value = { "value": $value }`)}
-        ${renderIf(expression, `var value = { "expression": $value }`)}
-        nexrender.changeValueForKeypath(layer, parts, value);
-    }`)}
-})();\n`)
-
-/**
- *   Wrap Enhanced Script
- *   ====================
- *   @author Dilip Ramírez (https://github.com/dukuo | https://notimetoexplain.co)
- *   @autor Based on the work of Potat (https://github.com/dukuo/potat)
- *   @description        Parse a script from a source, and injects a configuration object named ${keyword} based on the "parameters" array of the script asset if any.
- *
- *                       If parameters or functions deriving from the configuration object are being used in the script, but no parameters are set, then it succeeds but
- *                       displays a warning with the missing JSX/JSON matches, and sets all the missing ones to null for a soft fault tolerance at runtime.
- *
- *   @param src                 The JSX script
- *   @param parameters          (Array<Object>)  Argument array described in the Asset JSON object inside the Job description
- *   @param keyword             (String)         Name for the exported variable holding configuration parameters. Defaults to NX as in NeXrender.
- *   @param defaults.null  (Any)            The default value in case the user setted key name on any given `parameter` child object. Defaults to `null`
- *
- *   @return string             (String)         The compiled script with parameter injection outside its original scope to avoid user-defined defaults collision.
- */
-const wrapEnhancedScript = (job, settings, { dest, src, parameters = [], keyword, defaults,  /* ...asset */ }) => {
-    const jobID = job.uid;
-    let arg, fullMatch;
-
-    function EnhancedScript (
-            dest,
-            src,
-            parameters = [],
-            keyword = "NX",
-            defaults = {
-                global: "null",
-                string: "",
-                number: 0,
-                array: [],
-                boolean: false,
-                object: {},
-                function: function (){},
-                null: null
-            },
-            jobID,
-            logger
-    ) {
-        this.scriptPath = src;
-        this.script = fs.readFileSync(dest, 'utf8');
-        this.keyword = keyword;
-        this.defaults = defaults;
-        this.jobID = jobID;
-        this.logger = logger;
-        this.jsonParameters = parameters;
-
-        this.regexes = {
-            keywordUsage: null,
-            keywordInit: null,
-            fnDetect: null
-        };
-
-        this.missingJSONParams = [];
-
-        // Setup
-        this.setupRegexes();
-    }
-
-    /**
-     * Utilities, one-liners
-     */
-    EnhancedScript.prototype.getScriptPath = function()             { return this.scriptPath; }
-    EnhancedScript.prototype.getGetterMethod = function ()          { return "get"; }
-    EnhancedScript.prototype.getSetterMethod = function ()          { return "set"; }
-    EnhancedScript.prototype.getLogger = function ()                { return this.logger; }
-    EnhancedScript.prototype.getJSXScript = function ()             { return this.script; }
-    EnhancedScript.prototype.getJSONParams = function ()            { return this.jsonParameters; }
-    EnhancedScript.prototype.jsonParametersCount = function ()      { return this.jsonParameters.length; }
-    EnhancedScript.prototype.getMissingJSONParams = function()      { return this.missingJSONParams; }
-    EnhancedScript.prototype.countMissingJSONParams = function()    { return this.getMissingJSONParams().length; }
-    EnhancedScript.prototype.getKeyword = function ()               { return this.keyword; }
-    EnhancedScript.prototype.getFnArgsKeyword = function ()         { return this.fnArgsKeyword; }
-    EnhancedScript.prototype.getRegex = function (key)              { return this.regexes[key]; }
-
-    /**
-     * Get Default Value
-     * @description                Retrieves a default value parameter based on a key.
-     * @param key                  (String)("string"|"number"|"array"|"object"|"null"|"function") The key to the required default parameter. Defaults to "null".
-     * @returns default            The value from this.defaults array.
-     */
-    EnhancedScript.prototype.getDefaultValue = function(key) { return key in this.defaults ? this.defaults[key] : this.defaults[this.defaults.global]; }
-
-    /**
-     * Add Missing JSON Parameter
-     * =====================
-     * @description                Adds an object with the key of a parameter being used in JSX code but with no default in the JSON Asset.
-     * @param nxMatch              (Object) The object to add to the missing array.
-     *                             Required format:
-     *                             {
-     *                                 key: string
-     *                                 isVar: boolean
-     *                                 isFn: boolean
-     *                                 needsDefault: boolean.
-     *                             }
-     * @returns object             The recently added object.
-     */
-    EnhancedScript.prototype.addToMissingJsonParameter = function(nxMatch) { return this.missingJSONParams.push(nxMatch); }
-
-    /**
-     * End one-liners
-     */
-    EnhancedScript.prototype.setupRegexes = function() {
-        this.regexes.searchUsageByMethod = (method = "set", flags = "g") => {
-            const str = `(?<!(?:[\\/\\s]))(?<!(?:[\\*\\s]))(?:\\s*${this.getKeyword()}\\s*\\.)\\s*(${method})\\s*(?:\\()(?:["']{1})([a-zA-Z0-9._-]+)(?:["']{1})(?:\\))`;
-            return this.buildRegex(str, flags);
-        }
-
-        // Find instances of a function inside a single-line string.
-        this.regexes.fnDetect = new RegExp(/(?:(?:(?:function *(?:[a-zA-Z0-9_]+)?) *(?:\((?:.*)\)) *(?:\{(?:.*)\}))|(?:(?:.*) *(?:=>) *(?:\{)(?:.*?)?\}))/);
-
-        // This regex will detect a self-invoking function like (function(){})() and will catch the invoking parameters in a single string for further inspection.
-        this.regexes.selfInvokingFn = new RegExp(/(?:(?:^\() *(?:.*?)(?:} *\)))(?: *(?:\() *(.*?) *(?:\) *$))/);
-    }
-
-    EnhancedScript.prototype.escapeForRegex = function(str) {
-        return str.replace(/[.*+?^${}()|[\]\\]/g, '\\$&'); // $& means the whole matched string
-    }
-
-    EnhancedScript.prototype.stripComments = function (templateLiteral) {
-        return templateLiteral.replace(/\/\*[\s\S]*?\*\/|([^:]|^)\/\/.*$/gm, '');
-    }
-
-    EnhancedScript.prototype.buildRegex = function(templateLiteral, flags) {
-        return new RegExp(this.stripComments(templateLiteral).replace(/(\r\n|r\|\n|\s)/gm, ''), flags);
-    }
-
-    /**
-     * Parse method from parameter
-     * @description                    Given a parameter detect whether it should be casted as a function in the final argument injection.
-     * @param param                (string|number|boolean|null|object|array) The parameter to parse a method from.
-     * @return bool                (Boolean) If a method is detected then it's stripped from String quotes, else it's returned in it's original type.
-    */
-    EnhancedScript.prototype.isMethod = function (param) {
-        if (typeof param == "string") {
-            return (param.match(this.getRegex("fnDetect")) ? true : false);
-        }
-        return false
-    }
-
-    EnhancedScript.prototype.parseMethod = function (parameter) {
-        const selfInvokingFn = matchAll(parameter.value, this.getRegex('selfInvokingFn'));
-        if (selfInvokingFn ) {
-            this.getLogger().log(Array.from(selfInvokingFn));
-            return this.parseMethodWithArgs(parameter);
-        }
-        return parameter.value;
-    }
-
-    EnhancedScript.prototype.matchAsJSONParameterKey = function( key ) {
-        const parameterMatch = this.getJSONParams().find(o => o.key == key);
-        return parameterMatch ? parameterMatch.value : key;
-    }
-
-    EnhancedScript.prototype.parseMethodWithArgs = function (parameter) {
-        let value = parameter.value;
-        const methodArgs = matchAll(parameter.value, this.getRegex('searchUsageByMethod')('arg', "gm")).toArray();
-
-        if (methodArgs.length > 0 ) {
-            this.getLogger().log("We found a self-invoking method with arguments!");
-            this.getLogger().log(JSON.stringify(methodArgs));
-            const foundArgument = methodArgs.filter( argMatch => {
-                fullMatch = argMatch[0]
-                arg = argMatch[2]
-
-                return parameter.arguments && parameter.arguments.find(o => o.key == arg);
-            });
-
-
-            if (foundArgument) {
-                // Search if argument is present in JSON and has `arguments` array to match against the results.
-                // And do a replacement with either the found argument on the array or a global default value.
-                let argReplacement = parameter.arguments && parameter.arguments.find(o => o.key == arg).value || this.getStringifiedDefaultValue(this.defaults.global);
-                const fullMatchRegex = this.buildRegex(this.escapeForRegex(fullMatch), "gm");
-                value = parameter.value.replace(fullMatchRegex, argReplacement);
-            }
-        }
-
-        return value;
-    }
-
-    EnhancedScript.prototype.detectValueType = function (parameter) {
-        return this.isMethod(parameter.value) ? this.parseMethod(parameter) : JSON.stringify(parameter.value);
-    }
-
-    /**
-     * Get Default Value as String
-     * @description                Retrieves a default value parameter based on a key.
-     * @param key                  (String)("string"|"number"|"array"|"object"|"null"|"function") The key to the required default parameter. Defaults to "null".
-     * @returns default            (String) A template literal string with the embedded default parameter. If it's a string then it's wrapped with quotes.
-     */
-    EnhancedScript.prototype.getStringifiedDefaultValue = function (key) {
-        return JSON.stringify(this.getDefaultValue(key))
-    }
-
-    /**
-     * Strip comment blocks from Script [EXPERIMENTAL]
-     * ================================
-     * @description                Removes /* * / comments  from script to avoid mismatching occurrences.
-     * @param script               (String)            The target script to strip.
-     * @returns string             (String)            A one-line version of the original script without comment blocks.
-     */
-    EnhancedScript.prototype.stripCommentsFromScript = function (script) {
-        // https://levelup.gitconnected.com/advanced-regex-find-and-remove-multi-line-comments-in-your-code-c162ba6e5811
-        return script
-            .replace(/\n/g, " ")
-            .replace(/\/\*.*\*\//g, " ")
-            .replace(/\s+/g, " ")
-            .trim();
-    }
-
-    /*
-     * End Utilities
-     */
-
-    /**
-     * Find Missing Matches in JSX Script
-     * ====================
-     * @description                RegEx Searches a given JSX script to find occurences and saves an object with keys
-     * @param script               (String)            JSX script to find occurences in.
-     * @param regex                (Object)            RegEx object to match against JSX script.
-     * @param parameters           (Array<Object>)     Array with the parameters to compare against the matches.
-     * @return bool                (Boolean)           Whether or not there are any variables to inject. Defaults to false.
-     */
-    EnhancedScript.prototype.findMissingMatchesInJSX = function () {
-        const script = this.stripCommentsFromScript(this.getJSXScript());
-
-        // Parse all occurrences of the usage of NX on the provided script.
-        const nxMatches = matchAll(script, this.getRegex("searchUsageByMethod")("get", "gm")).toArray();
-
-        if (nxMatches && nxMatches.length > 0 ) {
-            nxMatches.forEach( match => {
-                const keyword = match[2];
-
-                var nxMatch = {
-                    key: keyword.replace(/\s/g, ''),
-                    isVar: false,
-                    isFn: false,
-                    value: this.getDefaultValue(match.default ? match.default : this.defaults.global)
-                };
-                if (this.getJSONParams().filter( o => o.key == nxMatch.key ).length == 0) { // If the parameter doesn't have a value defined in JSON
-                    this.addToMissingJsonParameter(nxMatch);
-                }
-            });
-        }
-
-        const missingJSONParameters = this.countMissingJSONParams();
-        if (missingJSONParameters > 0) {
-            this.getLogger().log(`[${jobID}] ${this.displayAlert()}`);
-        }
-        return missingJSONParameters > 0;
-    }
-
-
-    /**
-     * Generated Placeholder Parameters
-     * ================================
-     * @description            Generates placeholder for "parameters" JSON Object based on keys from an array.
-     * @param keys             (Array)     Array of strings. These should be the occurences of `keyword` variable use on the JSX script.
-     *
-     * @return string          (String)    JSON "parameters" object.
-     */
-     EnhancedScript.prototype.generatePlaceholderParameters = function ( ) {
-        const missingParams = this.getMissingJSONParams();
-
-        const template = (key) => `
-                {
-                    "key" : "${key}",
-                    "value" : ${this.getStringifiedDefaultValue(this.defaults.global)}
-                }\n
-        `;
-
-        return `
-            "parameters" : [
-                ${missingParams.map((k) => template(k.key)).join("\n")}
-            ]
-        `
-    }
-
-    /**
-     * Display Missing Alert
-     * =====================
-     * @description              Display a log message if theres any missing parameter set on the JSON configuration but is being referred in the script.
-     *
-     * @param missingParam      (Object)   Missing Parameters object. See below for its construction. Must have child objects `fn` and `vars`
-     * @param showJSXWarning    (Boolean)  Flag for whether or not to display warning about not initializing variable in JSX script. Defaults to false.
-     * @param injectionVar      (String)   Variable initialized with placeholder values. Defaults to "".
-     *
-     * @return string           (String)   The template literal string displaying all the occurences if any.
-    */
-    EnhancedScript.prototype.displayAlert = function () {
-        const keyword = this.getKeyword();
-
-        return ` -- W A R N I N G --
-        The following parameters used in the script were NOT found on the JSON "parameters" object of your script asset ${this.getScriptPath() }
-
-            ${this.getMissingJSONParams().map(o => o.key).join(", ")}
-
-        Please set defaults in your JSX script (see documentation) or copy the following placeholder JSON code snippet and replace the values with your own:
-
-        ${this.generatePlaceholderParameters()}
-
-        Remember to always use a fallback default value for any use of the ${keyword} object to have the ability to run this script on After Effects directly.
-        Example:
-            const dogName = ${keyword} && ${keyword}.${this.getGetterMethod()}("doggo") || "Doggo";
-        `
-    }
-
-    EnhancedScript.prototype.injectParameters = function () {
-        return [...this.getJSONParams(), ...this.getMissingJSONParams()].map( param => {
-            let value = param.type ? this.getStringifiedDefaultValue(param.type) : this.getDefaultValue(this.defaults.global);
-
-            if (param.value ) {
-                value = this.detectValueType(param);
-            }
-
-            return `${this.getKeyword()}.${this.getSetterMethod()}('${param.key}', ${value});`
-        }).join("\n");
-    }
-
-    EnhancedScript.prototype.buildParameterConfigurator = function () {
-        const defaultGlobalValue = this.getStringifiedDefaultValue( this.defaults.global );
-        // const defaultFnValue = this.getDefaultValue( this.defaults.function );
-        const createParameterConfigurator = () => `
-            function ParameterConfigurator () {
-                this.params = [];
-            }
-
-            ParameterConfigurator.prototype.set = function (k, v) {
-                this.params.push({
-                    key: k,
-                    value: v
-                });
-            };
-
-            ParameterConfigurator.prototype.call = function ( key, args ) {
-                for (var i = 0; i < this.params.length; i++) {
-                    if (this.params[i].key == key) {
-                        if (typeof this.params[i].value == "function") return this.params[i].value.apply(this, args && args.length > 0 ? args : []);
-                    }
-                }
-                return null;
-            }
-
-            ParameterConfigurator.prototype.get = function ( key, args ) {
-                for (var i = 0; i < this.params.length; i++) {
-                    if (this.params[i].key == key) {
-                        if (typeof this.params[i].value == "function") return this.call(key, args || []);
-                        return this.params[i].value;
-                    };
-                }
-                return ${ defaultGlobalValue }
-            };
-            var ${ this.getKeyword() } = new ParameterConfigurator();
-
-            // Parameter injection from job configuration
-            ${ this.injectParameters() }
-        `;
-
-        return createParameterConfigurator();
-    }
-
-    EnhancedScript.prototype.build = function () {
-        this.findMissingMatchesInJSX();
-
-        // Et voilà!
-        const enhancedScript = `(function() {
-            ${this.buildParameterConfigurator()}
-            ${this.getJSXScript()}
-        })();\n`;
-
-        // do not log the script (can be uncommented for debugging)
-        // this.getLogger().log(enhancedScript);
-        return enhancedScript;
-    }
-
-    const enhancedScript = new EnhancedScript(dest, src, parameters, keyword, defaults, jobID, settings.logger);
-    return enhancedScript.build();
-}
-
-module.exports = (job, settings) => {
-    settings.logger.log(`[${job.uid}] running script assemble...`);
-
-    const data = [];
-    const base = job.workpath;
-
-    job.assets.map(asset => {
-        settings.trackCombined('Asset Script Wraps', {
-            job_id: job.uid, // anonymized internally
-            script_type: asset.type,
-            script_compostion_set: asset.composition !== undefined,
-            script_layer_strat: asset.layerName ? 'name' : 'index',
-            script_value_strat:
-                asset.value !== undefined ? 'value' : // eslint-disable-line no-nested-ternary, multiline-ternary
-                asset.expression !== undefined ? 'expression' : // eslint-disable-line multiline-ternary
-                undefined,
-        })
-
-        switch (asset.type) {
-            case 'video':
-            case 'audio':
-            case 'image':
-                data.push(wrapFootage(job, settings, asset));
-                break;
-
-            case 'data':
-                data.push(wrapData(job, settings, asset));
-                break;
-
-            case 'script':
-                data.push(wrapEnhancedScript(job, settings, asset));
-                break;
-        }
-    });
-
-    /* write out assembled custom script file in the workpath */
-    job.scriptfile = path.join(base, `nexrender-${job.uid}-script.jsx`);
-    fs.writeFileSync(job.scriptfile, script
-        .replace('/*COMPOSITION*/', job.template.composition)
-        .replace('/*USERSCRIPT*/', () => data.join('\n'))
-    );
-
-    return Promise.resolve(job)
-}