Add insertWeeksEvents and listWeeksEvents functions and fix regression, as part of 0.23.0

Author: jgclark

helpers/NPCalendar.js

@@ -226,15 +226,14 @@ export async function writeTimeBlocksToCalendar(config: EventsConfig, note: TNot
             // Note: now also remove the NP DataStore.preference("timeblockTextMustContainString") if specified.
             const mustContainString = String(DataStore.preference('timeblockTextMustContainString')) ?? ''
             logDebug('NPCalendar / writeTimeBlocksToCalendar', `- Removing mustContainString '${mustContainString}' from time block string`)
-
             const restOfTaskWithoutTimeBlock = thisPara.content
               .replace(`${mustContainString} ${origTimeBlockString}`, '')
               .replace(/\s{2,}/g, ' ')
-              .trimEnd() // take off timeblock
+              .trimEnd()
             const restOfTaskWithoutDateTime = removeDateTagsAndToday(restOfTaskWithoutTimeBlock)
               .replace(timeBlockString, '')
               .replace(/\s{2,}/g, ' ')
-            logDebug('NPCalendar / writeTimeBlocksToCalendar', `- Will process time block '${timeBlockString}' for '${restOfTaskWithoutDateTime}'`)
+            logDebug('NPCalendar / writeTimeBlocksToCalendar', `- Will process time block '${timeBlockString}' with restOfTaskWithoutDateTime:'${restOfTaskWithoutDateTime}' / restOfTaskWithoutTimeBlock:'${restOfTaskWithoutTimeBlock}'`)
 
             // Do we want to add this particular event?
             if (config.confirmEventCreation && keepAsking) {
@@ -266,12 +265,12 @@ export async function writeTimeBlocksToCalendar(config: EventsConfig, note: TNot
               }
               // Add event ID (if wanted)
               if (config.addEventID) {
-                const createdEvent = await Calendar.eventByID(eventID) ?? null
+                const createdEvent = await Calendar.eventByID(eventID)
                 thisParaContent += ` ${createdEvent?.calendarItemLink ?? ''}`
               }
-              thisPara.content = thisParaContent
               logDebug('NPCalendar / writeTimeBlocksToCalendar', `- setting thisPara.content -> '${thisParaContent}'`)
-              // FIXME(@EduardMe): there's something odd going on here. Often 3 characters are left or repeated at the end of the line as a result of this
+              // FIXME(@EduardMe): there's something odd going on here. Often 1 or 3 characters are left or repeated at the end of the line as a result of this. Perhaps to do with emojis?
+              thisPara.content = thisParaContent
               if (showLoadingProgress && !config.confirmEventCreation) {
                 CommandBar.showLoading(true, `Inserting Calendar Events\n(${i + 1}/${timeblockParas.length})`, (i + 1) / timeblockParas.length)
                 await CommandBar.onMainThread()

jgclark.EventHelpers/CHANGELOG.md

@@ -2,6 +2,15 @@
 
 See [website README for more details](https://github.com/NotePlan/plugins/tree/main/jgclark.EventHelpers), and how to configure.
 
+## [0.23.0] - 2025-08-22 @jgclark
+### New
+- new command **/insert week's events as list**, which inserts this week's calendar events in the current note
+- new equivalent `insertWeeksEvents` and `listWeeksEvents` functions for use in automation (templating or x-callbacks)
+### Changed
+- changed setting 'Processed tag name' to 'Processed indicator string' to clarify that you can use any string, not just hashtags. And added a note that if this string contains an emoji then it sometimes triggers a bug in NotePlan where you get some repeated characters at the end of the line.
+### Fixed
+- regression on "/time blocks to calendar"
+
 ## [0.22.2] - 2025-08-19 @jgclark
 - add 'add computed final date' setting for '/process date offsets' command. (Previously it always added a final computed date to the relevant section heading. Now this can be turned off.)
 

jgclark.EventHelpers/README.md

@@ -1,10 +1,11 @@
 # 🕓 Event Helpers plugin
 This plugin provides commands to help you do useful things with Events and Calendars that can't (yet) be done by NotePlan itself:
 
-- **insert day's events as list**: insert a list of this day's calendar events into the current note -- including doing so automatically in **day/week note templates**
-- **insert matching events**: insert a  list of this day's calendar events that match certain patterns into the current note
-- **time blocks to calendar**: takes [NotePlan-defined time blocks](https://help.noteplan.co/article/52-part-2-tasks-events-and-reminders#timeblocking) and converts to them to full Calendar events in your current default calendar, as set by iCal. (See also [Display of Time Blocks](#display-of-time-blocks) below.)
-- **process date offsets**: finds date offset patterns and turns them into due dates, based on date at start of section. (See [Date Offsets](#process-date-offsets) below for full details.)
+- **insert day's events as list**: insert a list of this day's calendar events into the current note. Can be used automatically in a Daily note Template. Alias: **ide**.
+- **insert week's events as list**: insert a list of all the day's calendar events for this week into the current note. Can be used automatically in a Weekly note Template. Alias: **ide**.
+- **insert matching events**: insert a  list of this day's calendar events that match certain patterns into the current note. Alias: **ime**.
+- **time blocks to calendar**: takes [NotePlan-defined time blocks](https://help.noteplan.co/article/52-part-2-tasks-events-and-reminders#timeblocking) and converts to them to full Calendar events in your current default calendar, as set by iCal. (See also [Display of Time Blocks](#display-of-time-blocks) below.) Aliases: **tbtc** or **tbcal**.
+- **process date offsets**: finds date offset patterns and turns them into due dates, based on date at start of section. (See [Date Offsets](#process-date-offsets) below for full details.) Alias: **offset**.
 - **shift dates**: takes dates _in the selected lines_ and shifts them forwards or backwards by a given date interval. It works on both `>YYYY-MM-DD` and `>YYYY-Wnn` style dates.  (User George Crump (@george65) has created a [video showing how this command works](https://storone.zoom.us/rec/play/tzI6AreYeKvoyHRw11HX93IGVf2OI-U7WgKXYn2rmGJvbFHXZp8PSr6ajmOrtWymOU5jFIItScSJnL9U.tboBQEXjdw1uRTqu).)
 
 Most of these commands require configuration, described in the sections below. On macOS, click the gear button on the 'Event Helpers' line in the Plugin Preferences panel to access the settings. Or on on iOS/iPadOS devices, use the **Events: update plugin settings** command instead.
@@ -51,7 +52,7 @@ Settings:
 - **Confirm Event Creation?**: optional boolean tag to indicate whether to ask user to confirm each event to be created
 - **Remove time blocks when processed?**: in `time blocks...` whether to remove time block after making an event from it
 - **Add event link?**: whether to add a nicely-formatted event link when creating an event from a time block. (This can return rather long strings (e.g. `⏰event:287B39C1-4D0A-46DC-BD72-84D79167EFDF`) and so you might want to use a theme option to shorten them until needed (details [below](#theme-customisation)).)
-- **Processed tag name**: if this is set, then this tag will get added on the end of the line with the time block, to show that it has been processed. Otherwise, next time this command is run, it will create another event. This can be used with or without addEventID.
+- **Processed indicator string**: if this is set, then this string will get added on the end of the line with the time block, to show that it has been processed. Otherwise, next time this command is run, it will create another event. This can be used with or without 'Add event link'.
 - **Locale**: optional Locale to use for times in events. If not given, will default to what the OS reports, or failing that, 'en-US'.
 - **Time options**: Optional Time format settings.
 
@@ -77,7 +78,7 @@ The following **Parameters** are available:
 | `includeAllDayEvents` | boolean | include/exclude all day events | `includeAllDayEvents: false` |
 | `calendarSet` | string | limit which calendars are included | `calendarSet:"list,of,calendar,names"` |
 | `calendarNameMappings` | string | customize the name of the calendars |`calendarNameMappings:"Jonathan (iCloud);Me, Us (iCloud);Us"` |
-| `daysToCover` | number | include more than the current day | `daysToCover: 3` includes today + 2 days |
+| `daysToCover` | number | include more than the current day | `daysToCover: 3` includes today + the 2 following days |
 | `format` | string | customize the format | `'format:"..."'` |
 | `allday_format` | string | customize format for all day events | `'allday_format:"..."` |
 
@@ -86,6 +87,18 @@ You can include other text (including line breaks indicated by `\n`) within the
 
 NB: the `Sort order` setting above also controls how the output of this list is sorted.
 
+### Using Event Lists from Callbacks
+As well as following x-callback calls are available:
+
+| equivalent command | callback | parameters | result |
+| ---- | ------ | ---- | --- |
+| Insert day's events | noteplan://x-callback-url/runPlugin?pluginID=jgclark.EventHelpers&command=insertDaysEvents | JSON string (as above for Templates) | inserted to current note |
+| Insert matching events | noteplan://x-callback-url/runPlugin?pluginID=jgclark.EventHelpers&command=insertMatchingDaysEvents | JSON string (as above for Templates) | inserted to current note |
+| Insert week's events | noteplan://x-callback-url/runPlugin?pluginID=jgclark.EventHelpers&command=insertWeeksEvents | JSON string (as above for Templates) | inserted to current note |
+| List day's events as list | noteplan://x-callback-url/runPlugin?pluginID=jgclark.EventHelpers&command=listDaysEvents | JSON string (as above for Templates) | returns list of events as a markdown string |
+| List matching day's events as list | noteplan://x-callback-url/runPlugin?pluginID=jgclark.EventHelpers&command=listMatchingDaysEvents | JSON string (as above for Templates) | returns list of events as a markdown string |
+| List week's events as list | noteplan://x-callback-url/runPlugin?pluginID=jgclark.EventHelpers&command=listWeeksEvents | JSON string (as above for Templates) | returns list of events as a markdown string |
+
 ## /shift dates
 This command takes plain or scheduled day or week dates (i.e. `YYYY-MM-DD`, `>YYYY-MM-DD`, `YYYY-Wnn` or ``>YYYY-Wnn`) in the selected lines and shifts them forwards or backwards by a given date interval. This allows you to copy a set of tasks to use again, and have the dates moved forward by a month or year etc.
 

jgclark.EventHelpers/__tests__/eventsToNotes.test.js

@@ -64,7 +64,7 @@ describe('eventsToNotes.js tests', () => {
     })
   })
 
-  describe('smartStringReplace()', () => {
+  describe('replaceFormatPlaceholderStringWithActualValues()', () => {
     // This function's tests use Partial<...> to use a subset of large objects without causing errors
     const config: Partial<EventsConfig> = {
       calendarNameMappings: [],
@@ -108,44 +108,44 @@ describe('eventsToNotes.js tests', () => {
     const replacements2 = e.getReplacements(event2, config)
 
     test('event 1 format 1 easy', () => {
-      const result = e.smartStringReplace(format1, replacements1)
+      const result = e.replaceFormatPlaceholderStringWithActualValues(format1, replacements1)
       expect(result).toEqual('- (Jonathan) title of event1 https://example.com/easy\n> a few notes\n✓ Jonathan Clark, ? James Bond, x Martha, ? [email protected]')
     })
     test('event 1 format 2 more complex', () => {
-      const result = e.smartStringReplace(format2, replacements1)
+      const result = e.replaceFormatPlaceholderStringWithActualValues(format2, replacements1)
       const expected = '### (Jonathan, 20:00:00-22:00:00) title of event1 https://example.com/easy with Jonathan Clark, Martha Clark, [email protected]\n> a few notes\n---\n'
       expect(result).toEqual(expected)
     })
     test('event 2 format 1 easy', () => {
-      const result = e.smartStringReplace(format1, replacements2)
+      const result = e.replaceFormatPlaceholderStringWithActualValues(format1, replacements2)
       const expected =
         '- (Us) title of event2 with <brackets> & more https://example.com/bothersomeURL/example\n> a few notes with TITLE and URL\n✓ Jonathan Clark, ? James Bond, x Martha, ? [email protected]'
       expect(result).toEqual(expected)
     })
     test('event 2 format 2 more complex', () => {
-      const result = e.smartStringReplace(format2, replacements2)
+      const result = e.replaceFormatPlaceholderStringWithActualValues(format2, replacements2)
       const expected =
         '### (Us, 20:00:00-22:00:00) title of event2 with <brackets> & more https://example.com/bothersomeURL/example with Jonathan Clark, Martha Clark, [email protected]\n> a few notes with TITLE and URL\n---\n'
       expect(result).toEqual(expected)
     })
     test('event 2 format 3 for @EasyTarget with newlines and asterisks', () => {
-      const result = e.smartStringReplace(format3, replacements2)
+      const result = e.replaceFormatPlaceholderStringWithActualValues(format3, replacements2)
       const expected = '### [20:00:00] title of event2 with <brackets> & more\n- \n \n*****\n'
       // console.log(result)
       // console.log(result.length)
       // console.log(expected.length)
       expect(result).toEqual(expected)
     })
     test('event 2 format 4 for @EasyTarget with multiple new lines', () => {
-      const result = e.smartStringReplace(format4, replacements2)
+      const result = e.replaceFormatPlaceholderStringWithActualValues(format4, replacements2)
       const expected = '### [20:00:00] title of event2 with <brackets> & more\n- \n\n\n\n\n'
       // console.log(result)
       // console.log(result.length)
       // console.log(expected.length)
       expect(result).toEqual(expected)
     })
     test('event 1 format 5 date test', () => {
-      const result = e.smartStringReplace(format5, replacements1)
+      const result = e.replaceFormatPlaceholderStringWithActualValues(format5, replacements1)
       expect(result).toEqual('- 2021-01-23')
     })
   })

jgclark.EventHelpers/plugin.json

@@ -8,24 +8,44 @@
   "plugin.author": "jgclark",
   "plugin.url": "https://github.com/NotePlan/plugins/tree/main/jgclark.EventHelpers",
   "plugin.changelog": "https://github.com/NotePlan/plugins/tree/main/jgclark.EventHelpers/CHANGELOG.md",
-  "plugin.version": "0.22.2",
-  "plugin.lastUpdateInfo": "0.22.2: add 'add computed final date' setting to '/process date offsets' command.\n0.22.1: improve setting defaults and documentation.\n0.22.0: can now use events() template calls in Weekly notes.\n0.21.3: bug fix adding time blocks to calendar.\n0.21.2: /shiftDates now covers more cases.\n0.21.1: add 'Yes to all' to option to create time blocks. Extend '/shift dates' to work on week dates.\n0.21.0: improvements to '/shift dates' and '/process date offsets'.",
+  "plugin.version": "0.23.0",
+  "plugin.lastUpdateInfo": "0.23.0: new command '/insert week's events as list'. Fix regression.\n0.22.2: add 'add computed final date' setting to '/process date offsets' command.\n0.22.1: improve setting defaults and documentation.\n0.22.0: can now use events() template calls in Weekly notes.\n0.21.3: bug fix adding time blocks to calendar.\n0.21.2: /shiftDates now covers more cases.\n0.21.1: add 'Yes to all' to option to create time blocks. Extend '/shift dates' to work on week dates.\n0.21.0: improvements to '/shift dates' and '/process date offsets'.",
   "plugin.dependencies": [],
   "plugin.script": "script.js",
   "plugin.isRemote": "false",
   "plugin.commands": [
     {
       "name": "time blocks to calendar",
+      "alias": [
+        "tbtc",
+        "tbcal"
+      ],
       "description": "promote time blocks to be full calendar events",
       "jsFunction": "timeBlocksToCalendar"
     },
     {
       "name": "insert day's events as list",
+      "alias": [
+        "events",
+        "ide"
+      ],
       "description": "insert list of this day's calendar events at cursor",
       "jsFunction": "insertDaysEvents"
     },
+    {
+      "name": "insert week's events as list",
+      "alias": [
+        "events",
+        "iwe"
+      ],
+      "description": "insert list of this week's calendar events at cursor",
+      "jsFunction": "insertWeeksEvents"
+    },
     {
       "name": "insert matching events",
+      "alias": [
+        "ime"
+      ],
       "description": "inserts this day's calendar events matching certain patterns at cursor",
       "jsFunction": "insertMatchingDaysEvents"
     },
@@ -39,9 +59,6 @@
     },
     {
       "name": "shift dates",
-      "alias": [
-        "offset"
-      ],
       "description": "takes dates in the selection and shifts them forwards or backwards by a given date interval",
       "jsFunction": "shiftDates"
     },
@@ -60,13 +77,28 @@
       "name": "listDaysEvents",
       "description": "function to list events for the current open Calendar note (for use in Templating)",
       "hidden": true,
-      "jsFunction": "listDaysEvents"
+      "jsFunction": "listDaysEvents",
+      "parameters": [
+        "paras as JSON string"
+      ]
     },
     {
       "name": "listMatchingDaysEvents",
       "description": "function to list events for the current open Calendar note that match string defined in the settings (for use in Templating)",
       "hidden": true,
-      "jsFunction": "listMatchingDaysEvents"
+      "jsFunction": "listMatchingDaysEvents",
+      "parameters": [
+        "paras as JSON string"
+      ]
+    },
+    {
+      "name": "listWeeksEvents",
+      "description": "function to list events for the current open Calendar note (for use in Templating or Callbacks)",
+      "hidden": true,
+      "jsFunction": "listWeeksEvents",
+      "parameters": [
+        "paras as JSON string"
+      ]
     },
     {
       "name": "Events: update plugin settings",
@@ -276,15 +308,15 @@
       "title": "Add event link?",
       "description": "Whether to add an event link in place of the time block, when creating an event from it",
       "type": "bool",
-      "default": false,
+      "default": true,
       "required": true
     },
     {
       "key": "processedTagName",
-      "title": "Processed tag name",
-      "description": "(Optional) Tag to add on a line after making its time block an event",
+      "title": "Processed indicator string",
+      "description": "(Optional) String to add on a line after making its time block an event, for example '#event_created'. Note: if this contains an emoji then it sometimes triggers a bug in NotePlan where you get some repeated characters at the end of the line.",
       "type": "string",
-      "default": "#event_created",
+      "default": "",
       "required": false
     },
     {