Event Automations 1.21.0 update

Author: dwertheimer

dwertheimer.EventAutomations/CHANGELOG.md

@@ -4,6 +4,10 @@ README: [How to use AutoTimeBlocking](https://noteplan.co/n/#/1EF12392-B544-4044
 
 ## What's New in AutoTimeBlocking
 
+## [1.21.0] 2024-05-26 @dwertheimer
+
+- added MANUAL_ORDERING mode (for @Thor)
+
 ## [1.20.0] 2024-02-23 @dwertheimer - thx @Werwowolf
 
 - Feature: add named timeframes in settings (e.g. "morning", "early", "afternoon") and a task tagged with #afternoon will get placed there

dwertheimer.EventAutomations/plugin.json

@@ -5,8 +5,8 @@
   "plugin.name": "🗓 AutoTimeBlocking / Events",
   "plugin.description": "Various Event Automations:\n- Automatically find time in your calendar and create Time Blocks for items marked for today,\n- Write out synced copies of Today's todos (without the AutoTimeBlocking), and\n- Create calendar events for all text items under a specific heading",
   "plugin.author": "dwertheimer",
-  "plugin.version": "1.20.0",
-  "plugin.lastUpdateInfo": "1.20.0: Add timeframes tags to have tasks placed in a time of day (see readme). Also Sort todos by priority then date (oldest to newest), then duration. Bug fix: Ignore backlinks which are not todos",
+  "plugin.version": "1.21.0",
+  "plugin.lastUpdateInfo": "1.21.0: Add Manual Ordering mode (orders todos in today's note by the order in the note) -- feature request from @Thor\n Previously:\n- Add timeframes tags to have tasks placed in a time of day (see readme). Also Sort todos by priority then date (oldest to newest), then duration. Bug fix: Ignore backlinks which are not todos",
   "plugin.dependencies": [],
   "plugin.script": "script.js",
   "plugin.url": "https://noteplan.co/n/#/1EF12392-B544-4044-AC7A-428F57EB2DFC",
@@ -345,9 +345,10 @@
       "choices": [
         "PRIORITY_FIRST",
         "LARGEST_FIRST",
-        "BY_TIMEBLOCK_TAG"
+        "BY_TIMEBLOCK_TAG",
+        "MANUAL_ORDERING"
       ],
-      "description": "PRIORITY_FIRST places the highest priority (most !'s) first (if there's a slot) and then continues down the priority stack. LARGEST_FIRST tries to place the longest/largest duration item first. BY_TIMEBLOCK_TAG will try to slot items into a pre-existing timeblock that matches a tag on the task (e.g. a pre-existing timeblock called \"production\" and a task \"* do something #production\"). Will then fall back to PRIORITY_FIRST if no matching timeblock is found.",
+      "description": "PRIORITY_FIRST places the highest priority (most !'s) first (if there's a slot) and then continues down the priority stack. LARGEST_FIRST tries to place the longest/largest duration item first. BY_TIMEBLOCK_TAG will try to slot items into a pre-existing timeblock that matches a tag on the task (e.g. a pre-existing timeblock called \"production\" and a task \"* do something #production\"). Will then fall back to PRIORITY_FIRST if no matching timeblock is found. MANUAL_ORDERING limits tasks to ones in today's note and orders them in the order they appear in the note.",
       "default": "PRIORITY_FIRST",
       "required": true
     },

dwertheimer.EventAutomations/src/NPTimeblocking.js

@@ -298,13 +298,17 @@ export async function insertSyncedCopiesOfTodayTodos(passBackResults?: string):
     await saveEditorIfNecessary()
     logDebug(pluginJson, `insertSyncedCopiesOfTodayTodos after saveEditorIfNecessary`)
     const start = Editor.selection?.start // try to keep it from scrolling to end of doc
-    const todosParagraphs = await getTodaysFilteredTodos(config)
-    clof(todosParagraphs, 'insertSyncedCopiesOfTodayTodos todosParagraphs', ['filename', 'content'], true)
+    const todosParagraphs = await getTodaysFilteredTodos(config, true)
+    clof(todosParagraphs, 'insertSyncedCopiesOfTodayTodos todosParagraphs', ['filename', 'type', 'content'], true)
     const sortedParasExcludingCurrentNote = sortListBy(
       todosParagraphs.filter((p) => p.filename !== Editor.filename),
       'content',
     )
-    clof(sortedParasExcludingCurrentNote, 'insertSyncedCopiesOfTodayTodos sortedParasExcludingCurrentNote', ['filename', 'content'])
+    clof(sortedParasExcludingCurrentNote, 'insertSyncedCopiesOfTodayTodos sortedParasExcludingCurrentNote ${sortedParasExcludingCurrentNote.length} items', [
+      'filename',
+      'type',
+      'content',
+    ])
     if (passBackResults && /[Yy]es/.test(passBackResults)) {
       // called from a template, so send a string back
       const syncedList = getSyncedCopiesAsList(sortedParasExcludingCurrentNote)
@@ -445,7 +449,7 @@ export async function markDoneAndRecreateTimeblocks(incoming: string | null = nu
  * @param {AutoTimeBlockingConfig} config - The configuration object for auto time blocking.
  * @param {Object} pluginJson - Plugin metadata for logging purposes.
  */
-function initializeAndLogStart(config: AutoTimeBlockingConfig, pluginJson: Object): void {
+function initializeAndLogStart(config: AutoTimeBlockingConfig): void {
   const { timeBlockTag } = config
 
   // Log the start of the operation with the current time
@@ -468,7 +472,7 @@ function initializeAndLogStart(config: AutoTimeBlockingConfig, pluginJson: Objec
  * @param {Object} pluginJson - Plugin metadata for logging purposes.
  * @returns {Array<TParagraph>} - The sorted list of todo items, ready for time block allocation.
  */
-function categorizeAndSortTasks(todosWithLinks: $ReadOnlyArray<TParagraph>, pluginJson: Object): Array<SortableParagraphSubset> {
+function categorizeAndSortTasks(todosWithLinks: $ReadOnlyArray<TParagraph>, config: AutoTimeBlockingConfig): Array<SortableParagraphSubset> {
   if (todosWithLinks.length === 0) {
     logDebug(pluginJson, `No todos to categorize and sort.`)
     return []
@@ -481,7 +485,8 @@ function categorizeAndSortTasks(todosWithLinks: $ReadOnlyArray<TParagraph>, plug
   // Combine open and scheduled tasks, then sort by priority
   const openOrScheduledForToday = [...(tasksByType.open ?? []), ...(tasksByType.scheduled ?? [])]
   clof(openOrScheduledForToday, `categorizeAndSortTasks openOrScheduledForToday`, ['filename', 'type', 'content'], true)
-  const sortedTodos = sortListBy(openOrScheduledForToday, ['-priority', 'filename', '-duration'])
+  const sortKeys = config.mode === 'MANUAL_ORDERING' ? ['lineIndex'] : ['-priority', 'filename', '-duration']
+  const sortedTodos = sortListBy(openOrScheduledForToday, sortKeys)
   clof(sortedTodos, `categorizeAndSortTasks sortedTodos`, ['priority', 'filename', 'duration', 'content'], true)
   logDebug(pluginJson, `After sortListBy, sorted ${sortedTodos.length} tasks by priority.`)
 
@@ -499,7 +504,7 @@ function categorizeAndSortTasks(todosWithLinks: $ReadOnlyArray<TParagraph>, plug
  * @param {Object} pluginJson - Plugin metadata for logging and debugging.
  * @returns {Promise<?Array<string>>} - The results to be passed back, if any.
  */
-function handleNoTodosOrResults(passBackResults: boolean, timeBlockTextList: ?Array<string>, pluginJson: Object): Array<string> {
+function handleNoTodosOrResults(passBackResults: boolean, timeBlockTextList: ?Array<string>): Array<string> {
   // Check if there are no todos or results to pass back
   if (!passBackResults) {
     const message =
@@ -574,12 +579,16 @@ async function generateTimeBlocks(
 ): Promise<{ blockList: Array<string>, noTimeForTasks: Object, timeBlockTextList: Array<string> }> {
   // Generate a populated time map for today
   const calendarMapWithEvents = await getPopulatedTimeMapForToday(dateStr, config.intervalMins, config)
-  logDebug(pluginJson, `After getPopulatedTimeMapForToday, ${calendarMapWithEvents.length} timeMap slots`)
-
+  logDebug(pluginJson, `generateTimeBlocks: After getPopulatedTimeMapForToday, ${calendarMapWithEvents.length} timeMap slots`)
+  clof(sortedTodos, `generateTimeBlocks sortedTodos`, ['lineIndex', 'content'], true)
   // Calculate time blocks for events based on the populated time map and sorted todo tasks
   const eventsToTimeblock = getTimeBlockTimesForEvents(calendarMapWithEvents, sortedTodos, config)
-  logDebug(pluginJson, `After getTimeBlockTimesForEvents`)
-
+  logDebug(
+    pluginJson,
+    `generateTimeBlocks after getTimeBlockTimesForEvents; eventsToTimeblock.timeMap.length=${eventsToTimeblock.timeMap.length}, eventsToTimeblock.blockList.length=${
+      eventsToTimeblock.blockList.length
+    } eventsToTimeblock.timeBlockTextList.length=${eventsToTimeblock?.timeBlockTextList?.toString() || ''}`,
+  )
   // Prepare the list of text entries for time blocks
   const { blockList, noTimeForTasks } = eventsToTimeblock
   let { timeBlockTextList } = eventsToTimeblock
@@ -610,26 +619,26 @@ async function generateTimeBlocks(
  */
 export async function createTimeBlocksForTodaysTasks(config: AutoTimeBlockingConfig = getConfig(), completedItems: Array<TParagraph> = []): Promise<?Array<string>> {
   // Step 1: Initialize and log start
-  initializeAndLogStart(config, pluginJson)
+  initializeAndLogStart(config)
 
   // Step 2: Fetch and prepare todos
-  const cleanTodayTodoParas = await gatherAndPrepareTodos(config, completedItems, pluginJson)
+  const cleanTodayTodoParas = await gatherAndPrepareTodos(config, completedItems)
 
   // Step 3: Categorize and sort tasks
-  const sortedTodos = categorizeAndSortTasks(cleanTodayTodoParas, pluginJson)
+  const sortedTodos = categorizeAndSortTasks(cleanTodayTodoParas, config)
 
   // Step 4: Generate time blocks
   const dateStr = getDateStringFromCalendarFilename(Editor.filename) // Assuming this utility function exists and is accurate
   if (!dateStr) {
-    return handleNoTodosOrResults(config.passBackResults || false, null, pluginJson)
+    return handleNoTodosOrResults(config.passBackResults || false, null)
   }
 
-  const { blockList, noTimeForTasks, timeBlockTextList } = await generateTimeBlocks(sortedTodos, dateStr, config, pluginJson)
+  const { blockList, noTimeForTasks, timeBlockTextList } = await generateTimeBlocks(sortedTodos, dateStr, config)
 
   // Check if time blocks were successfully generated
   if (blockList.length === 0 && Object.keys(noTimeForTasks).length === 0) {
     // If no blocks were created and no tasks are without time, handle accordingly
-    return handleNoTodosOrResults(config.passBackResults || false, null, pluginJson)
+    return handleNoTodosOrResults(config.passBackResults || false, null)
   }
 
   // Step 5: Insert and finalize time blocks
@@ -640,5 +649,5 @@ export async function createTimeBlocksForTodaysTasks(config: AutoTimeBlockingCon
   }
 
   // Step 6: Handle no todos or results scenario and return results
-  return handleNoTodosOrResults(config.passBackResults || false, timeBlockTextList, pluginJson)
+  return handleNoTodosOrResults(config.passBackResults || false, timeBlockTextList)
 }

dwertheimer.EventAutomations/src/byTagMode.js

@@ -76,7 +76,7 @@ export function handleUnprocessedTasks(
   }
 
   config.mode = 'PRIORITY_FIRST'
-  clof(finalUnprocessedTasks, `handleUnprocessedTasks finalUnprocessedTasks=`)
+  clof(finalUnprocessedTasks, `handleUnprocessedTasks finalUnprocessedTasks=`, 'content', true)
 
   return matchTasksToSlots(finalUnprocessedTasks, { blockList: newBlockList, timeMap }, config)
 }

dwertheimer.EventAutomations/src/timeblocking-helpers.js

@@ -658,6 +658,10 @@ export function getTimeBlockTimesForEvents(timeMap: IntervalMap, todos: Array<So
         newInfo = processByTimeBlockTag(sortedTaskList, { blockList: blocksAvailable, timeMap: availableTimes }, config)
         break
       }
+      case 'MANUAL_ORDERING': {
+        const sortedTaskList = sortListBy(todosWithDurations, ['lineIndex'])
+        newInfo = matchTasksToSlots(sortedTaskList, { blockList: blocksAvailable, timeMap: availableTimes }, config)
+      }
     }
   } else {
     logDebug(

dwertheimer.EventAutomations/src/timeblocking-shared.js

@@ -62,7 +62,7 @@ export async function createSyncedCopies(todos: Array<SortableParagraphSubset>,
  * @param {Object} pluginJson - Plugin metadata for logging purposes.
  * @returns {Promise<Array<TParagraph>>} - The prepared list of todo items for today.
  */
-export async function gatherAndPrepareTodos(config: AutoTimeBlockingConfig, completedItems: Array<TParagraph>, pluginJson: Object): Promise<$ReadOnlyArray<TParagraph>> {
+export async function gatherAndPrepareTodos(config: AutoTimeBlockingConfig, completedItems: Array<TParagraph>): Promise<$ReadOnlyArray<TParagraph>> {
   deleteParagraphsContainingString(Editor, config.timeBlockTag)
 
   // Fetch todo items for today
@@ -118,17 +118,19 @@ export function getConfig(): AutoTimeBlockingConfig {
  * - items in the current note that are synced tasks to elsewhere (will be in references also)
  *
  * @param {*} config
+ * @param {Boolean} isSyncedCopyRun - true if we are just trying to get synced copies output (makes a difference in MANUAL_ORDERING mode)
  * @returns
  */
-export function getTodaysFilteredTodos(config: AutoTimeBlockingConfig): Array<TParagraph> {
+export function getTodaysFilteredTodos(config: AutoTimeBlockingConfig, isSyncedCopyRun = false): Array<TParagraph> {
   const { includeTasksWithText, excludeTasksWithText, includeAllTodos, timeBlockTag } = config
   // filter down to just the open todos
   const backlinkParas = getTodaysReferences(Editor.note).filter((p) => p.type === 'open')
   logDebug(pluginJson, `Found ${backlinkParas.length} backlink paras`)
   clof(backlinkParas, `getTodaysFilteredTodos backlinkParas filtered to open`, ['filename', 'type', 'content'], true)
-  let todosInNote = Editor.note ? findOpenTodosInNote(Editor.note, includeAllTodos) : []
+  let todosInNote = Editor.note ? findOpenTodosInNote(Editor.note, includeAllTodos).filter((p) => p.type === 'open') : []
   if (todosInNote.length > 0) {
     logDebug(pluginJson, ` getTodaysFilteredTodos: todosInNote Found ${todosInNote.length} items in today's note. Adding them to the possibilities.`)
+    clof(todosInNote, `getTodaysFilteredTodos todosInNote filtered to open`, ['filename', 'type', 'content'], true)
     // we want to eliminate linked lines (for synced lines on the page)
     // because these should be in the references from other pages
     // but it's possible that this is a normal task in the note that is not in references, so for now, commenting this filter out
@@ -141,7 +143,8 @@ export function getTodaysFilteredTodos(config: AutoTimeBlockingConfig): Array<TP
     todosInNote = todosInNote.filter((todo) => !isTimeBlockLine(todo.content)) // if a user is using the todo character for timeblocks, eliminate those lines
     todosInNote = todosInNote.filter((todo) => !new RegExp(timeBlockTag).test(todo.content)) // just to be extra safe, make sure we're not adding our own timeblocks
   }
-  const backLinksAndNoteTodos = [...backlinkParas, ...todosInNote]
+  const backLinksAndNoteTodos = config.mode === 'MANUAL_ORDERING' && !isSyncedCopyRun ? todosInNote : [...backlinkParas, ...todosInNote]
+
   logDebug(pluginJson, `Found ${backLinksAndNoteTodos.length} backlinks+today-note items (may include completed items)`)
   const undupedBackLinkParas = eliminateDuplicateSyncedParagraphs(backLinksAndNoteTodos, 'first', true)
   logDebug(pluginJson, `Found ${undupedBackLinkParas.length} undupedBackLinkParas after duplicate elimination`)
@@ -152,6 +155,7 @@ export function getTodaysFilteredTodos(config: AutoTimeBlockingConfig): Array<TP
   logDebug(pluginJson, `After includeTasksWithPatterns (${(includeTasksWithText ?? []).join(', ')}), ${todosParagraphs.length} potential items`)
   todosParagraphs = Array.isArray(excludeTasksWithText) && excludeTasksWithText?.length > 0 ? excludeTasksWithPatterns(todosParagraphs, excludeTasksWithText) : todosParagraphs
   logDebug(pluginJson, `After excludeTasksWithPatterns (${(excludeTasksWithText ?? []).join(', ')}), ${todosParagraphs.length} potential items`)
+  clof(todosParagraphs, `getTodaysFilteredTodos todosParagraphs`, ['filename', 'type', 'content'], true)
   return todosParagraphs.filter((t) => t.content)
 }