@motrix/mdxp 0.5.0 → 0.7.0

package/src/connection.ts

@@ -11,6 +11,8 @@ import type {
   DownloadAddResult,
   DownloadCancelParams,
   DownloadCancelResult,
+  DownloadDirectoriesParams,
+  DownloadDirectoriesResult,
   DownloadSubmitParams,
   DownloadSubmitResult,
   EngineStatusParams,
@@ -36,6 +38,8 @@ import type {
   TaskRemoveResult,
   TaskResumeParams,
   TaskResumeResult,
+  TaskRevealParams,
+  TaskRevealResult,
   UrlProbeParams,
   UrlProbeResult,
   UrlResolveParams,
@@ -46,6 +50,7 @@ import type {
 export interface MdxpRequestMap {
   'motrix/initialize': [InitializeParams, InitializeResult]
   'download/submit': [DownloadSubmitParams, DownloadSubmitResult]
+  'download/directories': [DownloadDirectoriesParams, DownloadDirectoriesResult]
   'download/cancel': [DownloadCancelParams, DownloadCancelResult]
   'url/probe': [UrlProbeParams, UrlProbeResult]
   'url/resolve': [UrlResolveParams, UrlResolveResult]
@@ -57,6 +62,7 @@ export interface MdxpRequestMap {
   'task/pause': [TaskPauseParams, TaskPauseResult]
   'task/resume': [TaskResumeParams, TaskResumeResult]
   'task/remove': [TaskRemoveParams, TaskRemoveResult]
+  'task/reveal': [TaskRevealParams, TaskRevealResult]
   'stats/get': [StatsGetParams, StatsResult]
   'engine/status': [EngineStatusParams, EngineStatusResult]
 }

package/src/index.ts

@@ -11,7 +11,11 @@ export type {
   MessageReader,
   MessageWriter,
 } from 'vscode-jsonrpc'
-export { CancellationToken, CancellationTokenSource } from 'vscode-jsonrpc'
+export {
+  CancellationToken,
+  CancellationTokenSource,
+  ResponseError,
+} from 'vscode-jsonrpc'
 export type {
   MdxpConnection,
   MdxpNotificationMap,

package/src/methods.ts

@@ -2,6 +2,7 @@
 export const Methods = Object.freeze({
   MotrixInitialize: 'motrix/initialize',
   DownloadSubmit: 'download/submit',
+  DownloadDirectories: 'download/directories',
   DownloadCancel: 'download/cancel',
   UrlProbe: 'url/probe',
   UrlResolve: 'url/resolve',
@@ -13,6 +14,7 @@ export const Methods = Object.freeze({
   TaskPause: 'task/pause',
   TaskResume: 'task/resume',
   TaskRemove: 'task/remove',
+  TaskReveal: 'task/reveal',
   StatsGet: 'stats/get',
   EngineStatus: 'engine/status',
 } as const)

package/src/schemas/download-directories.ts

@@ -0,0 +1,26 @@
+import { z } from 'zod'
+
+/** Native paths belong to the target Motrix host, never the browser machine. */
+export const DownloadDirectoryPathSchema = z
+  .string()
+  .min(1)
+  .max(4096)
+  .refine(
+    (value) => !value.includes('\0'),
+    'Directory paths must not contain NUL'
+  )
+
+export const DownloadDirectoriesParamsSchema = z.object({}).strict()
+export const DownloadDirectoriesResultSchema = z.object({
+  /** Null when the configured default is currently unavailable. */
+  defaultSaveDir: DownloadDirectoryPathSchema.nullable(),
+  favorites: z.array(DownloadDirectoryPathSchema).max(20),
+  recent: z.array(DownloadDirectoryPathSchema).max(10),
+})
+
+export type DownloadDirectoriesParams = z.infer<
+  typeof DownloadDirectoriesParamsSchema
+>
+export type DownloadDirectoriesResult = z.infer<
+  typeof DownloadDirectoriesResultSchema
+>

package/src/schemas/download.ts

@@ -1,4 +1,5 @@
 import { z } from 'zod'
+import { DownloadDirectoryPathSchema } from './download-directories.js'
 import { SelectionSchema } from './selection.js'
 
 export const DownloadSubmitParamsSchema = z.object({
@@ -9,6 +10,8 @@ export const DownloadSubmitParamsSchema = z.object({
     siteHint: z.string().max(64).optional(),
   }),
   selection: SelectionSchema,
+  /** Only when capabilities.downloadDirectories is true; must be a listed path. */
+  saveDir: DownloadDirectoryPathSchema.optional(),
   meta: z.object({
     suggestedFilename: z.string().max(255),
     qualityLabel: z.string().max(64),

package/src/schemas/index.ts

@@ -1,5 +1,6 @@
 export * from './download.js'
 export * from './download-add.js'
+export * from './download-directories.js'
 export * from './engine.js'
 export * from './events.js'
 export * from './initialize.js'

package/src/schemas/initialize.ts

@@ -70,6 +70,10 @@ const ServerCapabilitiesSchema = z.object({
   selectionKinds: z.array(z.enum(['direct', 'hls', 'dash', 'mux'])),
   progress: z.boolean(),
   cancellation: z.boolean(),
+  /** Optional on the wire for protocol 1.0 compatibility; absent is false. */
+  taskReveal: z.boolean().optional().default(false),
+  /** Enables download/directories AND download/submit.saveDir; absent is false. */
+  downloadDirectories: z.boolean().optional(),
 })
 
 export const InitializeResultSchema = z.object({

package/src/schemas/task.ts

@@ -101,6 +101,12 @@ export const TaskRemoveParamsSchema = z.strictObject({
   deleteFiles: z.boolean().optional(),
 })
 
+// ─── task/reveal ──────────────────────────────────────────────
+/** Ask the host to reveal a task's output in the platform file manager. */
+export const TaskRevealParamsSchema = z.strictObject({
+  taskId: z.string().min(1),
+})
+
 export type MdxpTaskStatus = z.infer<typeof MdxpTaskStatusSchema>
 export type MdxpTaskType = z.infer<typeof MdxpTaskTypeSchema>
 export type MdxpTask = z.infer<typeof MdxpTaskSchema>
@@ -115,3 +121,5 @@ export type TaskResumeParams = z.infer<typeof TaskResumeParamsSchema>
 export type TaskResumeResult = OkResult
 export type TaskRemoveParams = z.infer<typeof TaskRemoveParamsSchema>
 export type TaskRemoveResult = OkResult
+export type TaskRevealParams = z.infer<typeof TaskRevealParamsSchema>
+export type TaskRevealResult = OkResult

package/src/tools.ts

@@ -10,6 +10,10 @@ import {
   DownloadAddParamsSchema,
   DownloadAddResultSchema,
 } from './schemas/download-add.js'
+import {
+  DownloadDirectoriesParamsSchema,
+  DownloadDirectoriesResultSchema,
+} from './schemas/download-directories.js'
 import {
   EngineStatusParamsSchema,
   EngineStatusResultSchema,
@@ -32,6 +36,7 @@ import {
   TaskPauseParamsSchema,
   TaskRemoveParamsSchema,
   TaskResumeParamsSchema,
+  TaskRevealParamsSchema,
 } from './schemas/task.js'
 
 export interface MdxpToolDef {
@@ -77,6 +82,14 @@ export const Tools: Readonly<Record<string, MdxpToolDef>> = {
     resultSchema: SystemPingResultSchema,
     agentFacing: false,
   },
+  [Methods.DownloadDirectories]: {
+    method: Methods.DownloadDirectories,
+    description:
+      'List available default, favorite and recent directories on the Motrix host.',
+    paramsSchema: DownloadDirectoriesParamsSchema,
+    resultSchema: DownloadDirectoriesResultSchema,
+    agentFacing: false,
+  },
   [Methods.DownloadSubmit]: {
     method: Methods.DownloadSubmit,
     description:
@@ -135,6 +148,13 @@ export const Tools: Readonly<Record<string, MdxpToolDef>> = {
     resultSchema: OkResultSchema,
     agentFacing: true,
   },
+  [Methods.TaskReveal]: {
+    method: Methods.TaskReveal,
+    description: "Reveal a task's output in the platform file manager.",
+    paramsSchema: TaskRevealParamsSchema,
+    resultSchema: OkResultSchema,
+    agentFacing: false,
+  },
   [Methods.StatsGet]: {
     method: Methods.StatsGet,
     description: 'Get aggregate global stats (speeds + task counts).',

package/src/types.ts

@@ -8,6 +8,10 @@ export type {
   DownloadAddParams,
   DownloadAddResult,
 } from './schemas/download-add.js'
+export type {
+  DownloadDirectoriesParams,
+  DownloadDirectoriesResult,
+} from './schemas/download-directories.js'
 export type {
   EngineFeatureReport,
   EngineState,
@@ -54,6 +58,8 @@ export type {
   TaskRemoveResult,
   TaskResumeParams,
   TaskResumeResult,
+  TaskRevealParams,
+  TaskRevealResult,
 } from './schemas/task.js'
 export type {
   UrlProbeParams,