collection plugin actions + file read/write

[turchinc]

Plugin Runtime Types — Collection Actions

Primary use case: export actions or similar for all items in a collection, supporting folders, requests and exposing read/write to provide export (and potentially import)

PR should solve or enable solutions for:

• https://feedback.yaak.app/p/folder-level-export (should be done)
• https://feedback.yaak.app/p/export-as-postman-collection (my wip. pushed to own repo waiting for this PR unless you want it in app repo)
• https://feedback.yaak.app/p/export-to-openapi (might tackle this, looking for more of a neutral exchange format which postman json kind of de facto is, but this might be promising)

httpCollectionActions

Define custom actions that appear in folder/workspace context menus.

• Field on PluginDefinition:

  • httpCollectionActions?: HttpCollectionActionPlugin[]

• HttpCollectionActionPlugin shape:

  • label: string — displayed in context menu
  • icon?: Icon — optional icon for the action
  • onSelect(ctx: Context, args: CallHttpCollectionActionArgs) — called when user invokes the action

• CallHttpCollectionActionArgs shape:

  • folder?: Folder — present when action was invoked on a folder
  • workspace?: Workspace — present when action was invoked on a workspace

Notes:

• Actions appear in context menu for single folder/workspace selection
• Plugin may operate on entire collection by using ctx.folder.list() and ctx.httpRequest.list()

New Context APIs

ctx.folder.list(args)

List all folders in a workspace.

args: {
  workspaceId?: string;
}

// Returns: Array<Folder>

ctx.file.writeText(filePath, content)

Write text content to a file.

writeText(filePath: string, content: string): Promise<void>

ctx.file.readText(filePath)

Read text content from a file.

readText(filePath: string): Promise<string>

ctx.httpRequest.list(args)

List all requests in a workspace or folder.

args: {
  workspaceId?: string;
  folderId?: string;
}

// Returns: Array<HttpRequest>

Notes:

• Backwards compatible: all new fields are optional and do not affect existing plugins

[gschier]

Thanks for the PR! I made some changes to have it better align with the codebase:

• Removed file APIs (plugins can just use node:fs)
• Separated workspace/folder actions
• Added Websocket actions while we're in here
• Some other tweaks.