Merge branch 'resilience-formulas'

Author: RafaelGB

docs/docs/features/Formulas.md

@@ -0,0 +1,18 @@
+## Formulas on dbfolder
+You can use formulas to create dynamic values in your database. 
+The formula is a javascript code that will be executed when the row is loaded.
+
+## How to use
+The code can be written in the column settings or in the note's metadata. 
+
+### Exposed variables
+- `row` : the row object
+- `db` : the database object with predefined functions that can be used in the formula
+- `config` : the table's config information
+
+To use an exposed variable, use the `${}` syntax. For example, to get the value of the `Name` column, you can use `${row.Name}`.
+
+### Exposed functions
+The root object `db` has the following functions:
+- `js` : execute a javascript function that you previously defined in the `js` folder of your table. (I.E.: `db.js.myFunction( arg1, arg2)`)
+

docs/docs/features/Properties.md

@@ -7,13 +7,13 @@
 - **Time**: this property accepts time with the format `YYYY-MM-DD hh:mm AM/PM` ;
 - **Select**: this property accepts from a list of options you define. Colors are attributed automatically, though you can change them in the column setting. Furthermore, when removing the select option in the setting, it is also removed from the note's metadata ;
 - **Tags**: similar to the previous property, but instead of only selecting one option, you can select multiples options per cell ;
+- **Formulas**: property that accepts js code to return dynamic values in function of your code. See the [Formulas](/docs/features/Formulas) section for more details.
 - **Image**: you can embed images in the `text` property in this format `![[image]]`. Make sure to enable `media links` in the column setting and adjust the dimensions too ;
 - **Created time**: this column can be added only once from the database settings and will display the created time of the row ;
 - **Modified time**: this column can be added only once from the database settings and will display the last modified time of the row ;
 - **Tasks**: this column can be added only once from the database settings and will display the task of the given file. You can also choose to hide the completed tasks in the column settings ;
 - **Inlinks**: this column can be added only once from the database settings and will display the files that have links to the select file ;
 - **Outlinks**: this column can be added only once from the database settings and will display the files that have links from the select file.
-
 > You can change from one property type to another, and if the format is right, it will be recognized by the plugin.
 
 ## YAML & Dataview Inline Fields

docs/mkdocs.yml

@@ -9,6 +9,7 @@ nav:
       - Properties: "features/Properties.md"
       - Notes: "features/Notes.md"
       - Viewing data: "features/Viewing data.md"
+      - Formulas: "features/Formulas.md"
   - About: "about.md"
   - FAQ: "faq.md"
   - Media:

src/automations/FormulaGenerator.ts

@@ -1,26 +1,23 @@
 import { FormulaFunctions } from "automations/formula_functions/FormulaFunctions";
 import { IGenerateObject } from "automations/IGenerateObject";
 import { LocalSettings } from "cdm/SettingsModel";
-import { RowDataType } from "cdm/FolderModel";
-import { Literal } from "obsidian-dataview";
 export class FormulaGenerator implements IGenerateObject {
-    public formula_functions: FormulaFunctions;
+    public js_functions: FormulaFunctions;
 
     constructor(private config: LocalSettings) {
-        this.formula_functions = new FormulaFunctions(config);
+        this.js_functions = new FormulaFunctions(config);
     }
 
-    private async generate_formula_functions(): Promise<Record<string, unknown>> {
+    private async generate_js_functions(): Promise<Record<string, unknown>> {
 
-        return await this.formula_functions.generate_object(this.config);
+        return await this.js_functions.generate_object(this.config);
     }
 
     async generate_object(): Promise<Record<string, unknown>> {
         const final_object: Record<string, any> = {};
         Object.assign(final_object, {
-            js: await this.generate_formula_functions(),
+            js: await this.generate_js_functions(),
         });
-        console.log("sasdinal_object");
         return final_object;
     }
 }

src/automations/formula_functions/ScriptFunctions.ts

@@ -50,18 +50,12 @@ export class UserScriptFunctions implements IGenerateObject {
         if (!formula_function) {
             const msg = `Failed to load user script ${file.path}. No exports detected.`;
             LOGGER.error(msg);
-            new Notice(
-                msg
-                , 3000);
-            throw new Error(msg);
+            return;
         }
         if (!(formula_function instanceof Function)) {
             const msg = `Failed to load user script ${file.path}. Default export is not a function.`
             LOGGER.error(msg);
-            new Notice(
-                msg
-                , 3000);
-            throw new Error(msg);
+            return;
         }
         user_script_functions.set(`${file.basename}`, formula_function);
     }

src/components/cellTypes/FormulaCell.tsx

@@ -1,26 +1,38 @@
 import { CellComponentProps } from "cdm/ComponentsModel";
 import { TableColumn } from "cdm/FolderModel";
+import { renderMarkdown } from "components/obsidianArq/MarkdownRenderer";
 import { c } from "helpers/StylesHelper";
-import React from "react";
+import React, { useEffect, useRef } from "react";
 
 const FormulaCell = (mdProps: CellComponentProps) => {
   const { defaultCell } = mdProps;
   const { cell, table, row, column } = defaultCell;
   const { tableState } = table.options.meta;
   const tableColumn = column.columnDef as TableColumn;
+  const formulaRef = useRef<HTMLDivElement>();
   const formulaRow = tableState.data((state) => state.rows[row.index]);
   const configInfo = tableState.configState((state) => state.info);
   const formulaInfo = tableState.automations((state) => state.info);
-  return (
-    <div className={`${c("md_cell")}`} key={`formula_${cell.id}`}>
-      {formulaInfo
+
+  useEffect(() => {
+    if (formulaRef.current !== null) {
+      formulaRef.current.innerHTML = "";
+      const formulaResponse = formulaInfo
         .runFormula(
           tableColumn.config.formula_query,
           formulaRow,
           configInfo.getLocalSettings()
         )
-        .toString()}
-    </div>
+        .toString();
+      renderMarkdown(defaultCell, formulaResponse, formulaRef.current, 5);
+    }
+  }, [row]);
+  return (
+    <span
+      ref={formulaRef}
+      className={`${c("md_cell")}`}
+      key={`formula_${cell.id}`}
+    />
   );
 };
 

src/helpers/QueryHelper.ts

@@ -5,7 +5,7 @@ import { LOGGER } from "services/Logger";
 export function generateDataviewTableQuery(columns: TableColumn[], fromQuery: string): string {
     return `TABLE ${columns
         .filter((col) => !col.isMetadata)
-        .map((col) => col.key)
+        .map((col) => `"${col.key}"`)
         .join(",")},${DatabaseCore.DATAVIEW_FILE},${DatabaseCore.FRONTMATTER_KEY} ${fromQuery}`
 }
 

src/parsers/RowDatabaseFieldsToFile.ts

@@ -40,4 +40,8 @@ function parseLiteralToString(literal: Literal, level: number, localSettings: Lo
         literalBlock.push(`${" ".repeat(level)}- ${DataviewService.parseLiteral(literal, InputType.MARKDOWN, localSettings)}`);
     }
     return literalBlock;
+}
+
+export function parseValuetoSanitizeYamlValue(value: string, localSettings: LocalSettings): string {
+    return DataviewService.parseLiteral(value, InputType.MARKDOWN, localSettings).toString();
 }

src/parsers/handlers/unmarshall/UnmarshallColumnsHandler.ts

@@ -2,12 +2,13 @@ import { DatabaseColumn } from "cdm/DatabaseModel";
 import { DiskHandlerResponse } from "cdm/MashallModel";
 import { InputType, YAML_INDENT } from "helpers/Constants";
 import { AbstractDiskHandler } from "parsers/handlers/unmarshall/AbstractDiskPropertyHandler";
+import { parseValuetoSanitizeYamlValue } from "parsers/RowDatabaseFieldsToFile";
 
 export class UnmarshallColumnsHandler extends AbstractDiskHandler {
     handlerName: string = 'columns';
 
     public handle(handlerResponse: DiskHandlerResponse): DiskHandlerResponse {
-        const { columns } = handlerResponse.yaml;
+        const { columns, config } = handlerResponse.yaml;
         // Lvl1: columns field group
         this.localDisk.push(`${this.handlerName}:`);
         for (const columnKey in columns) {
@@ -21,10 +22,7 @@ export class UnmarshallColumnsHandler extends AbstractDiskHandler {
                 .filter(key => typeof column[key] !== 'object')
                 .forEach(key => {
                     // Lvl3: literal column properties
-                    let value = column[key];
-                    if (typeof value === 'string') {
-                        value = `"${value}"`;
-                    }
+                    const value = parseValuetoSanitizeYamlValue(column[key]?.toString(), config);
                     this.localDisk.push(`${YAML_INDENT.repeat(2)}${key}: ${value}`);
                 });
 
@@ -33,7 +31,8 @@ export class UnmarshallColumnsHandler extends AbstractDiskHandler {
 
             // Lvl4: column config
             Object.keys(column.config).forEach(key => {
-                this.localDisk.push(`${YAML_INDENT.repeat(3)}${key}: ${column.config[key]}`);
+                const connfValue = parseValuetoSanitizeYamlValue(column.config[key]?.toString(), config);
+                this.localDisk.push(`${YAML_INDENT.repeat(3)}${key}: ${connfValue}`);
             });
         };
         return this.goNext(handlerResponse);
@@ -55,4 +54,4 @@ function unmarshallParticularInputInfo(column: DatabaseColumn): string[] {
             }
     }
     return particularInputString;
-}
+}

src/parsers/handlers/unmarshall/UnmarshallConfigHandler.ts

@@ -1,9 +1,8 @@
 import { DiskHandlerResponse } from "cdm/MashallModel";
-import { LocalSettings } from "cdm/SettingsModel";
-import { InputType, YAML_INDENT } from "helpers/Constants";
+import { YAML_INDENT } from "helpers/Constants";
 import { escapeSpecialCharacters } from "parsers/EscapeHelper";
 import { AbstractDiskHandler } from "parsers/handlers/unmarshall/AbstractDiskPropertyHandler";
-import { DataviewService } from "services/DataviewService";
+import { parseValuetoSanitizeYamlValue } from "parsers/RowDatabaseFieldsToFile";
 
 export class UnmarshallConfigHandler extends AbstractDiskHandler {
     handlerName: string = 'config';
@@ -17,19 +16,15 @@ export class UnmarshallConfigHandler extends AbstractDiskHandler {
                 this.localDisk.push(`${YAML_INDENT.repeat(1)}${key}:`);
                 Object.entries(valueConfig).forEach(([key, valueInternal]) => {
                     // Lvl3: config properties
-                    this.localDisk.push(`${YAML_INDENT.repeat(2)}${key}: ${parseValue(valueInternal as string, config)}`);
+                    this.localDisk.push(`${YAML_INDENT.repeat(2)}${key}: ${parseValuetoSanitizeYamlValue(valueInternal as string, config)}`);
                 });
             } else if (typeof valueConfig == "string") {
-                this.localDisk.push(`${YAML_INDENT.repeat(1)}${key}: ${parseValue(escapeSpecialCharacters(valueConfig), config)}`);
+                this.localDisk.push(`${YAML_INDENT.repeat(1)}${key}: ${parseValuetoSanitizeYamlValue(escapeSpecialCharacters(valueConfig), config)}`);
             } else {
                 // Lvl2: config properties
-                this.localDisk.push(`${YAML_INDENT.repeat(1)}${key}: ${parseValue(valueConfig, config)}`);
+                this.localDisk.push(`${YAML_INDENT.repeat(1)}${key}: ${parseValuetoSanitizeYamlValue(valueConfig, config)}`);
             }
         });
         return this.goNext(handlerResponse);
     }
-}
-
-function parseValue(value: string, localSettings: LocalSettings): string {
-    return DataviewService.parseLiteral(value, InputType.MARKDOWN, localSettings).toString();
 }