further prep for v4 official

make migrate work as bin
make plugin types aligned with side-api (so ide is documented by intellisense too)

Author: toddtarsi

package.json

@@ -18,6 +18,7 @@
     "test:e2e": "jest --testMatch \"**/packages/**/__tests__/**/*.e2e.js\"",
     "lint": "pnpm run lint:scripts",
     "lint:scripts": "eslint --ignore-pattern node_modules --ignore-pattern third-party --ignore-pattern dist --ignore-pattern build --ignore-pattern json --ext .ts,.tsx --ext .js packages/",
+    "test:ide": "npm-run-bg -s 'http-server -p 8080 ./tests/static::Available on::8080' 'node ./packages/side-runner/dist/bin.js -t 15000 ./tests/examples/*.side'",
     "test:side-runner": "npm-run-bg -s 'http-server -p 8080 ./tests/static::Available on::8080' 'node ./packages/side-runner/dist/bin.js -t 15000 ./tests/examples/*.side'",
     "test:side-runner:ci": "npm-run-bg -s 'http-server -p 8080 ./tests/static::Available on::8080' 'node ./packages/side-runner/dist/bin.js -c \"goog:chromeOptions.args=[headless,no-sandbox] browserName=chrome\" -t 15000 ./tests/examples/*.side'",
     "typecheck": "tsc --noEmit --composite false",

packages/selenium-ide/src/browser/windows/PlaybackWindow/preload/recorder.ts

@@ -24,7 +24,7 @@ import {
   ExpandedMutationObserver,
 } from 'browser/types'
 import initFindSelect from './find-select'
-import { PluginPreloadOutputShape } from '@seleniumhq/side-runtime'
+import { PluginPreloadOutputShape } from '@seleniumhq/side-api'
 
 export interface RecordingState {
   typeTarget: HTMLElement | null

packages/selenium-ide/src/main/session/controllers/Commands/index.ts

@@ -1,6 +1,7 @@
 import Commands from '@seleniumhq/side-model/dist/Commands'
-import { CustomCommandShape, PluginShape } from '@seleniumhq/side-runtime'
+import { CustomCommandShape } from '@seleniumhq/side-runtime'
 import BaseController from '../Base'
+import { PluginShape } from '@seleniumhq/side-api'
 
 const serializeCustomCommands = (commands: PluginShape['commands'] = {}) =>
   Object.fromEntries(

packages/selenium-ide/src/main/session/controllers/Plugins/index.ts

@@ -1,4 +1,5 @@
-import { correctPluginPaths, loadPlugins, PluginShape } from '@seleniumhq/side-runtime'
+import { PluginShape } from '@seleniumhq/side-api'
+import { correctPluginPaths, loadPlugins } from '@seleniumhq/side-runtime'
 import { ipcMain } from 'electron'
 import storage from 'main/store'
 import BaseController from '../Base'

packages/selenium-ide/src/main/session/controllers/Windows/index.ts

@@ -173,6 +173,24 @@ export default class WindowsController extends BaseController {
     return true
   }
 
+  async openCustom(
+    name: string,
+    filepath: string,
+    opts: BrowserWindowConstructorOptions = {}
+  ) {
+    const window = new BrowserWindow({
+      ...opts,
+      webPreferences: {
+        // This should be the default preload, which just adds the sideAPI to the window
+        preload: join(__dirname, `project-editor-preload-bundle.js`),
+        ...opts?.webPreferences ?? {},
+      },
+    })
+    this.windows[name] = window
+    await window.loadURL(`file://${filepath}`)
+    return true
+  }
+
   async openPlaybackWindow(opts: BrowserWindowConstructorOptions = {}) {
     const window = this.windowLoaders[playbackWindowName](opts)
     this.handlePlaybackWindow(window)

packages/side-api/src/commands/windows/index.ts

@@ -1,15 +1,19 @@
 import type { Shape as Close } from './close'
+import type { Shape as OpenCustom } from './openCustom'
 import type { Shape as Open } from './open'
 
 import * as close from './close'
 import * as open from './open'
+import * as openCustom from './openCustom'
 
 export const commands = {
   close,
   open,
+  openCustom,
 }
 
 export type Shape = {
   close: Close
   open: Open
+  openCustom: OpenCustom
 }

packages/side-api/src/types.ts

@@ -2,6 +2,7 @@ import { ProjectShape } from '@seleniumhq/side-model'
 import { Chrome } from '@seleniumhq/browser-info'
 import { Browser } from '@seleniumhq/get-driver'
 import { StateShape } from './models/state'
+import { PluginRuntimeShape } from '@seleniumhq/side-runtime'
 
 export interface BrowserInfo extends Pick<Chrome.BrowserInfo, 'version'> {
   browser: Browser
@@ -78,6 +79,33 @@ export type EventListenerParams<LISTENER extends BaseListener<any>> =
 
 export type LocatorFields = 'target' | 'value'
 
+export interface NewCommandShape {
+  command: string
+  target: string | [string, string][]
+  value: string | [string, string][]
+  insertBeforeLastCommand: boolean
+  frameLocation: string
+  winHandleId: string
+}
+
+export interface onCommandRecordedDropResult {
+  action: 'drop'
+}
+export interface OnCommandRecordedUpdateResult {
+  action: 'update'
+  command: NewCommandShape
+}
+
+export type OnCommandRecordedResult =
+  | void
+  | onCommandRecordedDropResult
+  | OnCommandRecordedUpdateResult
+
+export type PluginHookInput = {
+  logger: Console
+  project: ProjectShape
+} & Record<string, unknown>
+
 export interface RecordNewCommandInput {
   command: string
   target: string | [string, string][]
@@ -86,3 +114,30 @@ export interface RecordNewCommandInput {
   frameLocation?: string
   winHandleId?: string
 }
+
+export type PluginMenuConfigurator = (api: BaseApi) => void
+
+export interface PluginShape extends PluginRuntimeShape {
+  menus?: {
+    [key: string]: (
+      session: CoreSessionData
+    ) => (
+      ...args: any[]
+    ) => (Electron.MenuItemConstructorOptions | Electron.MenuItem)[]
+  }
+}
+
+export interface PluginPreloadOutputShape {
+  hooks: {
+    onCommandRecorded?: (
+      command: NewCommandShape,
+      event: Event | KeyboardEvent | MouseEvent | MutationRecord[] | undefined
+    ) => OnCommandRecordedResult
+  }
+}
+
+export type SendMessage = (...args: any[]) => void
+
+export type PluginPreloadShape = (
+  sendMessage: SendMessage
+) => PluginPreloadOutputShape

packages/side-example-suite/package.json

@@ -21,6 +21,7 @@
     "@seleniumhq/code-export-python-pytest": "4.0.0-alpha.2"
   },
   "devDependencies": {
+    "@seleniumhq/side-api": "^4.0.0-alpha.26",
     "@seleniumhq/side-runtime": "^4.0.0-alpha.26"
   },
   "repository": {

packages/side-example-suite/src/plugins/custom-click/index.ts

@@ -1,4 +1,4 @@
-import { PluginShape } from '@seleniumhq/side-runtime'
+import { PluginShape } from '@seleniumhq/side-api'
 
 /**
  * This is a demo plugin that takes the default click command, adds a new "customClick" command,

packages/side-example-suite/src/plugins/custom-click/preload/index.ts

@@ -1,7 +1,6 @@
-import { PluginPreloadShape } from '@seleniumhq/side-runtime'
+import { PluginPreloadShape, SendMessage } from '@seleniumhq/side-api'
 
 export let clickCount = 0
-export type SendMessage = (...args: any[]) => void
 
 /**
  * This is the preload script for the plugin. It runs in the browser context