@nexrender/core 1.33.0 → 1.37.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nexrender/core",
-  "version": "1.33.0",
+  "version": "1.37.1",
   "main": "src/index.js",
   "author": "Inlife",
   "scripts": {
@@ -29,5 +29,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "6f3bdccfa13723b3b43552193871973ab395d428"
+  "gitHead": "64843b65edec658d2716a07c3b1fe331f09ed117"
 }

package/readme.md

@@ -36,6 +36,11 @@ const main = async () => {
         skipCleanup: true,
         addLicense: false,
         debug: true,
+        actions: {
+            "custom-action": (job, settings, {input, params}, type) => {
+                // Custom action code
+            }
+        },
     })
 }
 
@@ -66,3 +71,4 @@ Second one is responsible for mainly job-related operations of the full cycle: d
 * `addLicense` - boolean, providing false will disable ae_render_only_node.txt license file auto-creation (true by default)
 * `forceCommandLinePatch` - boolean, providing true will force patch re-installation
 * `onInstanceSpawn` - a callback, if provided, gets called when **aerender** instance is getting spawned, with instance pointer. Can be later used to kill a hung aerender process. Callback signature: `function (instance, job, settings) {}`
+* `actions` - an object with keys corresponding to the `module` field when defining an action, value should be a function matching expected signature of an action. Used for defining actions programmatically without needing to package the action as a separate package

package/src/helpers/patch.js

@@ -33,8 +33,8 @@ module.exports = (settings) => {
     if (data.indexOf('nexrender-patch') !== -1) {
         settings.logger.log('command line patch already is in place')
 
-        const patchedMatch = patched.match(/nexrender-patch-v([0-9\.]+)/)
-        const existingMatch = data.match(/nexrender-patch-v([0-9\.]+)/)
+        const patchedMatch = patched.match(/nexrender-patch-v([0-9.]+)/)
+        const existingMatch = data.match(/nexrender-patch-v([0-9.]+)/)
 
         if (patchedMatch[1] !== existingMatch[1]) {
             try {

package/src/index.js

@@ -48,7 +48,7 @@ const init = (settings) => {
     const binaryUser = settings.binary && fs.existsSync(settings.binary) ? settings.binary : null;
 
     if (!binaryUser && !binaryAuto) {
-        throw new Error('you should provide a proper path to After Effects\' \"aerender\" binary')
+        throw new Error('you should provide a proper path to After Effects\' "aerender" binary')
     }
 
     if (binaryAuto && !binaryUser) {

package/src/tasks/actions.js

@@ -21,9 +21,13 @@ module.exports = actionType => (job, settings) => {
     settings.logger.log(`[${job.uid}] applying ${actionType} actions...`);
 
     return PromiseSerial((job.actions[actionType] || []).map(action => () => {
-        return requireg(action.module)(job, settings, action, actionType).catch(err => {
-            return Promise.reject(new Error(`Error loading ${actionType} module ${action.module}: ${err}`))
-        });
+        if(settings.actions && settings.actions[action.module]){
+            return settings.actions[action.module](job, settings, action, actionType);
+        }else{
+            return requireg(action.module)(job, settings, action, actionType).catch(err => {
+                return Promise.reject(new Error(`Error loading ${actionType} module ${action.module}: ${err}`));
+            });
+        }
     })).then(() => {
         return Promise.resolve(job)
     });

package/src/tasks/cleanup.js

@@ -1,5 +1,3 @@
-const fs     = require('fs')
-const path   = require('path')
 const rimraf = require('rimraf')
 
 /**
@@ -11,7 +9,7 @@ module.exports = function(job, settings) {
         return Promise.resolve(job)
     }
 
-    return new Promise((resolve, reject) => {
+    return new Promise((resolve) => {
         settings.logger.log(`[${job.uid}] cleaning up...`);
 
         rimraf(job.workpath, {glob: false}, (err) => {

package/src/tasks/download.js

@@ -13,8 +13,9 @@ const requireg = require('requireg')
 const download = (job, settings, asset) => {
     if (asset.type == 'data') return Promise.resolve();
 
+    // eslint-disable-next-line
     const uri = global.URL ? new URL(asset.src) : url.parse(asset.src)
-    const protocol = uri.protocol.replace(/\:$/, '');
+    const protocol = uri.protocol.replace(/:$/, '');
     let destName = '';
 
     /* if asset doesnt have a file name, make up a random one */
@@ -23,7 +24,7 @@ const download = (job, settings, asset) => {
     } else {
         destName = path.basename(asset.src)
         destName = destName.indexOf('?') !== -1 ? destName.slice(0, destName.indexOf('?')) : destName;
-        /* ^ remove possible query search string params ^ */;
+        /* ^ remove possible query search string params ^ */
 
         /* prevent same name file collisions */
         if (fs.existsSync(path.join(job.workpath, destName))) {
@@ -61,12 +62,11 @@ const download = (job, settings, asset) => {
                     reject(err)
                 }
             });
-            break;
 
         case 'http':
         case 'https':
             /* TODO: maybe move to external package ?? */
-            const src = decodeURI(asset.src) === asset.src ? encodeURI(asset.src): asset.src
+            const src = decodeURI(asset.src) === asset.src ? decodeURI(asset.src): asset.src
             return fetch(src, asset.params || {})
                 .then(res => res.ok ? res : Promise.reject({reason: 'Initial error downloading file', meta: {src, error: res.error}}))
                 .then(res => {
@@ -77,14 +77,13 @@ const download = (job, settings, asset) => {
 
                        asset.extension = fileExt
                         const destHasExtension = path.extname(asset.dest) ? true : false
-                        //don't do this if asset.dest already has extension else it gives you example.jpg.jpg  like file in case of  assets and aep/aepx file 
+                        //don't do this if asset.dest already has extension else it gives you example.jpg.jpg  like file in case of  assets and aep/aepx file
                         if (asset.extension && !destHasExtension) {
                             asset.dest += `.${fileExt}`
                         }
                     }
 
                     const stream = fs.createWriteStream(asset.dest)
-                    let timer
 
                     return new Promise((resolve, reject) => {
                         const errorHandler = (error) => {
@@ -100,7 +99,6 @@ const download = (job, settings, asset) => {
                             .on('finish', resolve)
                     })
                 });
-            break;
 
         case 'file':
             const filepath = uri2path(expandEnvironmentVariables(asset.src))
@@ -125,7 +123,6 @@ const download = (job, settings, asset) => {
                 wr.end()
                 throw error
             })
-            break;
 
         /* custom/external handlers */
         default:
@@ -134,13 +131,12 @@ const download = (job, settings, asset) => {
                 return requireg('@nexrender/provider-' + protocol).download(job, settings, asset.src, asset.dest, asset.params || {});
             } catch (e) {
                 if (e.message.indexOf('Could not require module') !== -1) {
-                    return Promise.reject(new Error(`Couldn\'t find module @nexrender/provider-${protocol}, Unknown protocol provided.`))
+                    return Promise.reject(new Error(`Couldn't find module @nexrender/provider-${protocol}, Unknown protocol provided.`))
                 }
 
                 throw e;
             }
 
-            break;
     }
 }
 
@@ -156,5 +152,5 @@ module.exports = function(job, settings) {
         job.assets.map(asset => download(job, settings, asset))
     )
 
-    return Promise.all(promises).then(_ => job);
+    return Promise.all(promises).then(() => job);
 }

package/src/tasks/render.js

@@ -29,7 +29,7 @@ module.exports = (job, settings) => {
     let outputFile = expandEnvironmentVariables(job.output)
     let projectFile = expandEnvironmentVariables(job.template.dest)
 
-    outputFileAE = checkForWSL(outputFile, settings)
+    const outputFileAE = checkForWSL(outputFile, settings)
     projectFile = checkForWSL(projectFile, settings)
     let jobScriptFile = checkForWSL(job.scriptfile, settings)
 
@@ -62,7 +62,7 @@ module.exports = (job, settings) => {
     }
 
     if (settings['aeParams']) {
-        for (param of settings['aeParams']) {
+        for (const param of settings['aeParams']) {
             let ps = param.split(" ");
 
             if (ps.length > 0) {

package/src/tasks/script.js

@@ -8,7 +8,7 @@ const { checkForWSL } = require('../helpers/path')
 const escape = str => {
     str = JSON.stringify(str)
     str = str.substring(1, str.length-1)
-    str = `'${str.replace(/\'/g, '\\\'')}'`
+    str = `'${str.replace(/'/g, '\\\'')}'`
     return str
 }
 
@@ -50,9 +50,9 @@ const wrapData = ({ property, value, expression, ...asset }) => (`(function() {
 })();\n`)
 
 // @deprecated in favor of wrapEnhancedScript (implementation below)
-const wrapScript = ({ dest }) => (`(function() {
-    ${fs.readFileSync(dest, 'utf8')}
-})();\n`)
+// const wrapScript = ({ dest }) => (`(function() {
+//     ${fs.readFileSync(dest, 'utf8')}
+// })();\n`)
 
 
 /*
@@ -72,7 +72,8 @@ const wrapScript = ({ dest }) => (`(function() {
 
     @return string             (String)         The compiled script with parameter injection outside its original scope to avoid user-defined defaults collision.
 */
-const wrapEnhancedScript = ({ dest, src, parameters = [], keyword, defaults,  ...asset }, jobID, settings) => {
+const wrapEnhancedScript = ({ dest, src, parameters = [], keyword, defaults,  /* ...asset */ }, jobID, settings) => {
+    let arg, fullMatch;
 
     function EnhancedScript (
             dest,
@@ -238,7 +239,8 @@ const wrapEnhancedScript = ({ dest, src, parameters = [], keyword, defaults,  ..
             this.getLogger().log("We found a self-invoking method with arguments!");
             this.getLogger().log(JSON.stringify(methodArgs));
             const foundArgument = methodArgs.filter( argMatch => {
-                [fullMatch, method, arg] = argMatch;
+                fullMatch = argMatch[0]
+                arg = argMatch[2]
 
                 return parameter.arguments && parameter.arguments.find(o => o.key == arg);
             });
@@ -315,7 +317,7 @@ const wrapEnhancedScript = ({ dest, src, parameters = [], keyword, defaults,  ..
         if (nxMatches && nxMatches.length > 0 ) {
 
             nxMatches.forEach( match => {
-                const [fullMatch, method, keyword] = match;
+                const keyword = match[2];
 
                 var nxMatch = {
                     key: keyword.replace(/\s/g, ''),
@@ -357,7 +359,7 @@ const wrapEnhancedScript = ({ dest, src, parameters = [], keyword, defaults,  ..
 
         return `
             "parameters" : [
-                ${missingParams.map((k, i) => template(k.key)).join("\n")}
+                ${missingParams.map((k) => template(k.key)).join("\n")}
             ]
         `
     }
@@ -406,7 +408,7 @@ const wrapEnhancedScript = ({ dest, src, parameters = [], keyword, defaults,  ..
     EnhancedScript.prototype.buildParameterConfigurator = function ()               {
 
         const defaultGlobalValue = this.getStringifiedDefaultValue( this.defaults.global );
-        const defaultFnValue = this.getDefaultValue( this.defaults.function );
+        // const defaultFnValue = this.getDefaultValue( this.defaults.function );
         const createParameterConfigurator = () => `
     function ParameterConfigurator () {
         this.params = [];

package/src/tasks/setup.js

@@ -1,5 +1,4 @@
 const os      = require('os')
-const fs      = require('fs')
 const path    = require('path')
 const mkdirp  = require('mkdirp')
 const assert  = require('assert')

package/test/mytest.js

@@ -1,9 +1,7 @@
-module.exports = (job, settings) => {
+module.exports = (job, /* settings */) => {
     console.log('custom module hello world!')
     return Promise.resolve(job)
 }
 
-const url = require('url');
-
 console.log(new URL('d:/Documents/resource.txt'))
 console.log(new URL('data:text/plain;base64,SGVsbG8sIFdvcmxkIQ%3D%3D'))