@teamteanpm2024/maxime-unde-voluptas

angular's nicest part extracted as a standalone module for the browser and node.

@teamteanpm2024/maxime-unde-voluptas exposes a .compile()-method which can be used to compile evaluable expressions:

1var expressions = require("@teamteanpm2024/maxime-unde-voluptas");
2
3evaluate = expressions.compile("1 + 1");
4evaluate(); // returns 2

You can also set and get values on a given scope:

1evaluate = expressions.compile("name");
2scope = { name: "Jenny" };
3evaluate(scope); // returns 'Jenny'
4
5evaluate = expressions.compile("ship.pirate.name = 'Störtebeker'");
6evaluate(scope); // won't throw an error because angular's expressions are forgiving
7console.log(scope.ship.pirate.name); // prints 'Störtebeker'

For assigning values, you can also use .assign():

1evaluate = expressions.compile("ship.pirate.name");
2evaluate.assign(scope, "Störtebeker");
3console.log(scope.ship.pirate.name); // prints 'Störtebeker'

Check out their readme for further information.

Setup

Filters

Angular provides a mechanism to define filters on expressions:

1expressions.filters.uppercase = (input) => input.toUpperCase();
2
3expr = expressions.compile("'arr' | uppercase");
4expr(); // returns 'ARR'

Arguments are evaluated against the scope:

1expressions.filters.currency = (input, currency, digits) => {
2  input = input.toFixed(digits);
3
4  if (currency === "EUR") {
5    return input + "€";
6  } else {
7    return input + "$";
8  }
9};
10
11expr = expressions.compile("1.2345 | currency:selectedCurrency:2");
12expr({
13  selectedCurrency: "EUR",
14}); // returns '1.23€'

If you need an isolated filters object, this can be achieved by setting the filters attribute in the options argument. Global cache is disabled if using options.filters. To setup an isolated cache, you can also set the cache attribute in the options argument:

1var isolatedFilters = {
2  transform: (input) => input.toLowerCase(),
3};
4var isolatedCache = {};
5
6var resultOne = expressions.compile("'Foo Bar' | transform", {
7  filters: isolatedFilters,
8  cache: isolatedCache,
9});
10
11console.log(resultOne()); // prints 'foo bar'
12console.log(isolatedCache); // prints '{"'Foo Bar' | transform": [Function fn] }'

API

exports

.compile(src): Function

Compiles src and returns a function evaluate(). The compiled function is cached under compile.cache[src] to speed up further calls.

Compiles also export the AST.

Example output of: compile("tmp + 1").ast

{ type: 'Program',
  body:
   [ { type: 'ExpressionStatement',
       expression:
        { type: 'Identifier',
          name: 'tmp',
          constant: false,
          toWatch: [ [Circular] ] } } ],
  constant: false }

NOTE angular $parse do not export ast variable it's done by this library.

.compile.cache = Object.create(null)

A cache containing all compiled functions. The src is used as key. Set this on false to disable the cache.

.filters = {}

An empty object where you may define your custom filters.

.Lexer

The internal Lexer.

.Parser

The internal Parser.

---

evaluate(scope?): *

Evaluates the compiled src and returns the result of the expression. Property look-ups or assignments are executed on a given scope.

evaluate.assign(scope, value): *

Tries to assign the given value to the result of the compiled expression on the given scope and returns the result of the assignment.

In the browser

There is no dist build because it's not 2005 anymore. Use a module bundler like webpack or browserify. They're both capable of CommonJS and AMD.

Security

The code of angular was not secured from reading prototype, and since version 1.0.1 of @teamteanpm2024/maxime-unde-voluptas, the module disallows reading properties that are not ownProperties. See this blog post for more details about the sandbox that got removed completely in angular 1.6.

Comment from angular.js/src/ng/parse.js:

---

Angular expressions are generally considered safe because these expressions only have direct access to $scope and locals. However, one can obtain the ability to execute arbitrary JS code by obtaining a reference to native JS functions such as the Function constructor.

As an example, consider the following Angular expression:

1{}.toString.constructor(alert("evil JS code"))

We want to prevent this type of access. For the sake of performance, during the lexing phase we disallow any "dotted" access to any member named "constructor".

For reflective calls (a[b]) we check that the value of the lookup is not the Function constructor while evaluating the expression, which is a stronger but more expensive test. Since reflective calls are expensive anyway, this is not such a big deal compared to static dereferencing. This sandboxing technique is not perfect and doesn't aim to be. The goal is to prevent exploits against the expression language, but not to prevent exploits that were enabled by exposing sensitive JavaScript or browser apis on Scope. Exposing such objects on a Scope is never a good practice and therefore we are not even trying to protect against interaction with an object explicitly exposed in this way.

A developer could foil the name check by aliasing the Function constructor under a different name on the scope.

In general, it is not possible to access a Window object from an angular expression unless a window or some DOM object that has a reference to window is published onto a Scope.

---

Authorship

Kudos go entirely to the great angular.js team, it's their implementation!

Contributing

Suggestions and bug-fixes are always appreciated. Don't hesitate to create an issue or pull-request. All contributed code should pass

1. the tests in node.js by running npm test
2. the tests in all major browsers by running npm run test-browser and then visiting http://localhost:8080/bundle

License

Unlicense

Sponsors