@inseefr/lunatic 2.7.6 → 2.7.7

package/lib/src/use-lunatic/commons/variables/lunatic-variables-store.d.ts

@@ -31,9 +31,10 @@ export declare class LunaticVariablesStore {
     /**
      * Register calculated variable
      */
-    setCalculated(name: string, expression: string, { dependencies, iterationDepth, }?: {
+    setCalculated(name: string, expression: string, { dependencies, iterationDepth, shapeFrom, }?: {
         dependencies?: string[];
         iterationDepth?: number;
+        shapeFrom?: string;
     }): LunaticVariable;
     /**
      * Run a VTL expression
@@ -60,12 +61,14 @@ declare class LunaticVariable {
     private readonly expression?;
     private readonly dictionary?;
     private readonly iterationDepth?;
+    private readonly shapeFrom?;
     private readonly name?;
     constructor(args?: {
         expression?: string;
         dependencies?: string[];
         dictionary?: Map<string, LunaticVariable>;
         iterationDepth?: number;
+        shapeFrom?: string;
         name?: string;
     });
     getValue(iteration?: IterationLevel): unknown;

package/lib/use-lunatic/commons/variables/lunatic-variables-store.js

@@ -84,13 +84,15 @@ var LunaticVariablesStore = exports.LunaticVariablesStore = /*#__PURE__*/functio
     value: function setCalculated(name, expression) {
       var _ref = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : {},
         dependencies = _ref.dependencies,
-        iterationDepth = _ref.iterationDepth;
+        iterationDepth = _ref.iterationDepth,
+        shapeFrom = _ref.shapeFrom;
       if (this.dictionary.has(name)) {
         return this.dictionary.get(name);
       }
       var variable = new LunaticVariable({
         expression: expression,
         dictionary: this.dictionary,
+        shapeFrom: shapeFrom,
         dependencies: dependencies,
         iterationDepth: iterationDepth,
         name: name
@@ -160,7 +162,8 @@ var LunaticVariablesStore = exports.LunaticVariablesStore = /*#__PURE__*/functio
             case 'CALCULATED':
               store.setCalculated(variable.name, variable.expression.value, {
                 dependencies: variable.bindingDependencies,
-                iterationDepth: getIterationDepth(variable.name)
+                iterationDepth: getIterationDepth(variable.name),
+                shapeFrom: variable.shapeFrom
               });
               break;
             case 'COLLECTED':
@@ -216,6 +219,8 @@ var LunaticVariable = /*#__PURE__*/function () {
     this.dictionary = void 0;
     // Specific iteration depth to get value from dependencies (used for yAxis for instance)
     this.iterationDepth = void 0;
+    // For calculated variable, shape is copied from another variable
+    this.shapeFrom = void 0;
     // Keep a record of variable name (optional, used for debug)
     this.name = void 0;
     if (args.expression && !args.dictionary) {
@@ -225,15 +230,34 @@ var LunaticVariable = /*#__PURE__*/function () {
     this.dictionary = args.dictionary;
     this.dependencies = args.dependencies;
     this.iterationDepth = args.iterationDepth;
+    this.shapeFrom = args.shapeFrom;
     this.name = (_args$name = args.name) !== null && _args$name !== void 0 ? _args$name : args.expression;
   }
   _createClass(LunaticVariable, [{
     key: "getValue",
     value: function getValue(iteration) {
+      var _this$dictionary,
+        _this = this,
+        _iteration;
       // The variable is not calculated
       if (!this.expression) {
         return this.getSavedValue(iteration);
       }
+      var shapeFromValue = this.shapeFrom ? (_this$dictionary = this.dictionary) === null || _this$dictionary === void 0 || (_this$dictionary = _this$dictionary.get(this.shapeFrom)) === null || _this$dictionary === void 0 ? void 0 : _this$dictionary.getValue() : null;
+      // If we want the root value of a calculated array, loop using the shapeFrom value
+      if (!iteration && Array.isArray(shapeFromValue)) {
+        return shapeFromValue.map(function (_, k) {
+          return _this.getValue([k]);
+        });
+      }
+
+      // For calculated variable, ignore iteration if shapeFrom exists and is not an array
+      if (
+      // We have a calculated variable (not a simple expression)
+      this.name !== this.expression && !Array.isArray(shapeFromValue)) {
+        iteration = undefined;
+      }
+
       // Calculate bindings first to refresh "updatedAt" on calculated dependencies
       var bindings = this.getDependenciesValues(iteration);
       if (!this.isOutdated(iteration)) {
@@ -248,7 +272,7 @@ var LunaticVariable = /*#__PURE__*/function () {
       } catch (e) {
         throw new Error("Cannot interpret expression \"".concat(this.expression, "\" with bindings ").concat(JSON.stringify(bindings), ", error : ").concat(e.toString()));
       }
-      this.calculatedAt.set(iteration === null || iteration === void 0 ? void 0 : iteration.join('.'), performance.now());
+      this.calculatedAt.set((_iteration = iteration) === null || _iteration === void 0 ? void 0 : _iteration.join('.'), performance.now());
       this.calculatedAt.set(undefined, performance.now());
       return this.getSavedValue(iteration);
     }
@@ -282,13 +306,13 @@ var LunaticVariable = /*#__PURE__*/function () {
   }, {
     key: "setValueForArray",
     value: function setValueForArray(value) {
-      var _this = this;
+      var _this2 = this;
       var savedValue = this.getSavedValue();
       var oldSize = Array.isArray(savedValue) ? savedValue.length : -1;
       var newSize = value.length;
       // Update every item of the array and look if we changed one item
       var oneValueChanged = (0, _array.times)(Math.max(oldSize, newSize), function (k) {
-        return _this.setValue(value[k], [k]);
+        return _this2.setValue(value[k], [k]);
       }).find(function (v) {
         return v;
       }) !== undefined;
@@ -334,21 +358,21 @@ var LunaticVariable = /*#__PURE__*/function () {
   }, {
     key: "getDependenciesValues",
     value: function getDependenciesValues(iteration) {
-      var _this2 = this;
+      var _this3 = this;
       try {
         return Object.fromEntries(this.getDependencies().map(function (dep) {
-          var _this2$dictionary, _this2$dictionary$get;
+          var _this3$dictionary, _this3$dictionary$get;
           if (dep === iterationVariableName && iteration) {
-            return [dep, iteration[0]];
+            return [dep, iteration[0] + 1];
           }
-          var dependencyIteration = (0, _number.isNumber)(_this2.iterationDepth) && Array.isArray(iteration) ? [iteration[_this2.iterationDepth]] : iteration;
+          var dependencyIteration = (0, _number.isNumber)(_this3.iterationDepth) && Array.isArray(iteration) ? [iteration[_this3.iterationDepth]] : iteration;
 
           // The variable is not registered in the variable dictionary
           // Happens when calculating unquoted VTL expression
-          if (!_this2.dictionary || !((_this2$dictionary = _this2.dictionary) !== null && _this2$dictionary !== void 0 && _this2$dictionary.has(dep))) {
-            throw new Error("Unknown variable \"".concat(dep, "\" in expression ").concat(_this2.expression));
+          if (!_this3.dictionary || !((_this3$dictionary = _this3.dictionary) !== null && _this3$dictionary !== void 0 && _this3$dictionary.has(dep))) {
+            throw new Error("Unknown variable \"".concat(dep, "\" in expression ").concat(_this3.expression));
           }
-          return [dep, (_this2$dictionary$get = _this2.dictionary.get(dep)) === null || _this2$dictionary$get === void 0 ? void 0 : _this2$dictionary$get.getValue(dependencyIteration)];
+          return [dep, (_this3$dictionary$get = _this3.dictionary.get(dep)) === null || _this3$dictionary$get === void 0 ? void 0 : _this3$dictionary$get.getValue(dependencyIteration)];
         }));
       } catch (e) {
         if (e instanceof RangeError) {
@@ -360,11 +384,11 @@ var LunaticVariable = /*#__PURE__*/function () {
   }, {
     key: "isOutdated",
     value: function isOutdated(iteration) {
-      var _this3 = this,
+      var _this4 = this,
         _this$calculatedAt$ge;
       var dependenciesUpdatedAt = Math.max.apply(Math, [0].concat(_toConsumableArray(this.getDependencies().map(function (dep) {
-        var _this3$dictionary$get, _this3$dictionary;
-        return (_this3$dictionary$get = (_this3$dictionary = _this3.dictionary) === null || _this3$dictionary === void 0 || (_this3$dictionary = _this3$dictionary.get(dep)) === null || _this3$dictionary === void 0 ? void 0 : _this3$dictionary.updatedAt.get(iteration === null || iteration === void 0 ? void 0 : iteration.join('.'))) !== null && _this3$dictionary$get !== void 0 ? _this3$dictionary$get : 0;
+        var _this4$dictionary$get, _this4$dictionary;
+        return (_this4$dictionary$get = (_this4$dictionary = _this4.dictionary) === null || _this4$dictionary === void 0 || (_this4$dictionary = _this4$dictionary.get(dep)) === null || _this4$dictionary === void 0 ? void 0 : _this4$dictionary.updatedAt.get(iteration === null || iteration === void 0 ? void 0 : iteration.join('.'))) !== null && _this4$dictionary$get !== void 0 ? _this4$dictionary$get : 0;
       }))));
       return dependenciesUpdatedAt > ((_this$calculatedAt$ge = this.calculatedAt.get(iteration === null || iteration === void 0 ? void 0 : iteration.join('.'))) !== null && _this$calculatedAt$ge !== void 0 ? _this$calculatedAt$ge : -1);
     }

package/lib/use-lunatic/commons/variables/lunatic-variables-store.spec.js

@@ -1,10 +1,10 @@
 "use strict";
 
 var _vitest = require("vitest");
-var _lunaticVariablesStore = require("./lunatic-variables-store");
-var _resizingBehaviour = require("./behaviours/resizing-behaviour");
 var _cleaningBehaviour = require("./behaviours/cleaning-behaviour");
 var _missingBehaviour = require("./behaviours/missing-behaviour");
+var _resizingBehaviour = require("./behaviours/resizing-behaviour");
+var _lunaticVariablesStore = require("./lunatic-variables-store");
 (0, _vitest.describe)('lunatic-variables-store', function () {
   var variables;
   (0, _vitest.beforeEach)(function () {
@@ -152,7 +152,8 @@ var _missingBehaviour = require("./behaviours/missing-behaviour");
       variables.set('FIRSTNAME', ['John', 'Jane']);
       variables.set('LASTNAME', ['Doe', 'Dae']);
       variables.setCalculated('FULLNAME', 'FIRSTNAME || " " || LASTNAME', {
-        dependencies: ['FIRSTNAME', 'LASTNAME']
+        dependencies: ['FIRSTNAME', 'LASTNAME'],
+        shapeFrom: 'FIRSTNAME'
       });
       (0, _vitest.expect)(variables.get('FULLNAME', [0])).toEqual('John Doe');
       (0, _vitest.expect)(variables.get('FULLNAME', [1])).toEqual('Jane Dae');
@@ -185,9 +186,18 @@ var _missingBehaviour = require("./behaviours/missing-behaviour");
     });
     (0, _vitest.it)('should handle global iteration variable', function () {
       variables.set('FIRSTNAME', ['John', 'Jane']);
-      variables.setCalculated('FULLNAME', 'FIRSTNAME || " " || cast(GLOBAL_ITERATION_INDEX, string)');
-      (0, _vitest.expect)(variables.get('FULLNAME', [0])).toEqual('John 0');
-      (0, _vitest.expect)(variables.get('FULLNAME', [1])).toEqual('Jane 1');
+      variables.setCalculated('FULLNAME', 'FIRSTNAME || " " || cast(GLOBAL_ITERATION_INDEX, string)', {
+        shapeFrom: 'FIRSTNAME'
+      });
+      (0, _vitest.expect)(variables.get('FULLNAME', [0])).toEqual('John 1');
+      (0, _vitest.expect)(variables.get('FULLNAME', [1])).toEqual('Jane 2');
+    });
+    (0, _vitest.it)('should handle shapeFrom correctly', function () {
+      variables.set('FIRSTNAME', ['John', 'Jane']);
+      variables.setCalculated('FULLNAME', 'FIRSTNAME || " " || cast(GLOBAL_ITERATION_INDEX, string)', {
+        shapeFrom: 'FIRSTNAME'
+      });
+      (0, _vitest.expect)(variables.get('FULLNAME')).toEqual(['John 1', 'Jane 2']);
     });
   });
   (0, _vitest.describe)('resizing', function () {

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@inseefr/lunatic",
-	"version": "2.7.6",
+	"version": "2.7.7",
 	"workersVersion": "0.3.0",
 	"description": "Library of questionnaire components",
 	"repository": {