new source from pages()

Author: RafaelGB

src/helpers/Constants.ts

@@ -291,6 +291,7 @@ export const SourceDataTypes = Object.freeze({
   OUTGOING_LINK: 'outgoing_link',
   INCOMING_LINK: 'incoming_link',
   QUERY: 'query',
+  QUERY_JS: 'query_js',
 });
 
 export const CellSizeOptions = Object.freeze({

src/helpers/VaultManagement.ts

@@ -115,13 +115,16 @@ export async function sourceDataviewPages(ddbbConfig: LocalSettings, folderPath:
   try {
     switch (ddbbConfig.source_data) {
       case SourceDataTypes.TAG:
-        pagesResult = DataviewService.getDataviewAPI().pages(`${ddbbConfig.source_form_result.split(',').join(' OR ')}`);
+        pagesResult = obtainPagesResult(`${ddbbConfig.source_form_result.split(',').join(' OR ')}`);
         break;
       case SourceDataTypes.INCOMING_LINK:
-        pagesResult = DataviewService.getDataviewAPI().pages(`[[${ddbbConfig.source_form_result}]]`);
+        pagesResult = obtainPagesResult(`[[${ddbbConfig.source_form_result}]]`);
         break;
       case SourceDataTypes.OUTGOING_LINK:
-        pagesResult = DataviewService.getDataviewAPI().pages(`outgoing([[${ddbbConfig.source_form_result}]])`);
+        pagesResult = obtainPagesResult(`outgoing([[${ddbbConfig.source_form_result}]])`);
+        break;
+      case SourceDataTypes.QUERY_JS:
+        pagesResult = obtainPagesResult(ddbbConfig.source_form_result);
         break;
       case SourceDataTypes.QUERY:
         pagesResult = await obtainQueryResult(
@@ -130,6 +133,7 @@ export async function sourceDataviewPages(ddbbConfig: LocalSettings, folderPath:
             ddbbConfig.source_form_result)
         );
         break;
+
       case SourceDataTypes.CURRENT_FOLDER_WITHOUT_SUBFOLDERS:
         if (!folderPath || folderPath === '/') {
           pagesResult = DataviewService.getDataviewAPI().pages()
@@ -151,6 +155,10 @@ export async function sourceDataviewPages(ddbbConfig: LocalSettings, folderPath:
   return pagesResult;
 }
 
+function obtainPagesResult(pageQuery: string): DataArray<Record<string, Literal>> {
+  return DataviewService.getDataviewAPI().pages(pageQuery);
+}
+
 async function obtainQueryResult(query: string): Promise<DataArray<Record<string, Literal>>> {
   const result = await DataviewService.getDataviewAPI().query(query);
   if (!result.successful || result.value.type !== 'table') {

src/lang/locale/en.ts

@@ -32,6 +32,7 @@ export default {
   "outgoing_link": "Outgoing link",
   "incoming_link": "Incoming link",
   "query": "Dataview query",
+  "query_js": "Dataview query (JS Pages)",
   /** COMMAND OPTIONS */
   "active_go_next_page": "Go to next page",
   "active_go_previous_page": "Go to previous page",
@@ -347,6 +348,12 @@ export default {
   "settings_source_form_query_button_tooltip": "Validate query",
   "settings_source_form_query_notice_validate": "Dataview query '{0}' is valid!",
   "settings_source_form_query_notice_error": "Dataview query '{0}' is invalid: {1}",
+  "settings_source_form_query_js_title": "Pages dv query",
+  "settings_source_form_query_js_desc": "Introduce `dv.pages()` content. Check dataview documentation for more info.",
+  "settings_source_form_query_js_placeholder": "#myTag | `\"myFolderPath\"`",
+  "settings_source_form_query_js_button_tooltip": "Validate pages content",
+  "settings_source_form_query_js_notice_validate": "Pages content is valid!",
+  "settings_source_form_query_js_notice_error": "The content of `dv.pages()` is invalid: {0}",
   "settings_source_form_destination_title": "Select destination folder",
   "settings_source_form_destination_desc": "Select the destination of new entries for this source",
   "settings_source_form_destination_placeholder": "Example: folder1/folder2",

src/lang/locale/es.ts

@@ -26,6 +26,7 @@ export default {
     "outgoing_link": "Enlace saliente",
     "incoming_link": "Enlace entrante",
     "query": "Consulta de Dataview",
+    "query_js": "Consulta de Dataview (JS Pages)",
     /** COMMAND OPTIONS */
     "active_go_next_page": "Ir a la página siguiente",
     "active_go_previous_page": "Ir a la página anterior",

src/lang/locale/fr.ts

@@ -26,6 +26,7 @@ export default {
   "outgoing_link": "Lien sortant",
   "incoming_link": "Lien entrant",
   "query": "Requête Dataview",
+  "query_js": "Requête JS Dataview (Pages)",
   /** COMMAND OPTIONS */
   "active_go_next_page": "Aller à la page suivante",
   "active_go_previous_page": "Aller à la page précédente",

src/settings/handlers/source/SourceFormHandler.ts

@@ -29,6 +29,9 @@ export class SourceFormHandler extends AbstractSettingsHandler {
             case SourceDataTypes.QUERY:
                 this.queryHandler(view, containerEl, columns);
                 break;
+            case SourceDataTypes.QUERY_JS:
+                this.queryJsHandler(view, containerEl);
+                break;
             default:
             //Current folder
         }
@@ -97,5 +100,41 @@ export class SourceFormHandler extends AbstractSettingsHandler {
             });
         destinationFolderSetting(view, containerEl);
     }
+
+    private queryJsHandler(view: DatabaseView, containerEl: HTMLElement) {
+        const query_promise = async (value: string): Promise<void> => {
+            if (this.sourceFormResultTimeout) {
+                clearTimeout(this.sourceFormResultTimeout);
+            }
+            this.sourceFormResultTimeout = setTimeout(() => {
+                // update settings
+                view.diskConfig.yaml.config.source_form_result = value;
+                view.diskConfig.updateConfig({ source_form_result: value });
+            }, 1500);
+
+        };
+
+        new Setting(containerEl)
+            .setName(t("settings_source_form_query_js_title"))
+            .setDesc(t("settings_source_form_query_js_desc"))
+            .addTextArea((textArea) => {
+                textArea.inputEl.addClass(c("textarea-setting"));
+                textArea.setValue(view.diskConfig.yaml.config.source_form_result);
+                textArea.setPlaceholder(t("settings_source_form_query_js_placeholder"));
+                textArea.onChange(query_promise);
+            }).addExtraButton((cb) => {
+                cb.setIcon("check")
+                    .setTooltip(t("settings_source_form_query_js_button_tooltip"))
+                    .onClick(async (): Promise<void> => {
+                        try {
+                            DataviewService.getDataviewAPI().pages(view.diskConfig.yaml.config.source_form_result);
+                            new Notice(t("settings_source_form_query_js_notice_validate"), 2000);
+                        } catch (e) {
+                            new Notice(t("settings_source_form_query_js_notice_error", e.message), 10000);
+                        }
+                    });
+            });
+        destinationFolderSetting(view, containerEl);
+    }
 }