@rhinostone/swig 2.1.0 → 2.2.0

package/lib/swig.js

@@ -10,11 +10,11 @@ var utils = require('./utils'),
 /**
  * Swig version number as a string.
  * @example
- * if (swig.version === "2.1.0") { ... }
+ * if (swig.version === "2.2.0") { ... }
  *
  * @type {String}
  */
-exports.version = "2.1.0";
+exports.version = "2.2.0";
 
 /**
  * Swig Options Object. This object can be passed to many of the API-level Swig methods to control various aspects of the engine. All keys are optional.
@@ -201,6 +201,11 @@ exports.Swig = function (opts) {
    * pre-resolved and will throw at render time as they would on the sync
    * path.
    *
+   * @deprecated since 2.2.0 — use {@link Swig#renderFile} with a loader that
+   *   sets <code>loader.async === true</code>. The async-codegen dispatch
+   *   handles dynamic include paths the pre-walker cannot. This method will
+   *   be removed in 3.0.
+   *
    * @example
    * swig.setDefaults({ loader: myAsyncLoader });
    * swig.renderFileAsync('page.html', { name: 'world' }, function (err, output) {
@@ -260,6 +265,12 @@ exports.Swig = function (opts) {
    * temporarily swaps the loader on each call, so subsequent runtime
    * <var>include</var>s resolve correctly without re-running the pre-walk.
    *
+   * @deprecated since 2.2.0 — use {@link Swig#compileFile} with
+   *   <code>options.codegenMode === 'async'</code> on a loader that sets
+   *   <code>loader.async === true</code>. The returned compiled function
+   *   yields a <code>Promise&lt;{output, exports}&gt;</code> instead of a
+   *   string. This method will be removed in 3.0.
+   *
    * @example
    * swig.compileFileAsync('page.html', {}, function (err, fn) {
    *   if (err) { return done(err); }

package/lib/tags/import.js

@@ -1,4 +1,5 @@
 var utils = require('../utils'),
+  ir = require('@rhinostone/swig-core/lib/ir'),
   backend = require('@rhinostone/swig-core/lib/backend');
 
 // CVE-2023-25345: prototype-chain properties that must not be used as import
@@ -26,7 +27,19 @@ var _dangerousProps = require('@rhinostone/swig-core/lib/security').dangerousPro
  * @param {literal}     as        Literally, "as".
  * @param {literal}     varname   Local-accessible object name to assign the macros to.
  */
-exports.compile = function (compiler, args) {
+exports.compile = function (compiler, args, content, parents, options) {
+  // Phase 2 (#T22): async-codegen branch. Parse stashed `[{path}, alias]`
+  // (no macro pre-render in async mode); emit IRImportDeferred so the
+  // backend's `_swig.getTemplate` + `.exports` bind happens at runtime.
+  if (options && options.codegenMode === 'async') {
+    var asyncAlias = args[args.length - 1];
+    var asyncPath = args[0].path;
+    return ir.importDeferred(
+      ir.literal('string', asyncPath),
+      asyncAlias,
+      options.filename || ''
+    );
+  }
   var ctx = args.pop(),
     allMacros = utils.map(args, function (arg) {
       return arg.name;
@@ -56,37 +69,45 @@ exports.parse = function (str, line, parser, types, stack, opts, swig) {
   var compiler = require('../parser').compile,
     parseOpts = { resolveFrom: opts.filename },
     compileOpts = utils.extend({}, opts, parseOpts),
-    tokens,
+    isAsync = !!(opts && opts.codegenMode === 'async'),
+    importPath,
     ctx;
 
   parser.on(types.STRING, function (token) {
     var self = this;
-    if (!tokens) {
-      tokens = swig.parseFile(token.match.replace(/^("|')|("|')$/g, ''), parseOpts).tokens;
-      utils.each(tokens, function (token) {
-        var out = '',
-          macroName;
-        if (!token || token.name !== 'macro' || !token.compile) {
-          return;
-        }
-        macroName = token.args[0];
-        // Phase 2 (#T15): macro.compile now returns an IRMacro node
-        // rather than a JS source string. Render it through the shared
-        // backend so import.js still gets the JS source it performs
-        // regex-surgery on for namespace-prefixing. The +'\n' trailing
-        // newline matches the pre-Phase-2 compile output exactly.
-        out += backend.compile([token.compile(compiler, token.args, token.content, [], compileOpts)], [], compileOpts) + '\n';
-        self.out.push({compiled: out, name: macroName});
-      });
+    if (importPath !== undefined) {
+      throw new Error('Unexpected string ' + token.match + ' on line ' + line + '.');
+    }
+    importPath = token.match.replace(/^("|')|("|')$/g, '');
+
+    if (isAsync) {
+      // Async mode: skip the sync parseFile + macro pre-render. Stash
+      // just the path; compile() emits IRImportDeferred.
+      self.out.push({ path: importPath });
       return;
     }
 
-    throw new Error('Unexpected string ' + token.match + ' on line ' + line + '.');
+    var tokens = swig.parseFile(importPath, parseOpts).tokens;
+    utils.each(tokens, function (token) {
+      var out = '',
+        macroName;
+      if (!token || token.name !== 'macro' || !token.compile) {
+        return;
+      }
+      macroName = token.args[0];
+      // Phase 2 (#T15): macro.compile now returns an IRMacro node
+      // rather than a JS source string. Render it through the shared
+      // backend so import.js still gets the JS source it performs
+      // regex-surgery on for namespace-prefixing. The +'\n' trailing
+      // newline matches the pre-Phase-2 compile output exactly.
+      out += backend.compile([token.compile(compiler, token.args, token.content, [], compileOpts)], [], compileOpts) + '\n';
+      self.out.push({compiled: out, name: macroName});
+    });
   });
 
   parser.on(types.VAR, function (token) {
     var self = this;
-    if (!tokens || ctx) {
+    if (importPath === undefined || ctx) {
       throw new Error('Unexpected variable "' + token.match + '" on line ' + line + '.');
     }
 

package/lib/tags/include.js

@@ -48,6 +48,10 @@ exports.compile = function (compiler, args, content, parents, options, blockName
     }
   }
 
+  if (options && options.codegenMode === 'async') {
+    return ir.includeDeferred(file, w || undefined, !!onlyCtx, !!ignoreMissing, parentFile);
+  }
+
   return ir.include(file, w || undefined, !!onlyCtx, !!ignoreMissing, parentFile);
 };
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rhinostone/swig",
-  "version": "2.1.0",
+  "version": "2.2.0",
   "description": "A simple, powerful, and extendable templating engine for node.js and browsers, similar to Django, Jinja2, and Twig.",
   "keywords": [
     "template",
@@ -21,7 +21,7 @@
     "Rhinostone <contact@gina.io>"
   ],
   "dependencies": {
-    "@rhinostone/swig-core": "2.1.0",
+    "@rhinostone/swig-core": "2.2.0",
     "terser": "^5.46.1",
     "yargs": "^17.7.2"
   },