add comments

src/config/modules/_samples.js

@@ -0,0 +1 @@
+// for documentation about how to write module config see comments in "settings.js", in this folder

src/config/modules/settings.js

@@ -21,6 +21,13 @@ const ACTIVESET_DATE = 'date';
 const ACTIVESET_VALUE = 'value';
 //#endregion names
 
+// used by `sanitizeModuleData` function.
+// keys explanation:
+// - tableName: name of the table in the database
+// - columns: names of the columns in the table
+// - parsing: [OPTIONAL] parsing method for the column, done before sanitization
+// - sanitization: [OPTIONAL] sanitization method for the columns; if not present, the column will not be sanitized
+// - sanitizationOptions: [OPTIONAL] options for sanitization `sanitizeObj` function
 const tablesInfo = {
   Set: {
     tableName: SET,

src/lib/schema_sanitization_utils.js

@@ -305,6 +305,7 @@ function sanitize ({ value, sanitization, options, validate = false }) {
  * Any, object, function, class are ignored and returned as is.
  * Array are sanitized without cloning them.
  * A non-array value sanitized to array becomes an array with the value added as first element.
+ * Object keys missing from the sanitization object are ignored and not sanitized.
  * @param {Object} p
  * @param {*} p.obj - Object to sanitize
  * @param {*} p.sanitization - Sanitization object {key1: 'string', key2: 'number?'}

src/modules/_utils/sanitization_utils.js

@@ -7,7 +7,7 @@ import { ModuleData, schema, validateObj, sanitizeObj, eq2, parseYAML, parseJSON
  * Sanitize and parse values of moduleData tables in place (without cloning moduleData).
  * tableName is matched between moduleData and moduleSanitization in a case insensitive & trim way.
  * sanitization and parsing is also done in a case insensitive & trim way, matching the keys of the object to sanitize to the sanitization object keys.
- * parsing is done before sanitization, with YAML or JSON5 (values from config/modules/_const.js)
+ * parsing is done before sanitization, with YAML or JSON5 (values from config/modules/_const.js), only for the keys specified in the sanitization object.
  * @param {Object} p
  * @param {ModuleData} p.moduleData
  * @param {{tableName: string, parsing: *, sanitization: *, sanitizationOptions?: *}[]} p.moduleSanitization
@@ -22,6 +22,7 @@ function sanitizeModuleData ({ moduleData, moduleSanitization }) {
   for (const _table of moduleData.tables) {
     // search for `_table.tableName` in `moduleSanitization` array (in a case insensitive way); if not found, `_pss` is undefined
     // if found, `_pss` contains the parsing and sanitization settings object for the table
+    /** @type {{tableName: string, parsing: *, sanitization: *, sanitizationOptions?: *} | undefined} */
     const _pss = moduleSanitization.find(_ => eq2(_.tableName, _table.tableName));
 
     // if `_pss` has a value, parse and sanitize `_table.table` with it