Merge branch 'master' into imed-docu-branch

Author: RafaelGB

docs/docs/changelog.md

@@ -1,4 +1,7 @@
 
+## 2.8.0
+### Shiny new things
+- Added video examples to the docs for each section [imeed166](https://github.com/imeed166)
 ## 2.7.4
 ### Shiny new things
 - names of tags are now editable (updating all the related rows) [ISSUE#443](https://github.com/RafaelGB/obsidian-db-folder/issues/443)

package.json

@@ -19,25 +19,25 @@
 	"license": "MIT",
 	"devDependencies": {
 		"@faker-js/faker": "7.6.0",
-		"@rollup/plugin-commonjs": "23.0.0",
-		"@rollup/plugin-json": "5.0.0",
-		"@rollup/plugin-node-resolve": "15.0.0",
-		"@rollup/plugin-replace": "5.0.0",
-		"@rollup/plugin-typescript": "9.0.1",
+		"@rollup/plugin-commonjs": "23.0.2",
+		"@rollup/plugin-json": "5.0.1",
+		"@rollup/plugin-node-resolve": "15.0.1",
+		"@rollup/plugin-replace": "5.0.1",
+		"@rollup/plugin-typescript": "9.0.2",
 		"@testing-library/jest-dom": "5.16.5",
 		"@testing-library/react": "13.4.0",
-		"@types/jest": "29.1.2",
-		"@types/luxon": "3.0.1",
-		"@types/node": "18.11.0",
+		"@types/jest": "29.2.0",
+		"@types/luxon": "3.0.2",
+		"@types/node": "18.11.4",
 		"@types/react": "18.0.21",
 		"@types/react-csv": "1.1.3",
 		"@types/react-datepicker": "4.4.2",
 		"@types/react-dom": "18.0.6",
 		"@types/react-window": "1.8.5",
-		"@typescript-eslint/eslint-plugin": "5.40.0",
-		"@typescript-eslint/parser": "5.40.0",
+		"@typescript-eslint/eslint-plugin": "5.40.1",
+		"@typescript-eslint/parser": "5.40.1",
 		"eslint": "8.25.0",
-		"jest": "29.2.0",
+		"jest": "29.2.1",
 		"jest-mock-extended": "3.0.1",
 		"obsidian": "0.16.3",
 		"rollup": "2.79.1",
@@ -50,7 +50,7 @@
 	"dependencies": {
 		"@emotion/styled": "11.10.4",
 		"@mui/icons-material": "5.10.9",
-		"@mui/material": "5.10.9",
+		"@mui/material": "5.10.10",
 		"@popperjs/core": "2.11.6",
 		"@tanstack/match-sorter-utils": "8.5.14",
 		"@tanstack/react-table": "8.5.15",
@@ -64,8 +64,8 @@
 		"react-datepicker": "4.8.0",
 		"react-dom": "18.2.0",
 		"react-popper": "2.3.0",
-		"react-select": "5.5.0",
+		"react-select": "5.5.4",
 		"react-window": "1.8.7",
-		"zustand": "4.1.2"
+		"zustand": "4.1.3"
 	}
 }

src/automations/AutomationsHelper.ts

@@ -1,6 +1,5 @@
 import { LocalSettings } from "cdm/SettingsModel";
 import { FormulaGenerator } from "automations/FormulaGenerator";
-import { AutomationError, showDBError } from "errors/ErrorTypes";
 
 export async function obtainFormulasFromFolder(config: LocalSettings) {
     const generator = new FormulaGenerator(config);

src/automations/FormulaGenerator.ts

@@ -1,6 +1,9 @@
 import { FormulaFunctions } from "automations/formula_functions/FormulaFunctions";
 import { IGenerateObject } from "automations/IGenerateObject";
 import { LocalSettings } from "cdm/SettingsModel";
+import { Link } from "obsidian-dataview";
+import { DataviewService } from "services/DataviewService";
+import Rollup from "automations/Rollup";
 export class FormulaGenerator implements IGenerateObject {
     public js_functions: FormulaFunctions;
 
@@ -9,15 +12,17 @@ export class FormulaGenerator implements IGenerateObject {
     }
 
     private async generate_js_functions(): Promise<Record<string, unknown>> {
-
         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_js_functions(),
-        });
+            dataview: DataviewService.getDataviewAPI(),
+            rollup: (relation: Link[], action?: string, key?: string) => new Rollup(relation, action, key)
+        }
+        );
         return final_object;
     }
 }

src/automations/Rollup.ts

@@ -0,0 +1,87 @@
+import { DEFAULT_SETTINGS, InputType, ROLLUP_ACTIONS } from "helpers/Constants";
+import { Link, Literal } from "obsidian-dataview";
+import { DataviewService } from "services/DataviewService";
+import { LOGGER } from "services/Logger";
+import { ParseService } from "services/ParseService";
+
+class Rollup {
+    private pages: Record<string, Literal>[];
+    private action: string;
+    private key: string;
+
+    static generatePages(relation: Link[]): Record<string, Literal>[] {
+        return relation.map((link) =>
+            DataviewService.getDataviewAPI().page(link.path)
+        );
+    }
+
+    constructor(relation: Link[], action?: string, key?: string) {
+        const consultedLinks = Rollup.generatePages(relation);
+        this.pages = consultedLinks;
+        this.action = action;
+        this.key = key;
+    }
+
+    public dispatch(): string {
+        let result = "";
+        switch (this.action) {
+            case ROLLUP_ACTIONS.SUM:
+                result = this.sum();
+                break;
+            case ROLLUP_ACTIONS.COUNT_ALL:
+                result = this.countAll();
+                break;
+            case ROLLUP_ACTIONS.ORIGINAL_VALUE:
+                result = this.originalValue();
+                break;
+            default:
+                // No valid action found
+                LOGGER.warn(`No valid action found for rollup: ${this.action}`);
+        }
+        return result;
+    }
+
+    public getPages(): Record<string, Literal>[] {
+        return this.pages;
+    }
+
+    /**
+     * Iters over the pages and sums the values of the key
+     * @returns 
+     */
+    private sum(): string {
+        // Check if key is not truthy, return empty string
+        if (!this.key) {
+            return "";
+        }
+        let sum = 0;
+        this.pages.forEach((page) => {
+            if (page[this.key]) {
+                sum += Number(page[this.key]);
+            }
+        });
+        return sum.toString();
+    }
+
+    /**
+     * Obtains the number of pages of the relation with the key informed
+     * @returns 
+     */
+    private countAll(): string {
+        return this.pages.filter((page) => page[this.key]).length.toString();
+    }
+
+    /**
+     * Returns the original value map of the pages with the key informed
+     * @returns 
+     */
+    private originalValue(): string {
+        // TODO use local settings of the table instead of default settings
+        return this.pages
+            .filter((page) => page[this.key])
+            .map((page) => ParseService.parseLiteral(page[this.key], InputType.MARKDOWN, DEFAULT_SETTINGS.local_settings)).join(", ");
+    }
+
+}
+
+export default Rollup;

src/cdm/ComponentsModel.ts

@@ -1,6 +1,6 @@
 import { CellContext, Table } from "@tanstack/react-table";
 import { RowDataType } from "cdm/FolderModel";
-import { Literal } from "obsidian-dataview/lib/data-model/value";
+import { Link, Literal } from "obsidian-dataview/lib/data-model/value";
 import { AtomicFilter } from "cdm/SettingsModel";
 
 export type RowSelectOption = {
@@ -22,6 +22,11 @@ export type EditorCellComponentProps = {
     textCell: string;
 } & CellComponentProps;
 
+export type RelationEditorComponentProps = {
+    persistChange: (newPath: string[]) => void;
+    relationCell: Link[];
+} & CellComponentProps;
+
 export type DataviewFiltersProps = {
     table: Table<RowDataType>;
 };

src/cdm/DatabaseModel.ts

@@ -3,7 +3,7 @@ import { FilterSettings, LocalSettings } from "cdm/SettingsModel";
 import { Literal } from "obsidian-dataview/lib/data-model/value";
 import { TableOptions } from "@tanstack/react-table";
 import { BaseColumn, RowDataType } from "cdm/FolderModel";
-import { DateTime, SMarkdownPage, STask } from "obsidian-dataview";
+import { SMarkdownPage } from "obsidian-dataview";
 
 /** database column */
 export interface DatabaseColumn extends BaseColumn {

src/cdm/FolderModel.ts

@@ -49,6 +49,13 @@ export interface ConfigColumn {
     // Formulas
     formula_query?: string;
     persist_formula?: boolean;
+    // Relations
+    related_note_path?: string;
+    // Rollups
+    asociated_relation_id?: string;
+    rollup_action?: string;
+    rollup_key?: string;
+    persist_rollup?: boolean;
     /** Extras from yaml */
     [key: string]: Literal;
 }
@@ -62,7 +69,6 @@ export type BaseColumn = {
     config: ConfigColumn;
     /** Circunstancial */
     nestedKey?: string;
-    options?: RowSelectOption[];
     csvCandidate?: boolean;
     width?: number;
     position?: number;
@@ -73,7 +79,10 @@ export type BaseColumn = {
     isHidden?: boolean;
     skipPersist?: boolean;
     isDragDisabled?: boolean;
+    // Selects & Tags
+    options?: RowSelectOption[];
 }
+
 export type TableColumn = ColumnDef<RowDataType, Literal> & BaseColumn;
 
 export type RowDataType = {

src/cdm/TableStateInterface.ts

@@ -1,8 +1,8 @@
 import { ColumnOrderState, SortingState } from "@tanstack/react-table";
-import { RowDataType, TableColumn } from "cdm/FolderModel";
+import { ConfigColumn, RowDataType, TableColumn } from "cdm/FolderModel";
 import { FilterSettings, GlobalSettings, LocalSettings } from "cdm/SettingsModel";
 import { DatabaseView } from "DatabaseView";
-import { Literal } from "obsidian-dataview";
+import { Link, Literal } from "obsidian-dataview";
 import { StoreApi, UseBoundStore } from "zustand";
 
 export type TableActionResponse<T> = {
@@ -60,7 +60,7 @@ export interface ColumnsState {
         addToRight: (column: TableColumn, customName?: string) => void;
         remove: (column: TableColumn) => void;
         alterSorting: (column: TableColumn) => void;
-        addOptionToColumn: (column: TableColumn, option: string, backgroundColor: string) => Promise<void>;
+        addOptionToColumn: (column: TableColumn, option: string, backgroundColor: string) => void;
         alterColumnType: (column: TableColumn, input: string, parsedRows?: RowDataType[]) => Promise<void>;
         alterColumnId: (column: TableColumn, root: string, nestedIds: string[]) => Promise<void>;
         alterColumnLabel: (column: TableColumn, label: string) => Promise<void>;
@@ -92,6 +92,7 @@ export interface AutomationState {
     info: {
         getFormula: (name: string) => unknown;
         runFormula: (input: string, row: RowDataType, dbbConfig: LocalSettings) => Literal;
+        dispatchRollup: (configColumn: ConfigColumn, relation: Link[], dbbConfig: LocalSettings) => Literal;
     },
     actions: {
         loadFormulas: (ddbbConfig: LocalSettings) => Promise<void>;

src/components/DefaultCell.tsx

@@ -14,6 +14,8 @@ import TextCell from "components/cellTypes/TextCell";
 import MetadataTimeCell from "components/cellTypes/MetadataTimeCell";
 import InOutLinksCell from "components/cellTypes/InOutLinksCell";
 import FormulaCell from "components/cellTypes/FormulaCell";
+import RelationCell from "components/cellTypes/RelationCell";
+import RollupCell from "components/cellTypes/RollupCell";
 import { CellContext } from "@tanstack/react-table";
 import { Literal } from "obsidian-dataview";
 
@@ -78,6 +80,14 @@ export default function DefaultCell(
       case InputType.FORMULA:
         return <FormulaCell defaultCell={defaultCell} />;
 
+      /** Relation with another ddbb */
+      case InputType.RELATION:
+        return <RelationCell defaultCell={defaultCell} />;
+
+      /** Rollup info of a relation */
+      case InputType.ROLLUP:
+        return <RollupCell defaultCell={defaultCell} />;
+
       /** New column option */
       case InputType.NEW_COLUMN:
         // Do nothing