@rhinostone/swig-twig 2.1.0 → 2.2.0

package/lib/filters.js

@@ -278,26 +278,33 @@ exports.raw.safe = true;
  * @param  {string} [type='html']  Pass `'js'` for JavaScript-safe escaping.
  * @return {string}
  */
+function escapeHtmlRest(ch) {
+  return ch === '<' ? '&lt;' : ch === '>' ? '&gt;' : ch === '"' ? '&quot;' : '&#39;';
+}
+
 exports.escape = function (input, type) {
-  var out = iterateFilter.apply(exports.escape, arguments),
-    inp = input,
-    i = 0,
-    code;
+  var t, inp, out, i, code;
 
-  if (out !== undefined) {
-    return out;
+  if (input === null || input === undefined) {
+    return input;
   }
 
-  if (typeof input !== 'string') {
+  t = typeof input;
+
+  if (t !== 'string') {
+    if (t === 'object') {
+      out = iterateFilter.apply(exports.escape, arguments);
+      if (out !== undefined) {
+        return out;
+      }
+    }
     return input;
   }
 
-  out = '';
-
-  switch (type) {
-  case 'js':
-    inp = inp.replace(/\\/g, '\\u005C');
-    for (i; i < inp.length; i += 1) {
+  if (type === 'js') {
+    inp = input.replace(/\\/g, '\\u005C');
+    out = '';
+    for (i = 0; i < inp.length; i += 1) {
       code = inp.charCodeAt(i);
       if (code < 32) {
         code = code.toString(16).toUpperCase();
@@ -315,14 +322,10 @@ exports.escape = function (input, type) {
       .replace(/\=/g, '\\u003D')
       .replace(/-/g, '\\u002D')
       .replace(/;/g, '\\u003B');
-
-  default:
-    return inp.replace(/&(?!amp;|lt;|gt;|quot;|#39;)/g, '&amp;')
-      .replace(/</g, '&lt;')
-      .replace(/>/g, '&gt;')
-      .replace(/"/g, '&quot;')
-      .replace(/'/g, '&#39;');
   }
+
+  return input.replace(/&(?!amp;|lt;|gt;|quot;|#39;)/g, '&amp;')
+    .replace(/[<>"']/g, escapeHtmlRest);
 };
 exports.e = exports.escape;
 

package/lib/index.js

@@ -185,6 +185,11 @@ exports.Twig = function (opts) {
    * (<code>{% extends parent_var %}</code>) are not pre-resolved and will
    * throw at render time as they would on the sync path.
    *
+   * @deprecated since 2.2.0 — use {@link Twig#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
    * twig.setDefaults({ loader: myAsyncLoader });
    * twig.renderFileAsync('page.twig', { name: 'world' }, function (err, output) {
@@ -245,6 +250,12 @@ exports.Twig = function (opts) {
    * <code>include</code>s resolve correctly without re-running the
    * pre-walk.
    *
+   * @deprecated since 2.2.0 — use {@link Twig#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
    * twig.compileFileAsync('page.twig', {}, function (err, fn) {
    *   if (err) { return done(err); }

package/lib/tags/from.js

@@ -30,6 +30,7 @@
  */
 
 var utils = require('@rhinostone/swig-core/lib/utils');
+var ir = require('@rhinostone/swig-core/lib/ir');
 var backend = require('@rhinostone/swig-core/lib/backend');
 var _dangerousProps = require('@rhinostone/swig-core/lib/security').dangerousProps;
 
@@ -135,11 +136,20 @@ exports.parse = function (str, line, parser, types, stack, opts, swig, token) {
     consume();
   }
 
+  var path = pathTok.match.replace(/^['"]|['"]$/g, '');
+
+  if (opts && opts.codegenMode === 'async') {
+    // Phase 2 (#T22): async mode skips parse-time parseFile + macro
+    // pre-render. compile() emits IRFromImportDeferred; runtime resolves
+    // the template via _swig.getTemplate and binds each entry on _ctx.
+    token.args = [{ path: path, entries: entries }];
+    return true;
+  }
+
   if (!swig || typeof swig.parseFile !== 'function') {
     utils.throwError('"from" tag requires an engine context with a loader', line, opts.filename);
   }
 
-  var path = pathTok.match.replace(/^['"]|['"]$/g, '');
   var parseOpts = { resolveFrom: opts.filename };
   var compileOpts = utils.extend({}, opts, parseOpts);
   var parsed = swig.parseFile(path, parseOpts);
@@ -195,7 +205,26 @@ exports.parse = function (str, line, parser, types, stack, opts, swig, token) {
  *                  `_ctx.<aliasName>`. Backend lifts it into
  *                  `IRLegacyJS`.
  */
-exports.compile = function (compiler, args) {
+exports.compile = function (compiler, args, content, parents, options) {
+  // Phase 2 (#T22): async-codegen branch. Parse stashed a single bundle
+  // `[{path, entries: [{origName, aliasName}, ...]}]` in async mode (no
+  // macro pre-render); emit IRFromImportDeferred so the backend's
+  // `_swig.getTemplate` + per-entry `_ctx.<bind>` assignment happens at
+  // runtime.
+  if (options && options.codegenMode === 'async') {
+    var bundle = args[0];
+    var imports = utils.map(bundle.entries, function (e) {
+      return {
+        name: e.origName,
+        alias: e.aliasName === e.origName ? null : e.aliasName
+      };
+    });
+    return ir.fromImportDeferred(
+      ir.literal('string', bundle.path),
+      imports,
+      options.filename || ''
+    );
+  }
   var allOrigNames = utils.map(args, function (arg) { return arg.origName; }).join('|');
   var replacements = utils.map(args, function (arg) {
     return {

package/lib/tags/import.js

@@ -31,6 +31,7 @@
  */
 
 var utils = require('@rhinostone/swig-core/lib/utils');
+var ir = require('@rhinostone/swig-core/lib/ir');
 var backend = require('@rhinostone/swig-core/lib/backend');
 var _dangerousProps = require('@rhinostone/swig-core/lib/security').dangerousProps;
 
@@ -109,11 +110,20 @@ exports.parse = function (str, line, parser, types, stack, opts, swig, token) {
     utils.throwError('Unexpected token "' + peek().match + '" after alias in "import" tag', line, opts.filename);
   }
 
+  var path = pathTok.match.replace(/^['"]|['"]$/g, '');
+
+  if (opts && opts.codegenMode === 'async') {
+    // Phase 2 (#T22): async mode skips the parse-time parseFile + macro
+    // pre-render. compile() emits IRImportDeferred; runtime resolves the
+    // template via _swig.getTemplate and binds .exports under the alias.
+    token.args = [path, aliasTok.match];
+    return true;
+  }
+
   if (!swig || typeof swig.parseFile !== 'function') {
     utils.throwError('"import" tag requires an engine context with a loader', line, opts.filename);
   }
 
-  var path = pathTok.match.replace(/^['"]|['"]$/g, '');
   var parseOpts = { resolveFrom: opts.filename };
   var compileOpts = utils.extend({}, opts, parseOpts);
   var parsed = swig.parseFile(path, parseOpts);
@@ -145,7 +155,17 @@ exports.parse = function (str, line, parser, types, stack, opts, swig, token) {
  * @return {string} JS source that initialises `_ctx.<alias>` and
  *                  assigns every imported macro into it.
  */
-exports.compile = function (compiler, args) {
+exports.compile = function (compiler, args, content, parents, options) {
+  // Phase 2 (#T22): async-codegen branch. Parse stashed `[path, alias]`
+  // in async mode (no macro pre-render); emit IRImportDeferred so the
+  // backend's `_swig.getTemplate` + `.exports` bind happens at runtime.
+  if (options && options.codegenMode === 'async') {
+    return ir.importDeferred(
+      ir.literal('string', args[0]),
+      args[args.length - 1],
+      options.filename || ''
+    );
+  }
   var ctx = args.pop();
   var allMacros = utils.map(args, function (arg) { return arg.name; }).join('|');
   var out = '_ctx.' + ctx + ' = {};\n  var _output = "";\n';

package/lib/tags/include.js

@@ -163,8 +163,17 @@ function sliceTrim(tokens, start, end, types) {
  * context emission, isolated-vs-merged selector, resolveFrom, optional
  * try/catch for ignoreMissing).
  *
- * @return {object} IRInclude node from `token.irExpr`.
+ * In async codegen mode (`options.codegenMode === 'async'`), derive an
+ * `IRIncludeDeferred` from the same fields so the backend routes through
+ * the `_swig.getTemplate` + `await` deferred-resolution path instead of
+ * the sync `_swig.compileFile` call.
+ *
+ * @return {object} IRInclude or IRIncludeDeferred node.
  */
 exports.compile = function (compiler, args, content, parents, options, blockName, token) {
+  if (options && options.codegenMode === 'async') {
+    var i = token.irExpr;
+    return ir.includeDeferred(i.path, i.context, i.isolated, i.ignoreMissing, i.resolveFrom);
+  }
   return token.irExpr;
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rhinostone/swig-twig",
-  "version": "2.1.0",
+  "version": "2.2.0",
   "description": "Twig-syntax frontend for the @rhinostone/swig-core template engine. Part of the @rhinostone/swig multi-flavor family.",
   "keywords": [
     "template",
@@ -22,7 +22,7 @@
     "node": ">=12"
   },
   "peerDependencies": {
-    "@rhinostone/swig-core": "2.1.0"
+    "@rhinostone/swig-core": "2.2.0"
   },
   "publishConfig": {
     "access": "public"