Merge branch 'main' of https://github.com/NotePlan/plugins

jgclark · jgclark · commit 2c28f942b977 · 2026-02-01T08:35:50.000Z
diff --git a/helpers/__tests__/general.test.js b/helpers/__tests__/general.test.js
@@ -161,12 +161,17 @@ describe(`${FILE}`, () => {
       })
       test('should create a link in an existing floating window', () => {
         const res = g.createOpenOrDeleteNoteCallbackUrl('foo', 'filename', '', 'useExistingSubWindow')
-        expect(res).toEqual('noteplan://x-callback-url/openNote?filename=foo&useExistingSubWindow=yes')
+        expect(res).toEqual('noteplan://x-callback-url/openNote?filename=foo&useExistingSubWindow=yes&subWindow=yes')
       })
       test('should create a link in split view', () => {
         const res = g.createOpenOrDeleteNoteCallbackUrl('foo', 'filename', null, 'splitView')
         expect(res).toEqual('noteplan://x-callback-url/openNote?filename=foo&splitView=yes')
       })
+      test('should create a link in reuse split view (reuseSplitView + splitView=yes)', () => {
+        const res = g.createOpenOrDeleteNoteCallbackUrl('foo', 'filename', '', 'reuseSplitView')
+        expect(res).toContain('reuseSplitView=yes')
+        expect(res).toContain('splitView=yes')
+      })
       test('should ignore illegal openType', () => {
         const res = g.createOpenOrDeleteNoteCallbackUrl('foo', 'filename', '', 'baz')
         expect(res).toEqual('noteplan://x-callback-url/openNote?filename=foo')
@@ -183,6 +188,31 @@ describe(`${FILE}`, () => {
         expect(res).toEqual('noteplan://x-callback-url/openNote?filename=foo&blockID=%5E123456')
       })
     })
+    describe('using timeframe (calendar notes)', () => {
+      test('should add timeframe=week for date note', () => {
+        const res = g.createOpenOrDeleteNoteCallbackUrl('today', 'date', '', null, false, '', 'week')
+        expect(res).toContain('noteDate=today')
+        expect(res).toContain('&timeframe=week')
+      })
+      test('should add timeframe=month for date note', () => {
+        const res = g.createOpenOrDeleteNoteCallbackUrl('today', 'date', '', null, false, '', 'month')
+        expect(res).toContain('&timeframe=month')
+      })
+      test('should not add timeframe for non-date paramType', () => {
+        const res = g.createOpenOrDeleteNoteCallbackUrl('foo', 'filename', '', null, false, '', 'week')
+        expect(res).not.toContain('timeframe=')
+      })
+    })
+    describe('using highlightStart/highlightLength', () => {
+      test('should add highlightStart and highlightLength', () => {
+        const res = g.createOpenOrDeleteNoteCallbackUrl('foo', 'title', '', null, false, '', null, 0, 9999)
+        expect(res).toContain('&highlightStart=0&highlightLength=9999')
+      })
+      test('should not add highlight for deleteNote', () => {
+        const res = g.createOpenOrDeleteNoteCallbackUrl('foo', 'title', '', null, true, '', null, 0, 10)
+        expect(res).not.toContain('highlightStart')
+      })
+    })
   })
 
   describe(section(`createRunPluginCallbackUrl`), () => {
@@ -214,6 +244,28 @@ describe(`${FILE}`, () => {
       const exp = 'noteplan://x-callback-url/addText?noteDate=today&mode=prepend&openNote=yes&text=bar'
       expect(g.createAddTextCallbackUrl('today', opts)).toEqual(exp)
     })
+    test('should add subWindow=yes when openType is subWindow', () => {
+      const opts = { text: 'bar', mode: 'append', openNote: 'yes', openType: 'subWindow' }
+      const res = g.createAddTextCallbackUrl('today', opts)
+      expect(res).toContain('&subWindow=yes')
+    })
+    test('should add splitView=yes when openType is splitView', () => {
+      const opts = { text: 'bar', mode: 'append', openNote: 'yes', openType: 'splitView' }
+      const res = g.createAddTextCallbackUrl('today', opts)
+      expect(res).toContain('&splitView=yes')
+    })
+    test('should add reuseSplitView=yes and splitView=yes when openType is reuseSplitView', () => {
+      const opts = { text: 'bar', mode: 'append', openNote: 'yes', openType: 'reuseSplitView' }
+      const res = g.createAddTextCallbackUrl('today', opts)
+      expect(res).toContain('&reuseSplitView=yes')
+      expect(res).toContain('&splitView=yes')
+    })
+    test('should add useExistingSubWindow=yes and subWindow=yes when openType is useExistingSubWindow', () => {
+      const opts = { text: 'bar', mode: 'append', openNote: 'yes', openType: 'useExistingSubWindow' }
+      const res = g.createAddTextCallbackUrl('today', opts)
+      expect(res).toContain('&useExistingSubWindow=yes')
+      expect(res).toContain('&subWindow=yes')
+    })
   })
 
   describe(section('createPrettyOpenNoteLink()'), () => {
@@ -327,6 +379,21 @@ describe(`${FILE}`, () => {
           `${base}text?arg0=%7B%22excludeToday%22%3Afalse%2C%22progressHeading%22%3A%22Test%20Heading%22%2C%22progressYesNo%22%3A%22%23readbook%2C%23theology%22%7D`,
         )
       })
+      test('should create selectTag callback with name param', () => {
+        const result = g.createCallbackUrl('selectTag', { name: '#noteplan' })
+        expect(result).toEqual(`${base}selectTag?name=%23noteplan`)
+      })
+      test('should create installPlugin callback with pluginID param', () => {
+        const result = g.createCallbackUrl('installPlugin', { pluginID: 'dwertheimer.Favorites' })
+        expect(result).toEqual(`${base}installPlugin?pluginID=dwertheimer.Favorites`)
+      })
+      test('should create toggleSidebar callback with forceCollapse and forceOpen', () => {
+        const result = g.createCallbackUrl('toggleSidebar', { forceCollapse: 'yes', forceOpen: 'no', animated: 'no' })
+        expect(result).toContain('toggleSidebar')
+        expect(result).toContain('forceCollapse=yes')
+        expect(result).toContain('forceOpen=no')
+        expect(result).toContain('animated=no')
+      })
     })
     /*
      * forceLeadingSlash()
diff --git a/helpers/general.js b/helpers/general.js
@@ -280,17 +280,23 @@ export function returnNoteLink(noteTitle: string, heading: string | null = ''):
  * @param {string} openType - 'subWindow' | 'splitView' | 'reuseSplitView' | 'useExistingSubWindow' (default: null)
  * @param {boolean} isDeleteNote - whether this is actually a deleteNote
  * @param {string} blockID - the blockID if this is a line link (includes the ^) -- only works with title (not filename)
+ * @param {string | null} timeframe - for calendar notes: 'week' | 'month' | 'quarter' | 'year' (default: null)
+ * @param {number | null} highlightStart - character index to jump/select after opening (default: null)
+ * @param {number | null} highlightLength - length of selection; use 0 for cursor only, high value for end (default: null)
  * @returns {string} the x-callback-url string
  * @tests available
  */
-// createOpenOrDeleteNoteCallbackUrl('theTitle', 'title', 'heading', 'openType', 'isDeleteNote')
+// createOpenOrDeleteNoteCallbackUrl('theTitle', 'title', 'heading', 'openType', 'isDeleteNote', blockID, timeframe, highlightStart, highlightLength)
 export function createOpenOrDeleteNoteCallbackUrl(
   titleOrFilename: string,
   paramType: 'title' | 'filename' | 'date' = 'title',
   heading: string | null = '',
   openType: 'subWindow' | 'splitView' | 'reuseSplitView' | 'useExistingSubWindow' | null = null,
   isDeleteNote: boolean = false,
   blockID: string = '',
+  timeframe: 'week' | 'month' | 'quarter' | 'year' | null = null,
+  highlightStart: number | null = null,
+  highlightLength: number | null = null,
 ): string {
   const encodePlusParens = (s: string): string => encodeURIComponent(s).replace(/\(/g, '%28').replace(/\)/g, '%29')
   const isFilename = paramType === 'filename'
@@ -304,21 +310,30 @@ export function createOpenOrDeleteNoteCallbackUrl(
   if (openType === 'reuseSplitView') {
     openAs += '&splitView=yes' // special case for reuseSplitView, which needs both
   }
+  if (openType === 'useExistingSubWindow') {
+    openAs += '&subWindow=yes' // special case for useExistingSubWindow, which needs both
+  }
+  const timeframeStr =
+    !isDeleteNote && paramType === 'date' && timeframe && ['week', 'month', 'quarter', 'year'].includes(timeframe) ? `&timeframe=${timeframe}` : ''
+  const highlightStr =
+    !isDeleteNote && highlightStart != null && Number.isInteger(highlightStart)
+      ? `&highlightStart=${highlightStart}&highlightLength=${highlightLength != null && Number.isInteger(highlightLength) ? highlightLength : 0}`
+      : ''
   let retVal = ''
   if (isLineLink) {
     retVal = `${xcb}${encodedTitleOrFilename}${encodeURIComponent(blockID)}`
   } else {
     if (heading?.length) {
       if (isFilename) {
-        retVal = `${xcb}${encodedTitleOrFilename}${head.length ? `&heading=${head}` : ''}${openAs}`
+        retVal = `${xcb}${encodedTitleOrFilename}${head.length ? `&heading=${head}` : ''}${openAs}${timeframeStr}${highlightStr}`
       } else {
-        retVal = `${xcb}${encodedTitleOrFilename}${head.length ? `%23${head}` : ''}${openAs}`
+        retVal = `${xcb}${encodedTitleOrFilename}${head.length ? `%23${head}` : ''}${openAs}${timeframeStr}${highlightStr}`
       }
     } else {
       if (isLineLink) {
-        retVal = `${xcb}${encodedTitleOrFilename}${head.length ? `&line=${head}` : ''}${openAs}`
+        retVal = `${xcb}${encodedTitleOrFilename}${head.length ? `&line=${head}` : ''}${openAs}${timeframeStr}${highlightStr}`
       } else {
-        retVal = `${xcb}${encodedTitleOrFilename}${openAs}`
+        retVal = `${xcb}${encodedTitleOrFilename}${openAs}${timeframeStr}${highlightStr}`
       }
     }
   }
@@ -328,21 +343,31 @@ export function createOpenOrDeleteNoteCallbackUrl(
 /**
  * Create an addText callback url
  * @param {TNote | string} note (either a note object or a date-related string, e.g. today, yesterday, tomorrow)
- * @param {{ text: string, mode: string, openNote: string }} options - text to add, mode ('append', 'prepend'), and whether to open the note
+ * @param {{ text: string, mode: string, openNote: string, openType?: string }} options - text to add, mode ('append', 'prepend'), openNote, and optional openType ('subWindow' | 'splitView' | 'reuseSplitView' | 'useExistingSubWindow')
  * @returns {string}
  * @tests available
  */
-export function createAddTextCallbackUrl(note: TNote | string, options: { text: string, mode: string, openNote: string }): string {
+export function createAddTextCallbackUrl(
+  note: TNote | string,
+  options: { text: string, mode: string, openNote: string, openType?: 'subWindow' | 'splitView' | 'reuseSplitView' | 'useExistingSubWindow' | null },
+): string {
   const { text, mode, openNote } = options
+  const openTypeParam = options.openType
+  let openAs = ''
+  if (openTypeParam && ['subWindow', 'splitView', 'reuseSplitView', 'useExistingSubWindow'].includes(openTypeParam)) {
+    openAs = `&${openTypeParam}=yes`
+    if (openTypeParam === 'reuseSplitView') openAs += '&splitView=yes'
+    if (openTypeParam === 'useExistingSubWindow') openAs += '&subWindow=yes'
+  }
   if (typeof note !== 'string') {
     // this is a note
     const encoded = encodeURIComponent(note.filename).replace(/\(/g, '%28').replace(/\)/g, '%29')
     if (note && note.filename) {
-      return `noteplan://x-callback-url/addText?filename=${encoded}&mode=${mode}&openNote=${openNote}&text=${encodeURIComponent(text)}`
+      return `noteplan://x-callback-url/addText?filename=${encoded}&mode=${mode}&openNote=${openNote}&text=${encodeURIComponent(text)}${openAs}`
     }
   } else {
     // this is a date type argument
-    return `noteplan://x-callback-url/addText?noteDate=${note}&mode=${mode}&openNote=${openNote}&text=${encodeURIComponent(text)}`
+    return `noteplan://x-callback-url/addText?noteDate=${note}&mode=${mode}&openNote=${openNote}&text=${encodeURIComponent(text)}${openAs}`
   }
   return ''
 }
diff --git a/np.CallbackURLs/CHANGELOG.md b/np.CallbackURLs/CHANGELOG.md
@@ -4,6 +4,22 @@
 
 See Plugin [README](https://github.com/NotePlan/plugins/blob/main/np.CallbackURLs/README.md) for details on available commands and use cases.
 
+## [1.11.0] - 2025-01-30 @dwertheimer
+
+- Fix addNote wizard: was returning addText URL; now correctly returns addNote URL
+- Open note wizard: add timeframe (week/month/quarter/year) for calendar notes; add optional highlightStart/highlightLength (cursor/selection after open)
+- Add text wizard: add openType (subWindow, splitView, reuseSplitView, useExistingSubWindow) when openNote=yes
+- Add note wizard: add optional highlightStart/highlightLength when openNote=yes
+- Add selectTag wizard: create x-callback URL to select a tag in the sidebar
+- Add installPlugin wizard: create x-callback URL to install a plugin by ID
+- Add toggleSidebar wizard: create x-callback URL to toggle/show/hide sidebar (forceCollapse, forceOpen, animated)
+- Helpers/general: createOpenOrDeleteNoteCallbackUrl now accepts timeframe, highlightStart, highlightLength; createAddTextCallbackUrl now accepts openType in options; useExistingSubWindow URLs now include subWindow=yes
+- Tests: add tests for timeframe, highlight, openType (addText), reuseSplitView, selectTag, installPlugin, toggleSidebar; add NPXCallbackWizard.test.js for selectTag, installPlugin, toggleSidebar wizard functions
+
+## [1.10.1] - 2025-01-30 @dwertheimer
+
+- Open note wizard: add openType options (subWindow, splitView, reuseSplitView, useExistingSubWindow) so generated openNote x-callback-urls can open in floating window, split view, reuse split view, or existing sub-window
+
 ## [1.10.0] - 2025-09-23 @dwertheimer
 
 - Add lineLink command
diff --git a/np.CallbackURLs/__tests__/NPXCallbackWizard.test.js b/np.CallbackURLs/__tests__/NPXCallbackWizard.test.js
@@ -0,0 +1,129 @@
+/* global describe, test, expect, jest, beforeEach */
+/**
+ * Tests for np.CallbackURLs wizard functions: selectTag, installPlugin, toggleSidebar
+ * Mocks userInput (getInput, chooseOption) to test URL output
+ */
+import { DataStore, Editor, CommandBar, NotePlan } from '@mocks/index'
+
+global.DataStore = DataStore
+global.Editor = Editor
+global.CommandBar = CommandBar
+global.NotePlan = NotePlan
+
+const mockGetInput = jest.fn()
+const mockChooseOption = jest.fn()
+
+jest.mock('@helpers/userInput', () => ({
+  getInput: (...args) => mockGetInput(...args),
+  chooseOption: (...args) => mockChooseOption(...args),
+  showMessage: jest.fn(),
+  showMessageYesNo: jest.fn(),
+  chooseFolder: jest.fn(),
+  chooseNote: jest.fn(),
+  getInputTrimmed: jest.fn(),
+}))
+
+jest.mock('@helpers/dev', () => ({
+  log: jest.fn(),
+  logError: jest.fn(),
+  logDebug: jest.fn(),
+  JSP: (x) => x,
+  clo: jest.fn(),
+  timer: jest.fn(),
+}))
+
+jest.mock('@helpers/NPParagraph', () => ({
+  getSelectedParagraph: jest.fn(),
+  getParagraphContainingPosition: jest.fn(),
+}))
+
+jest.mock('../src/NPTemplateRunner', () => ({
+  getXcallbackForTemplate: jest.fn(),
+}))
+
+jest.mock('../src/NPOpenFolders', () => ({
+  openFolderView: jest.fn(),
+}))
+
+jest.mock('@helpers/NPdev', () => ({
+  chooseRunPluginXCallbackURL: jest.fn(),
+}))
+
+describe('np.CallbackURLs NPXCallbackWizard', () => {
+  beforeEach(() => {
+    jest.clearAllMocks()
+  })
+
+  describe('selectTag', () => {
+    test('should return selectTag URL with # when user enters tag without #', async () => {
+      const { selectTag } = require('../src/NPXCallbackWizard')
+      mockGetInput.mockResolvedValue('noteplan')
+      const url = await selectTag()
+      expect(url).toContain('noteplan://x-callback-url/selectTag')
+      expect(url).toContain('name=%23noteplan')
+    })
+    test('should return selectTag URL with user tag when user enters #tag', async () => {
+      const { selectTag } = require('../src/NPXCallbackWizard')
+      mockGetInput.mockResolvedValue('#noteplan')
+      const url = await selectTag()
+      expect(url).toContain('selectTag')
+      expect(url).toContain('name=%23noteplan')
+    })
+    test('should return empty string when user cancels', async () => {
+      const { selectTag } = require('../src/NPXCallbackWizard')
+      mockGetInput.mockResolvedValue(false)
+      const url = await selectTag()
+      expect(url).toEqual('')
+    })
+  })
+
+  describe('installPlugin', () => {
+    test('should return installPlugin URL with pluginID', async () => {
+      const { installPlugin } = require('../src/NPXCallbackWizard')
+      mockGetInput.mockResolvedValue('dwertheimer.Favorites')
+      const url = await installPlugin()
+      expect(url).toContain('noteplan://x-callback-url/installPlugin')
+      expect(url).toContain('pluginID=dwertheimer.Favorites')
+    })
+    test('should return empty string when user cancels', async () => {
+      const { installPlugin } = require('../src/NPXCallbackWizard')
+      mockGetInput.mockResolvedValue(false)
+      const url = await installPlugin()
+      expect(url).toEqual('')
+    })
+    test('should return empty string when user enters empty string', async () => {
+      const { installPlugin } = require('../src/NPXCallbackWizard')
+      mockGetInput.mockResolvedValue('')
+      const url = await installPlugin()
+      expect(url).toEqual('')
+    })
+  })
+
+  describe('toggleSidebar', () => {
+    test('should return toggleSidebar URL with no params when all defaults', async () => {
+      const { toggleSidebar } = require('../src/NPXCallbackWizard')
+      mockChooseOption.mockResolvedValueOnce('no').mockResolvedValueOnce('no').mockResolvedValueOnce('yes')
+      const url = await toggleSidebar()
+      expect(url).toEqual('noteplan://x-callback-url/toggleSidebar')
+    })
+    test('should return toggleSidebar URL with forceCollapse=yes', async () => {
+      const { toggleSidebar } = require('../src/NPXCallbackWizard')
+      mockChooseOption.mockResolvedValueOnce('yes').mockResolvedValueOnce('no').mockResolvedValueOnce('yes')
+      const url = await toggleSidebar()
+      expect(url).toContain('toggleSidebar')
+      expect(url).toContain('forceCollapse=yes')
+    })
+    test('should return toggleSidebar URL with forceOpen=yes', async () => {
+      const { toggleSidebar } = require('../src/NPXCallbackWizard')
+      mockChooseOption.mockResolvedValueOnce('no').mockResolvedValueOnce('yes').mockResolvedValueOnce('yes')
+      const url = await toggleSidebar()
+      expect(url).toContain('forceOpen=yes')
+    })
+    test('should return empty string when user cancels first prompt', async () => {
+      const { toggleSidebar } = require('../src/NPXCallbackWizard')
+      mockChooseOption.mockResolvedValue(false)
+      const url = await toggleSidebar()
+      expect(url).toEqual('')
+    })
+  })
+})
diff --git a/np.CallbackURLs/plugin.json b/np.CallbackURLs/plugin.json
@@ -5,8 +5,8 @@
   "noteplan.minAppVersion-NOTE": "Includes folder view picker",
   "plugin.id": "np.CallbackURLs",
   "plugin.name": "🔗 Link Creator",
-  "plugin.version": "1.10.0",
-  "plugin.lastUpdateInfo": "1.10.0: Add lineLink command",
+  "plugin.version": "1.11.0",
+  "plugin.lastUpdateInfo": "1.11.0: selectTag, installPlugin, toggleSidebar wizards; openNote timeframe/highlight; addText/addNote openType and highlight; fix addNote URL",
   "plugin.description": "Interactively helps you form links/x-callback-urls (and also Template Tags with runPlugin commands) to perform actions from within NotePlan or between other applications and NotePlan.",
   "plugin.author": "dwertheimer",
   "plugin.dependencies": [],
diff --git a/np.CallbackURLs/src/NPXCallbackWizard.js b/np.CallbackURLs/src/NPXCallbackWizard.js
