@lspeasy/core 2.1.2 → 2.1.3

package/dist/middleware/pipeline.js

@@ -27,6 +27,28 @@ function shouldRun(registration, context) {
         messageType: context.messageType
     });
 }
+/**
+ * Runs the registered middleware chain for a single JSON-RPC message, then
+ * calls `finalHandler` if no middleware short-circuits.
+ *
+ * @remarks
+ * This is the core dispatch loop used by `LSPClient` and `LSPServer`. Each
+ * middleware receives `context` and a `next` callback; calling `next()` hands
+ * control to the following middleware. If a middleware returns a result with
+ * `shortCircuit: true` the remaining middleware and `finalHandler` are skipped.
+ *
+ * Scoped middleware (created with `createScopedMiddleware`) is automatically
+ * filtered: it only executes when `matchesFilter` returns `true` for the
+ * current message.
+ *
+ * @param registrations - The list of middleware or scoped-middleware to run.
+ * @param context - The shared context for the current message.
+ * @param finalHandler - The handler to call after all middleware have run.
+ * @returns The result of the first short-circuiting middleware, or the result
+ *   of `finalHandler`.
+ *
+ * @category Middleware
+ */
 export async function executeMiddlewarePipeline(registrations, context, finalHandler) {
     const entries = registrations ?? [];
     if (entries.length === 0) {

package/dist/middleware/pipeline.js.map

@@ -1 +1 @@
-{"version":3,"file":"pipeline.js","sourceRoot":"","sources":["../../src/middleware/pipeline.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,kBAAkB,EAAE,aAAa,EAAE,MAAM,aAAa,CAAC;AAIhE,SAAS,YAAY,CAAC,OAAqC,EAAsC;IAC/F,IAAI,IAAI,IAAI,OAAO,EAAE,CAAC;QACpB,OAAO,OAAO,CAAC,EAAE,CAAC;IACpB,CAAC;IACD,OAAO,SAAS,CAAC;AAAA,CAClB;AAED,SAAS,wBAAwB,CAC/B,MAA0C,EAC1C,OAA0B,EACpB;IACN,MAAM,KAAK,GAAG,YAAY,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;IAC5C,IAAI,MAAM,KAAK,KAAK,EAAE,CAAC;QACrB,MAAM,IAAI,KAAK,CAAC,8CAA8C,CAAC,CAAC;IAClE,CAAC;AAAA,CACF;AAED,SAAS,aAAa,CAAC,YAAoC,EAAc;IACvE,IAAI,kBAAkB,CAAC,YAAY,CAAC,EAAE,CAAC;QACrC,OAAO,YAAY,CAAC,UAAU,CAAC;IACjC,CAAC;IACD,OAAO,YAAY,CAAC;AAAA,CACrB;AAED,SAAS,SAAS,CAAC,YAAoC,EAAE,OAA0B,EAAW;IAC5F,IAAI,CAAC,kBAAkB,CAAC,YAAY,CAAC,EAAE,CAAC;QACtC,OAAO,IAAI,CAAC;IACd,CAAC;IAED,OAAO,aAAa,CAAC,YAAY,CAAC,MAAM,EAAE;QACxC,MAAM,EAAE,OAAO,CAAC,MAAM;QACtB,SAAS,EAAE,OAAO,CAAC,SAAS;QAC5B,WAAW,EAAE,OAAO,CAAC,WAAW;KACjC,CAAC,CAAC;AAAA,CACJ;AAED,MAAM,CAAC,KAAK,UAAU,yBAAyB,CAC7C,aAAmD,EACnD,OAA0B,EAC1B,YAAoD,EAClB;IAClC,MAAM,OAAO,GAAG,aAAa,IAAI,EAAE,CAAC;IACpC,IAAI,OAAO,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QACzB,OAAO,YAAY,EAAE,CAAC;IACxB,CAAC;IAED,MAAM,QAAQ,GAAG,KAAK,EAAE,KAAa,EAAoC,EAAE,CAAC;QAC1E,IAAI,KAAK,IAAI,OAAO,CAAC,MAAM,EAAE,CAAC;YAC5B,OAAO,YAAY,EAAE,CAAC;QACxB,CAAC;QAED,MAAM,YAAY,GAAG,OAAO,CAAC,KAAK,CAAC,CAAC;QACpC,IAAI,CAAC,YAAY,IAAI,CAAC,SAAS,CAAC,YAAY,EAAE,OAAO,CAAC,EAAE,CAAC;YACvD,OAAO,QAAQ,CAAC,KAAK,GAAG,CAAC,CAAC,CAAC;QAC7B,CAAC;QAED,MAAM,UAAU,GAAG,aAAa,CAAC,YAAY,CAAC,CAAC;QAC/C,MAAM,eAAe,GAAG,YAAY,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;QACtD,MAAM,MAAM,GAAG,MAAM,UAAU,CAAC,OAAO,EAAE,GAAG,EAAE,CAAC,QAAQ,CAAC,KAAK,GAAG,CAAC,CAAC,CAAC,CAAC;QACpE,wBAAwB,CAAC,eAAe,EAAE,OAAO,CAAC,CAAC;QAEnD,IAAI,MAAM,EAAE,YAAY,EAAE,CAAC;YACzB,OAAO,MAAM,CAAC;QAChB,CAAC;QAED,OAAO,MAAM,CAAC;IAAA,CACf,CAAC;IAEF,OAAO,QAAQ,CAAC,CAAC,CAAC,CAAC;AAAA,CACpB"}
+{"version":3,"file":"pipeline.js","sourceRoot":"","sources":["../../src/middleware/pipeline.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,kBAAkB,EAAE,aAAa,EAAE,MAAM,aAAa,CAAC;AAIhE,SAAS,YAAY,CAAC,OAAqC;IACzD,IAAI,IAAI,IAAI,OAAO,EAAE,CAAC;QACpB,OAAO,OAAO,CAAC,EAAE,CAAC;IACpB,CAAC;IACD,OAAO,SAAS,CAAC;AACnB,CAAC;AAED,SAAS,wBAAwB,CAC/B,MAA0C,EAC1C,OAA0B;IAE1B,MAAM,KAAK,GAAG,YAAY,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;IAC5C,IAAI,MAAM,KAAK,KAAK,EAAE,CAAC;QACrB,MAAM,IAAI,KAAK,CAAC,8CAA8C,CAAC,CAAC;IAClE,CAAC;AACH,CAAC;AAED,SAAS,aAAa,CAAC,YAAoC;IACzD,IAAI,kBAAkB,CAAC,YAAY,CAAC,EAAE,CAAC;QACrC,OAAO,YAAY,CAAC,UAAU,CAAC;IACjC,CAAC;IACD,OAAO,YAAY,CAAC;AACtB,CAAC;AAED,SAAS,SAAS,CAAC,YAAoC,EAAE,OAA0B;IACjF,IAAI,CAAC,kBAAkB,CAAC,YAAY,CAAC,EAAE,CAAC;QACtC,OAAO,IAAI,CAAC;IACd,CAAC;IAED,OAAO,aAAa,CAAC,YAAY,CAAC,MAAM,EAAE;QACxC,MAAM,EAAE,OAAO,CAAC,MAAM;QACtB,SAAS,EAAE,OAAO,CAAC,SAAS;QAC5B,WAAW,EAAE,OAAO,CAAC,WAAW;KACjC,CAAC,CAAC;AACL,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,MAAM,CAAC,KAAK,UAAU,yBAAyB,CAC7C,aAAmD,EACnD,OAA0B,EAC1B,YAAoD;IAEpD,MAAM,OAAO,GAAG,aAAa,IAAI,EAAE,CAAC;IACpC,IAAI,OAAO,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QACzB,OAAO,YAAY,EAAE,CAAC;IACxB,CAAC;IAED,MAAM,QAAQ,GAAG,KAAK,EAAE,KAAa,EAAoC,EAAE;QACzE,IAAI,KAAK,IAAI,OAAO,CAAC,MAAM,EAAE,CAAC;YAC5B,OAAO,YAAY,EAAE,CAAC;QACxB,CAAC;QAED,MAAM,YAAY,GAAG,OAAO,CAAC,KAAK,CAAC,CAAC;QACpC,IAAI,CAAC,YAAY,IAAI,CAAC,SAAS,CAAC,YAAY,EAAE,OAAO,CAAC,EAAE,CAAC;YACvD,OAAO,QAAQ,CAAC,KAAK,GAAG,CAAC,CAAC,CAAC;QAC7B,CAAC;QAED,MAAM,UAAU,GAAG,aAAa,CAAC,YAAY,CAAC,CAAC;QAC/C,MAAM,eAAe,GAAG,YAAY,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;QACtD,MAAM,MAAM,GAAG,MAAM,UAAU,CAAC,OAAO,EAAE,GAAG,EAAE,CAAC,QAAQ,CAAC,KAAK,GAAG,CAAC,CAAC,CAAC,CAAC;QACpE,wBAAwB,CAAC,eAAe,EAAE,OAAO,CAAC,CAAC;QAEnD,IAAI,MAAM,EAAE,YAAY,EAAE,CAAC;YACzB,OAAO,MAAM,CAAC;QAChB,CAAC;QAED,OAAO,MAAM,CAAC;IAChB,CAAC,CAAC;IAEF,OAAO,QAAQ,CAAC,CAAC,CAAC,CAAC;AACrB,CAAC"}

package/dist/middleware/scoped.d.ts

@@ -1,4 +1,32 @@
 import type { MethodFilter, Middleware, MiddlewareMessageType, ScopedMiddleware } from './types.js';
+/**
+ * Wraps a middleware with a filter so it only runs for matching LSP messages.
+ *
+ * @remarks
+ * Prefer this over putting an `if (context.method === '...')` guard inside
+ * your middleware — scoped middleware is skipped before the function is even
+ * called, which keeps the pipeline overhead low.
+ *
+ * @param filter - A {@link MethodFilter} describing which messages to intercept.
+ * @param middleware - The middleware function to run when the filter matches.
+ * @returns A {@link ScopedMiddleware} object ready to pass to `ServerOptions.middleware`
+ *   or `ClientOptions.middleware`.
+ *
+ * @example
+ * ```ts
+ * import { createScopedMiddleware } from '@lspeasy/core';
+ *
+ * const hoverLogger = createScopedMiddleware(
+ *   { methods: ['textDocument/hover'], direction: 'clientToServer' },
+ *   async (ctx, next) => {
+ *     console.log('hover params:', ctx.message);
+ *     return next();
+ *   }
+ * );
+ * ```
+ *
+ * @category Middleware
+ */
 export declare function createScopedMiddleware(filter: MethodFilter, middleware: Middleware): ScopedMiddleware;
 export declare function isScopedMiddleware(value: Middleware | ScopedMiddleware): value is ScopedMiddleware;
 export declare function matchesFilter(filter: MethodFilter, context: {

package/dist/middleware/scoped.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"scoped.d.ts","sourceRoot":"","sources":["../../src/middleware/scoped.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,YAAY,EAAE,UAAU,EAAE,qBAAqB,EAAE,gBAAgB,EAAE,MAAM,YAAY,CAAC;AAEpG,wBAAgB,sBAAsB,CACpC,MAAM,EAAE,YAAY,EACpB,UAAU,EAAE,UAAU,GACrB,gBAAgB,CAElB;AAED,wBAAgB,kBAAkB,CAChC,KAAK,EAAE,UAAU,GAAG,gBAAgB,GACnC,KAAK,IAAI,gBAAgB,CAE3B;AAED,wBAAgB,aAAa,CAC3B,MAAM,EAAE,YAAY,EACpB,OAAO,EAAE;IACP,MAAM,EAAE,MAAM,CAAC;IACf,SAAS,EAAE,gBAAgB,GAAG,gBAAgB,CAAC;IAC/C,WAAW,EAAE,qBAAqB,CAAC;CACpC,GACA,OAAO,CAeT"}
+{"version":3,"file":"scoped.d.ts","sourceRoot":"","sources":["../../src/middleware/scoped.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,YAAY,EAAE,UAAU,EAAE,qBAAqB,EAAE,gBAAgB,EAAE,MAAM,YAAY,CAAC;AAEpG;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AACH,wBAAgB,sBAAsB,CACpC,MAAM,EAAE,YAAY,EACpB,UAAU,EAAE,UAAU,GACrB,gBAAgB,CAElB;AAED,wBAAgB,kBAAkB,CAChC,KAAK,EAAE,UAAU,GAAG,gBAAgB,GACnC,KAAK,IAAI,gBAAgB,CAE3B;AAED,wBAAgB,aAAa,CAC3B,MAAM,EAAE,YAAY,EACpB,OAAO,EAAE;IACP,MAAM,EAAE,MAAM,CAAC;IACf,SAAS,EAAE,gBAAgB,GAAG,gBAAgB,CAAC;IAC/C,WAAW,EAAE,qBAAqB,CAAC;CACpC,GACA,OAAO,CAeT"}

package/dist/middleware/scoped.js

@@ -1,3 +1,31 @@
+/**
+ * Wraps a middleware with a filter so it only runs for matching LSP messages.
+ *
+ * @remarks
+ * Prefer this over putting an `if (context.method === '...')` guard inside
+ * your middleware — scoped middleware is skipped before the function is even
+ * called, which keeps the pipeline overhead low.
+ *
+ * @param filter - A {@link MethodFilter} describing which messages to intercept.
+ * @param middleware - The middleware function to run when the filter matches.
+ * @returns A {@link ScopedMiddleware} object ready to pass to `ServerOptions.middleware`
+ *   or `ClientOptions.middleware`.
+ *
+ * @example
+ * ```ts
+ * import { createScopedMiddleware } from '@lspeasy/core';
+ *
+ * const hoverLogger = createScopedMiddleware(
+ *   { methods: ['textDocument/hover'], direction: 'clientToServer' },
+ *   async (ctx, next) => {
+ *     console.log('hover params:', ctx.message);
+ *     return next();
+ *   }
+ * );
+ * ```
+ *
+ * @category Middleware
+ */
 export function createScopedMiddleware(filter, middleware) {
     return { filter, middleware };
 }

package/dist/middleware/scoped.js.map

@@ -1 +1 @@
-{"version":3,"file":"scoped.js","sourceRoot":"","sources":["../../src/middleware/scoped.ts"],"names":[],"mappings":"AAEA,MAAM,UAAU,sBAAsB,CACpC,MAAoB,EACpB,UAAsB,EACJ;IAClB,OAAO,EAAE,MAAM,EAAE,UAAU,EAAE,CAAC;AAAA,CAC/B;AAED,MAAM,UAAU,kBAAkB,CAChC,KAAoC,EACT;IAC3B,OAAO,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,KAAK,IAAI,IAAI,YAAY,IAAI,KAAK,IAAI,QAAQ,IAAI,KAAK,CAAC;AAAA,CAClG;AAED,MAAM,UAAU,aAAa,CAC3B,MAAoB,EACpB,OAIC,EACQ;IACT,MAAM,SAAS,GAAG,MAAM,CAAC,SAAS,IAAI,MAAM,CAAC;IAC7C,IAAI,SAAS,KAAK,MAAM,IAAI,SAAS,KAAK,OAAO,CAAC,SAAS,EAAE,CAAC;QAC5D,OAAO,KAAK,CAAC;IACf,CAAC;IAED,IAAI,MAAM,CAAC,WAAW,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,QAAQ,CAAC,OAAO,CAAC,WAAW,CAAC,EAAE,CAAC;QAC5E,OAAO,KAAK,CAAC;IACf,CAAC;IAED,IAAI,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,OAAO,CAAC,EAAE,CAAC;QAClC,OAAO,MAAM,CAAC,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;IACjD,CAAC;IAED,OAAO,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;AAAA,CAC5C"}
+{"version":3,"file":"scoped.js","sourceRoot":"","sources":["../../src/middleware/scoped.ts"],"names":[],"mappings":"AAEA;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AACH,MAAM,UAAU,sBAAsB,CACpC,MAAoB,EACpB,UAAsB;IAEtB,OAAO,EAAE,MAAM,EAAE,UAAU,EAAE,CAAC;AAChC,CAAC;AAED,MAAM,UAAU,kBAAkB,CAChC,KAAoC;IAEpC,OAAO,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,KAAK,IAAI,IAAI,YAAY,IAAI,KAAK,IAAI,QAAQ,IAAI,KAAK,CAAC;AACnG,CAAC;AAED,MAAM,UAAU,aAAa,CAC3B,MAAoB,EACpB,OAIC;IAED,MAAM,SAAS,GAAG,MAAM,CAAC,SAAS,IAAI,MAAM,CAAC;IAC7C,IAAI,SAAS,KAAK,MAAM,IAAI,SAAS,KAAK,OAAO,CAAC,SAAS,EAAE,CAAC;QAC5D,OAAO,KAAK,CAAC;IACf,CAAC;IAED,IAAI,MAAM,CAAC,WAAW,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,QAAQ,CAAC,OAAO,CAAC,WAAW,CAAC,EAAE,CAAC;QAC5E,OAAO,KAAK,CAAC;IACf,CAAC;IAED,IAAI,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,OAAO,CAAC,EAAE,CAAC;QAClC,OAAO,MAAM,CAAC,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;IACjD,CAAC;IAED,OAAO,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;AAC7C,CAAC"}

package/dist/middleware/typed.d.ts

@@ -1,3 +1,33 @@
 import type { LSPMethod, ScopedMiddleware, TypedMiddleware } from './types.js';
+/**
+ * Creates a typed, method-scoped middleware with full TypeScript inference for
+ * the message params and result.
+ *
+ * @remarks
+ * `createTypedMiddleware` is the ergonomic alternative to `createScopedMiddleware`
+ * when you want both method filtering and typed access to `context.params` and
+ * `context.result`. The method literal is used at the type level to narrow the
+ * context object, so no casting is required inside the middleware body.
+ *
+ * @param method - The exact LSP method string to intercept (e.g. `'textDocument/hover'`).
+ * @param middleware - The typed middleware function to run for that method.
+ * @returns A {@link ScopedMiddleware} filtered to the given method.
+ *
+ * @example
+ * ```ts
+ * import { createTypedMiddleware } from '@lspeasy/core';
+ *
+ * const hoverMiddleware = createTypedMiddleware(
+ *   'textDocument/hover',
+ *   async (ctx, next) => {
+ *     // ctx.params is typed as HoverParams
+ *     console.log('hover at', ctx.params.position);
+ *     return next();
+ *   }
+ * );
+ * ```
+ *
+ * @category Middleware
+ */
 export declare function createTypedMiddleware<M extends LSPMethod>(method: M, middleware: TypedMiddleware<M>): ScopedMiddleware;
 //# sourceMappingURL=typed.d.ts.map

package/dist/middleware/typed.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"typed.d.ts","sourceRoot":"","sources":["../../src/middleware/typed.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,SAAS,EACT,gBAAgB,EAChB,eAAe,EAIhB,MAAM,YAAY,CAAC;AAGpB,wBAAgB,qBAAqB,CAAC,CAAC,SAAS,SAAS,EACvD,MAAM,EAAE,CAAC,EACT,UAAU,EAAE,eAAe,CAAC,CAAC,CAAC,GAC7B,gBAAgB,CAkBlB"}
+{"version":3,"file":"typed.d.ts","sourceRoot":"","sources":["../../src/middleware/typed.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,SAAS,EACT,gBAAgB,EAChB,eAAe,EAIhB,MAAM,YAAY,CAAC;AAGpB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6BG;AACH,wBAAgB,qBAAqB,CAAC,CAAC,SAAS,SAAS,EACvD,MAAM,EAAE,CAAC,EACT,UAAU,EAAE,eAAe,CAAC,CAAC,CAAC,GAC7B,gBAAgB,CAkBlB"}

package/dist/middleware/typed.js

@@ -1,4 +1,34 @@
 import { createScopedMiddleware } from './scoped.js';
+/**
+ * Creates a typed, method-scoped middleware with full TypeScript inference for
+ * the message params and result.
+ *
+ * @remarks
+ * `createTypedMiddleware` is the ergonomic alternative to `createScopedMiddleware`
+ * when you want both method filtering and typed access to `context.params` and
+ * `context.result`. The method literal is used at the type level to narrow the
+ * context object, so no casting is required inside the middleware body.
+ *
+ * @param method - The exact LSP method string to intercept (e.g. `'textDocument/hover'`).
+ * @param middleware - The typed middleware function to run for that method.
+ * @returns A {@link ScopedMiddleware} filtered to the given method.
+ *
+ * @example
+ * ```ts
+ * import { createTypedMiddleware } from '@lspeasy/core';
+ *
+ * const hoverMiddleware = createTypedMiddleware(
+ *   'textDocument/hover',
+ *   async (ctx, next) => {
+ *     // ctx.params is typed as HoverParams
+ *     console.log('hover at', ctx.params.position);
+ *     return next();
+ *   }
+ * );
+ * ```
+ *
+ * @category Middleware
+ */
 export function createTypedMiddleware(method, middleware) {
     return createScopedMiddleware({ methods: [method] }, async (context, next) => {
         const typedContextBase = {

package/dist/middleware/typed.js.map

@@ -1 +1 @@
-{"version":3,"file":"typed.js","sourceRoot":"","sources":["../../src/middleware/typed.ts"],"names":[],"mappings":"AAQA,OAAO,EAAE,sBAAsB,EAAE,MAAM,aAAa,CAAC;AAErD,MAAM,UAAU,qBAAqB,CACnC,MAAS,EACT,UAA8B,EACZ;IAClB,OAAO,sBAAsB,CAAC,EAAE,OAAO,EAAE,CAAC,MAAM,CAAC,EAAE,EAAE,KAAK,EAAE,OAAO,EAAE,IAAI,EAAE,EAAE,CAAC;QAC5E,MAAM,gBAAgB,GAAG;YACvB,GAAG,OAAO;YACV,MAAM;YACN,MAAM,EAAE,CAAC,QAAQ,IAAI,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,OAAO,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,SAAS,CAAmB;SAC7F,CAAC;QAEF,MAAM,YAAY,GAChB,QAAQ,IAAI,OAAO,CAAC,OAAO;YACzB,CAAC,CAAC;gBACE,GAAG,gBAAgB;gBACnB,MAAM,EAAE,OAAO,CAAC,OAAO,CAAC,MAAwB;aACjD;YACH,CAAC,CAAC,gBAAgB,CAAC;QAEvB,OAAO,UAAU,CAAC,YAAY,EAAE,IAAI,CAAC,CAAC;IAAA,CACvC,CAAC,CAAC;AAAA,CACJ"}
+{"version":3,"file":"typed.js","sourceRoot":"","sources":["../../src/middleware/typed.ts"],"names":[],"mappings":"AAQA,OAAO,EAAE,sBAAsB,EAAE,MAAM,aAAa,CAAC;AAErD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6BG;AACH,MAAM,UAAU,qBAAqB,CACnC,MAAS,EACT,UAA8B;IAE9B,OAAO,sBAAsB,CAAC,EAAE,OAAO,EAAE,CAAC,MAAM,CAAC,EAAE,EAAE,KAAK,EAAE,OAAO,EAAE,IAAI,EAAE,EAAE;QAC3E,MAAM,gBAAgB,GAAG;YACvB,GAAG,OAAO;YACV,MAAM;YACN,MAAM,EAAE,CAAC,QAAQ,IAAI,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,OAAO,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,SAAS,CAAmB;SAC7F,CAAC;QAEF,MAAM,YAAY,GAChB,QAAQ,IAAI,OAAO,CAAC,OAAO;YACzB,CAAC,CAAC;gBACE,GAAG,gBAAgB;gBACnB,MAAM,EAAE,OAAO,CAAC,OAAO,CAAC,MAAwB;aACjD;YACH,CAAC,CAAC,gBAAgB,CAAC;QAEvB,OAAO,UAAU,CAAC,YAAY,EAAE,IAAI,CAAC,CAAC;IACxC,CAAC,CAAC,CAAC;AACL,CAAC"}

package/dist/middleware/types.d.ts

@@ -1,44 +1,217 @@
 import type { ErrorResponseMessage, Message, NotificationMessage, RequestMessage, ResponseMessage } from '../jsonrpc/messages.js';
 import type { LSPNotificationMethod, LSPRequestMethod, ParamsForNotification, ParamsForRequest, ResultForRequest } from '../protocol/infer.js';
+/**
+ * Direction of a JSON-RPC message in the middleware pipeline.
+ *
+ * @category Middleware
+ */
 export type MiddlewareDirection = 'clientToServer' | 'serverToClient';
+/**
+ * Kind of JSON-RPC message flowing through middleware.
+ *
+ * @category Middleware
+ */
 export type MiddlewareMessageType = 'request' | 'response' | 'notification' | 'error';
 type ImmutableId<T> = T extends {
     id: infer I;
 } ? Omit<T, 'id'> & {
     readonly id: I;
 } : T;
+/**
+ * The JSON-RPC message exposed to middleware, with `id` made read-only to
+ * prevent accidental mutation that would break response correlation.
+ *
+ * @category Middleware
+ */
 export type MiddlewareMessage = ImmutableId<Message>;
+/**
+ * Execution context passed to every middleware function in the pipeline.
+ *
+ * @remarks
+ * `metadata` is a mutable bag-of-properties that middleware can use to pass
+ * data to downstream middleware or to the final handler. It is scoped to a
+ * single message and discarded after the pipeline completes.
+ *
+ * @category Middleware
+ */
 export interface MiddlewareContext {
+    /** Whether this message travels from client-to-server or server-to-client. */
     direction: MiddlewareDirection;
+    /** The kind of JSON-RPC message. */
     messageType: MiddlewareMessageType;
+    /** The LSP method string, e.g. `'textDocument/hover'`. */
     method: string;
+    /** The raw JSON-RPC message (id is read-only). */
     message: MiddlewareMessage;
+    /** Arbitrary key-value pairs for cross-middleware communication. */
     metadata: Record<string, unknown>;
+    /** Constructor name of the active transport, e.g. `'StdioTransport'`. */
     transport: string;
 }
+/**
+ * Union of all LSP request and notification method strings.
+ *
+ * @category Middleware
+ */
 export type LSPMethod = LSPRequestMethod | LSPNotificationMethod;
+/**
+ * Infers the params type for a given LSP method.
+ *
+ * @typeParam M - An LSP request or notification method string.
+ * @category Middleware
+ */
 export type TypedParams<M extends LSPMethod> = M extends LSPRequestMethod ? ParamsForRequest<M> : M extends LSPNotificationMethod ? ParamsForNotification<M> : never;
+/**
+ * Infers the result type for a given LSP method (void for notifications).
+ *
+ * @typeParam M - An LSP request or notification method string.
+ * @category Middleware
+ */
 export type TypedResult<M extends LSPMethod> = M extends LSPRequestMethod ? ResultForRequest<M> : void;
+/**
+ * Typed middleware context narrowed to a specific LSP method.
+ * Use with `createTypedMiddleware` for full type inference.
+ *
+ * @typeParam M - The specific LSP method this middleware handles.
+ * @category Middleware
+ */
 export interface TypedMiddlewareContext<M extends LSPMethod> extends MiddlewareContext {
+    /** The specific LSP method string this middleware context is scoped to. */
     method: M;
+    /** Typed parameters inferred from the LSP method signature. */
     params: TypedParams<M>;
+    /** Typed result, populated after `next()` resolves for request middleware. */
     result?: TypedResult<M>;
 }
+/**
+ * The return value from a middleware function.
+ *
+ * @remarks
+ * Return `undefined` or `void` to continue the pipeline normally.
+ * Set `shortCircuit: true` (plus `response` or `error`) to bypass all
+ * remaining middleware and the final handler.
+ *
+ * @never
+ * NEVER short-circuit a request without providing a valid `response` or
+ * `error` — the pending request will never resolve and the client will time
+ * out with no recourse.
+ *
+ * @category Middleware
+ */
 export interface MiddlewareResult {
+    /** When `true`, all remaining middleware and the final handler are bypassed. */
     shortCircuit?: boolean;
+    /** The response to return when short-circuiting a request. */
     response?: ResponseMessage | RequestMessage | NotificationMessage;
+    /** The error response to return when short-circuiting with a failure. */
     error?: ErrorResponseMessage;
 }
+/**
+ * Calls the next middleware (or final handler) in the pipeline.
+ *
+ * @category Middleware
+ */
 export type MiddlewareNext = () => Promise<void | MiddlewareResult>;
+/**
+ * A function that intercepts JSON-RPC messages flowing through `LSPServer`
+ * or `LSPClient`.
+ *
+ * @remarks
+ * Middleware follows the `async (context, next) => result` pattern familiar
+ * from Express / Koa. Call `next()` to continue the pipeline; return a
+ * `MiddlewareResult` with `shortCircuit: true` to bypass remaining handlers.
+ *
+ * @useWhen
+ * You need cross-cutting behavior across all (or a subset of) LSP messages:
+ * logging, tracing, authentication, rate-limiting, schema validation, or
+ * request mocking in tests.
+ *
+ * @avoidWhen
+ * You need to handle only a single method — register a dedicated
+ * `onRequest` / `onNotification` handler instead. Middleware adds overhead
+ * for every message regardless of method.
+ *
+ * @never
+ * NEVER mutate `context.message.id` — it is read-only by design. Response
+ * correlation depends on the ID remaining stable through the pipeline.
+ *
+ * NEVER `await next()` more than once per middleware invocation. The pipeline
+ * is not re-entrant; calling `next()` twice dispatches the underlying handler
+ * twice, producing duplicate responses or side effects.
+ *
+ * @example
+ * ```ts
+ * import type { Middleware } from '@lspeasy/core';
+ *
+ * const timingMiddleware: Middleware = async (context, next) => {
+ *   const start = Date.now();
+ *   const result = await next();
+ *   console.log(`${context.method} took ${Date.now() - start}ms`);
+ *   return result;
+ * };
+ *
+ * const server = new LSPServer({ middleware: [timingMiddleware] });
+ * ```
+ *
+ * @category Middleware
+ */
 export type Middleware = (context: MiddlewareContext, next: MiddlewareNext) => Promise<void | MiddlewareResult>;
+/**
+ * A middleware function narrowed to a specific LSP method with full type
+ * inference for `params` and `result`.
+ *
+ * @remarks
+ * Create with `createTypedMiddleware` to avoid manual generic parameters.
+ *
+ * @typeParam M - The LSP method string this middleware is scoped to.
+ * @category Middleware
+ */
 export type TypedMiddleware<M extends LSPMethod> = (context: TypedMiddlewareContext<M>, next: MiddlewareNext) => Promise<void | MiddlewareResult>;
+/**
+ * Filter predicate used by `ScopedMiddleware` to select which messages
+ * a middleware should intercept.
+ *
+ * @category Middleware
+ */
 export interface MethodFilter {
+    /** Method names or a regex to match against `context.method`. */
     methods: string[] | RegExp;
+    /** Limit to a specific direction, or `'both'` (default). */
     direction?: MiddlewareDirection | 'both';
+    /** Limit to specific message kinds. */
     messageType?: MiddlewareMessageType[];
 }
+/**
+ * A `Middleware` paired with a `MethodFilter` so it only runs for matching
+ * messages.
+ *
+ * @remarks
+ * Create with `createScopedMiddleware` for a more ergonomic API.
+ *
+ * @useWhen
+ * You want a middleware that only fires for a specific method (e.g. only
+ * `textDocument/completion`) without writing the guard inside the middleware
+ * body itself.
+ *
+ * @example
+ * ```ts
+ * import { createScopedMiddleware } from '@lspeasy/core';
+ *
+ * const completionLogger = createScopedMiddleware(
+ *   { methods: ['textDocument/completion'], direction: 'clientToServer' },
+ *   async (ctx, next) => {
+ *     console.log('completion request params:', ctx.message);
+ *     return next();
+ *   }
+ * );
+ * ```
+ *
+ * @category Middleware
+ */
 export interface ScopedMiddleware {
+    /** The filter predicate that determines which messages this middleware intercepts. */
     filter: MethodFilter;
+    /** The middleware function to execute when the filter matches. */
     middleware: Middleware;
 }
 export {};

package/dist/middleware/types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/middleware/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,oBAAoB,EACpB,OAAO,EACP,mBAAmB,EACnB,cAAc,EACd,eAAe,EAChB,MAAM,wBAAwB,CAAC;AAChC,OAAO,KAAK,EACV,qBAAqB,EACrB,gBAAgB,EAChB,qBAAqB,EACrB,gBAAgB,EAChB,gBAAgB,EACjB,MAAM,sBAAsB,CAAC;AAE9B,MAAM,MAAM,mBAAmB,GAAG,gBAAgB,GAAG,gBAAgB,CAAC;AAEtE,MAAM,MAAM,qBAAqB,GAAG,SAAS,GAAG,UAAU,GAAG,cAAc,GAAG,OAAO,CAAC;AAEtF,KAAK,WAAW,CAAC,CAAC,IAAI,CAAC,SAAS;IAAE,EAAE,EAAE,MAAM,CAAC,CAAA;CAAE,GAAG,IAAI,CAAC,CAAC,EAAE,IAAI,CAAC,GAAG;IAAE,QAAQ,CAAC,EAAE,EAAE,CAAC,CAAA;CAAE,GAAG,CAAC,CAAC;AAEzF,MAAM,MAAM,iBAAiB,GAAG,WAAW,CAAC,OAAO,CAAC,CAAC;AAErD,MAAM,WAAW,iBAAiB;IAChC,SAAS,EAAE,mBAAmB,CAAC;IAC/B,WAAW,EAAE,qBAAqB,CAAC;IACnC,MAAM,EAAE,MAAM,CAAC;IACf,OAAO,EAAE,iBAAiB,CAAC;IAC3B,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAClC,SAAS,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,MAAM,SAAS,GAAG,gBAAgB,GAAG,qBAAqB,CAAC;AAEjE,MAAM,MAAM,WAAW,CAAC,CAAC,SAAS,SAAS,IAAI,CAAC,SAAS,gBAAgB,GACrE,gBAAgB,CAAC,CAAC,CAAC,GACnB,CAAC,SAAS,qBAAqB,GAC7B,qBAAqB,CAAC,CAAC,CAAC,GACxB,KAAK,CAAC;AAEZ,MAAM,MAAM,WAAW,CAAC,CAAC,SAAS,SAAS,IAAI,CAAC,SAAS,gBAAgB,GACrE,gBAAgB,CAAC,CAAC,CAAC,GACnB,IAAI,CAAC;AAET,MAAM,WAAW,sBAAsB,CAAC,CAAC,SAAS,SAAS,CAAE,SAAQ,iBAAiB;IACpF,MAAM,EAAE,CAAC,CAAC;IACV,MAAM,EAAE,WAAW,CAAC,CAAC,CAAC,CAAC;IACvB,MAAM,CAAC,EAAE,WAAW,CAAC,CAAC,CAAC,CAAC;CACzB;AAED,MAAM,WAAW,gBAAgB;IAC/B,YAAY,CAAC,EAAE,OAAO,CAAC;IACvB,QAAQ,CAAC,EAAE,eAAe,GAAG,cAAc,GAAG,mBAAmB,CAAC;IAClE,KAAK,CAAC,EAAE,oBAAoB,CAAC;CAC9B;AAED,MAAM,MAAM,cAAc,GAAG,MAAM,OAAO,CAAC,IAAI,GAAG,gBAAgB,CAAC,CAAC;AAEpE,MAAM,MAAM,UAAU,GAAG,CACvB,OAAO,EAAE,iBAAiB,EAC1B,IAAI,EAAE,cAAc,KACjB,OAAO,CAAC,IAAI,GAAG,gBAAgB,CAAC,CAAC;AAEtC,MAAM,MAAM,eAAe,CAAC,CAAC,SAAS,SAAS,IAAI,CACjD,OAAO,EAAE,sBAAsB,CAAC,CAAC,CAAC,EAClC,IAAI,EAAE,cAAc,KACjB,OAAO,CAAC,IAAI,GAAG,gBAAgB,CAAC,CAAC;AAEtC,MAAM,WAAW,YAAY;IAC3B,OAAO,EAAE,MAAM,EAAE,GAAG,MAAM,CAAC;IAC3B,SAAS,CAAC,EAAE,mBAAmB,GAAG,MAAM,CAAC;IACzC,WAAW,CAAC,EAAE,qBAAqB,EAAE,CAAC;CACvC;AAED,MAAM,WAAW,gBAAgB;IAC/B,MAAM,EAAE,YAAY,CAAC;IACrB,UAAU,EAAE,UAAU,CAAC;CACxB"}
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/middleware/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,oBAAoB,EACpB,OAAO,EACP,mBAAmB,EACnB,cAAc,EACd,eAAe,EAChB,MAAM,wBAAwB,CAAC;AAChC,OAAO,KAAK,EACV,qBAAqB,EACrB,gBAAgB,EAChB,qBAAqB,EACrB,gBAAgB,EAChB,gBAAgB,EACjB,MAAM,sBAAsB,CAAC;AAE9B;;;;GAIG;AACH,MAAM,MAAM,mBAAmB,GAAG,gBAAgB,GAAG,gBAAgB,CAAC;AAEtE;;;;GAIG;AACH,MAAM,MAAM,qBAAqB,GAAG,SAAS,GAAG,UAAU,GAAG,cAAc,GAAG,OAAO,CAAC;AAEtF,KAAK,WAAW,CAAC,CAAC,IAAI,CAAC,SAAS;IAAE,EAAE,EAAE,MAAM,CAAC,CAAA;CAAE,GAAG,IAAI,CAAC,CAAC,EAAE,IAAI,CAAC,GAAG;IAAE,QAAQ,CAAC,EAAE,EAAE,CAAC,CAAA;CAAE,GAAG,CAAC,CAAC;AAEzF;;;;;GAKG;AACH,MAAM,MAAM,iBAAiB,GAAG,WAAW,CAAC,OAAO,CAAC,CAAC;AAErD;;;;;;;;;GASG;AACH,MAAM,WAAW,iBAAiB;IAChC,8EAA8E;IAC9E,SAAS,EAAE,mBAAmB,CAAC;IAC/B,oCAAoC;IACpC,WAAW,EAAE,qBAAqB,CAAC;IACnC,0DAA0D;IAC1D,MAAM,EAAE,MAAM,CAAC;IACf,kDAAkD;IAClD,OAAO,EAAE,iBAAiB,CAAC;IAC3B,oEAAoE;IACpE,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAClC,yEAAyE;IACzE,SAAS,EAAE,MAAM,CAAC;CACnB;AAED;;;;GAIG;AACH,MAAM,MAAM,SAAS,GAAG,gBAAgB,GAAG,qBAAqB,CAAC;AAEjE;;;;;GAKG;AACH,MAAM,MAAM,WAAW,CAAC,CAAC,SAAS,SAAS,IAAI,CAAC,SAAS,gBAAgB,GACrE,gBAAgB,CAAC,CAAC,CAAC,GACnB,CAAC,SAAS,qBAAqB,GAC7B,qBAAqB,CAAC,CAAC,CAAC,GACxB,KAAK,CAAC;AAEZ;;;;;GAKG;AACH,MAAM,MAAM,WAAW,CAAC,CAAC,SAAS,SAAS,IAAI,CAAC,SAAS,gBAAgB,GACrE,gBAAgB,CAAC,CAAC,CAAC,GACnB,IAAI,CAAC;AAET;;;;;;GAMG;AACH,MAAM,WAAW,sBAAsB,CAAC,CAAC,SAAS,SAAS,CAAE,SAAQ,iBAAiB;IACpF,2EAA2E;IAC3E,MAAM,EAAE,CAAC,CAAC;IACV,+DAA+D;IAC/D,MAAM,EAAE,WAAW,CAAC,CAAC,CAAC,CAAC;IACvB,8EAA8E;IAC9E,MAAM,CAAC,EAAE,WAAW,CAAC,CAAC,CAAC,CAAC;CACzB;AAED;;;;;;;;;;;;;;GAcG;AACH,MAAM,WAAW,gBAAgB;IAC/B,gFAAgF;IAChF,YAAY,CAAC,EAAE,OAAO,CAAC;IACvB,8DAA8D;IAC9D,QAAQ,CAAC,EAAE,eAAe,GAAG,cAAc,GAAG,mBAAmB,CAAC;IAClE,yEAAyE;IACzE,KAAK,CAAC,EAAE,oBAAoB,CAAC;CAC9B;AAED;;;;GAIG;AACH,MAAM,MAAM,cAAc,GAAG,MAAM,OAAO,CAAC,IAAI,GAAG,gBAAgB,CAAC,CAAC;AAEpE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA0CG;AACH,MAAM,MAAM,UAAU,GAAG,CACvB,OAAO,EAAE,iBAAiB,EAC1B,IAAI,EAAE,cAAc,KACjB,OAAO,CAAC,IAAI,GAAG,gBAAgB,CAAC,CAAC;AAEtC;;;;;;;;;GASG;AACH,MAAM,MAAM,eAAe,CAAC,CAAC,SAAS,SAAS,IAAI,CACjD,OAAO,EAAE,sBAAsB,CAAC,CAAC,CAAC,EAClC,IAAI,EAAE,cAAc,KACjB,OAAO,CAAC,IAAI,GAAG,gBAAgB,CAAC,CAAC;AAEtC;;;;;GAKG;AACH,MAAM,WAAW,YAAY;IAC3B,iEAAiE;IACjE,OAAO,EAAE,MAAM,EAAE,GAAG,MAAM,CAAC;IAC3B,4DAA4D;IAC5D,SAAS,CAAC,EAAE,mBAAmB,GAAG,MAAM,CAAC;IACzC,uCAAuC;IACvC,WAAW,CAAC,EAAE,qBAAqB,EAAE,CAAC;CACvC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,MAAM,WAAW,gBAAgB;IAC/B,sFAAsF;IACtF,MAAM,EAAE,YAAY,CAAC;IACrB,kEAAkE;IAClE,UAAU,EAAE,UAAU,CAAC;CACxB"}

package/dist/protocol/capabilities.d.ts

@@ -15,55 +15,109 @@ export type { ServerCapabilities, ClientCapabilities };
  * Get the capability key for a given method at runtime
  */
 /**
- * Check if a method is supported by the given server capabilities
+ * Type-guarding predicate that narrows `capabilities` to include the specific
+ * server capability key required for the given client-to-server request method.
+ *
+ * @param method - The LSP request method string (e.g. `'textDocument/hover'`).
+ * @param capabilities - The `ServerCapabilities` object to test.
+ * @returns `true` when the server has declared support for the method.
  */
 export declare function serverSupportsRequest<M extends LSPRequestMethod<'clientToServer'>>(method: M, capabilities: ServerCapabilities): capabilities is ServerCapabilities & PickDeep<ServerCapabilities, ServerCapabilityForRequest<M>>;
+/**
+ * Type-guarding predicate that narrows `capabilities` to include the specific
+ * server capability key required for the given client-to-server notification method.
+ *
+ * @param method - The LSP notification method string (e.g. `'textDocument/didOpen'`).
+ * @param capabilities - The `ServerCapabilities` object to test.
+ * @returns `true` when the server has declared support for the method.
+ */
 export declare function serverSupportsNotification<M extends LSPNotificationMethod<'clientToServer'>, T extends Partial<ServerCapabilities>>(method: M, capabilities: T): capabilities is T & PickDeep<ServerCapabilities, ServerCapabilityForNotification<M>>;
 /**
- * Check if a method is supported by the given client capabilities
+ * Type-guarding predicate that narrows `capabilities` to include the specific
+ * client capability key required for the given server-to-client request method.
+ *
+ * @param method - The LSP request method string (e.g. `'client/registerCapability'`).
+ * @param capabilities - The `ClientCapabilities` object to test.
+ * @returns `true` when the client has declared support for the method.
  */
 export declare function clientSupportsRequest<M extends LSPRequestMethod<'serverToClient'>, T extends Partial<ClientCapabilities>>(method: M, capabilities: T): capabilities is T & PickDeep<ClientCapabilities, ClientCapabilityForRequest<M>>;
+/**
+ * Type-guarding predicate that narrows `capabilities` to include the specific
+ * client capability key required for the given server-to-client notification method.
+ *
+ * @param method - The LSP notification method string (e.g. `'window/logMessage'`).
+ * @param capabilities - The `ClientCapabilities` object to test.
+ * @returns `true` when the client has declared support for the method.
+ */
 export declare function clientSupportsNotification<M extends LSPNotificationMethod<'serverToClient'>, T extends Partial<ClientCapabilities>>(method: M, capabilities: T): capabilities is T & PickDeep<ClientCapabilities, ClientCapabilityForNotification<M>>;
 /**
- * Check if a server capability is enabled
+ * Type-guarding predicate that narrows `capabilities` to confirm a specific server capability
+ * is enabled at a deep dot-notation path.
+ *
+ * @param capabilities - The server capabilities to check.
+ * @param capability - Dot-notation path of the capability (e.g. `'hoverProvider'`).
+ * @returns `true` when the capability at the given path is truthy.
  */
 export declare function hasServerCapability<K extends Paths<ServerCapabilities>, T extends Partial<ServerCapabilities>>(capabilities: T, capability: K): capabilities is T & PickDeep<ServerCapabilities, K>;
 /**
- * Check if a client capability is enabled
+ * Type-guarding predicate that narrows `capabilities` to confirm a specific client capability
+ * is enabled at a deep dot-notation path.
+ *
+ * @param capabilities - The client capabilities to check.
+ * @param capability - Dot-notation path of the capability (e.g. `'window.workDoneProgress'`).
+ * @returns `true` when the capability at the given path is truthy.
  */
 export declare function hasClientCapability<K extends Paths<ClientCapabilities>, T extends Partial<ClientCapabilities>>(capabilities: T, capability: K): capabilities is T & PickDeep<ClientCapabilities, K>;
 /**
- * Helper to check if hover is supported
+ * Returns `true` when `hoverProvider` is declared in the server capabilities.
+ *
+ * @param capabilities - The server capabilities to check.
+ * @returns `true` when hover is supported.
  */
 export declare function supportsHover(capabilities: ServerCapabilities): capabilities is ServerCapabilities & {
     hoverProvider: NonNullable<ServerCapabilities['hoverProvider']>;
 };
 /**
- * Helper to check if completion is supported
+ * Returns `true` when `completionProvider` is declared in the server capabilities.
+ *
+ * @param capabilities - The server capabilities to check.
+ * @returns `true` when completion is supported.
  */
 export declare function supportsCompletion(capabilities: ServerCapabilities): capabilities is ServerCapabilities & {
     completionProvider: NonNullable<ServerCapabilities['completionProvider']>;
 };
 /**
- * Helper to check if definition is supported
+ * Returns `true` when `definitionProvider` is declared in the server capabilities.
+ *
+ * @param capabilities - The server capabilities to check.
+ * @returns `true` when go-to-definition is supported.
  */
 export declare function supportsDefinition(capabilities: ServerCapabilities): capabilities is ServerCapabilities & {
     definitionProvider: NonNullable<ServerCapabilities['definitionProvider']>;
 };
 /**
- * Helper to check if references are supported
+ * Returns `true` when `referencesProvider` is declared in the server capabilities.
+ *
+ * @param capabilities - The server capabilities to check.
+ * @returns `true` when find-references is supported.
  */
 export declare function supportsReferences(capabilities: ServerCapabilities): capabilities is ServerCapabilities & {
     referencesProvider: NonNullable<ServerCapabilities['referencesProvider']>;
 };
 /**
- * Helper to check if document symbols are supported
+ * Returns `true` when `documentSymbolProvider` is declared in the server capabilities.
+ *
+ * @param capabilities - The server capabilities to check.
+ * @returns `true` when document symbols are supported.
  */
 export declare function supportsDocumentSymbol(capabilities: ServerCapabilities): capabilities is ServerCapabilities & {
     documentSymbolProvider: NonNullable<ServerCapabilities['documentSymbolProvider']>;
 };
 /**
- * Helper to check if workspace folders are supported
+ * Returns `true` when the server supports workspace folders.
+ *
+ * @param capabilities - The server capabilities to check.
+ * @returns `true` when `workspace.workspaceFolders.supported` is `true`.
  */
 export declare function supportsWorkspaceFolders(capabilities: ServerCapabilities): capabilities is ServerCapabilities & {
     workspace: {
@@ -72,11 +126,20 @@ export declare function supportsWorkspaceFolders(capabilities: ServerCapabilitie
         };
     };
 };
+/**
+ * Helper to check if notebook document sync is supported by the server.
+ *
+ * @param capabilities - The server capabilities to check.
+ * @returns `true` when `notebookDocumentSync` is declared (not null/undefined).
+ */
 export declare function supportsNotebookDocumentSync(capabilities: ServerCapabilities): capabilities is ServerCapabilities & {
     notebookDocumentSync: NonNullable<ServerCapabilities['notebookDocumentSync']>;
 };
 /**
- * Helper to check if file watching is supported
+ * Returns `true` when the client supports dynamic file watching registration.
+ *
+ * @param capabilities - The client capabilities to check.
+ * @returns `true` when `workspace.didChangeWatchedFiles.dynamicRegistration` is `true`.
  */
 export declare function supportsFileWatching(capabilities: ClientCapabilities): capabilities is ClientCapabilities & {
     workspace: {
@@ -86,7 +149,10 @@ export declare function supportsFileWatching(capabilities: ClientCapabilities):
     };
 };
 /**
- * Helper to check if work done progress is supported
+ * Returns `true` when the client supports work done progress notifications.
+ *
+ * @param capabilities - The client capabilities to check.
+ * @returns `true` when `window.workDoneProgress` is `true`.
  */
 export declare function supportsWorkDoneProgress(capabilities: ClientCapabilities): capabilities is ClientCapabilities & {
     window: {

package/dist/protocol/capabilities.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"capabilities.d.ts","sourceRoot":"","sources":["../../src/protocol/capabilities.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,KAAK,EAAE,kBAAkB,EAAE,kBAAkB,EAAE,MAAM,gCAAgC,CAAC;AAC7F,OAAO,KAAK,EAAE,KAAK,EAAE,QAAQ,EAAE,MAAM,WAAW,CAAC;AACjD,OAAO,EAKL,KAAK,qBAAqB,EAC1B,KAAK,gBAAgB,EACrB,KAAK,+BAA+B,EACpC,KAAK,0BAA0B,EAC/B,KAAK,+BAA+B,EACpC,KAAK,0BAA0B,EAChC,MAAM,YAAY,CAAC;AAGpB,YAAY,EAAE,kBAAkB,EAAE,kBAAkB,EAAE,CAAC;AAoCvD;;;GAGG;AAEH;;GAEG;AAEH;;GAEG;AACH,wBAAgB,qBAAqB,CAAC,CAAC,SAAS,gBAAgB,CAAC,gBAAgB,CAAC,EAChF,MAAM,EAAE,CAAC,EACT,YAAY,EAAE,kBAAkB,GAC/B,YAAY,IAAI,kBAAkB,GACnC,QAAQ,CAAC,kBAAkB,EAAE,0BAA0B,CAAC,CAAC,CAAC,CAAC,CAO5D;AAED,wBAAgB,0BAA0B,CACxC,CAAC,SAAS,qBAAqB,CAAC,gBAAgB,CAAC,EACjD,CAAC,SAAS,OAAO,CAAC,kBAAkB,CAAC,EAErC,MAAM,EAAE,CAAC,EACT,YAAY,EAAE,CAAC,GACd,YAAY,IAAI,CAAC,GAAG,QAAQ,CAAC,kBAAkB,EAAE,+BAA+B,CAAC,CAAC,CAAC,CAAC,CAOtF;AAED;;GAEG;AACH,wBAAgB,qBAAqB,CACnC,CAAC,SAAS,gBAAgB,CAAC,gBAAgB,CAAC,EAC5C,CAAC,SAAS,OAAO,CAAC,kBAAkB,CAAC,EAErC,MAAM,EAAE,CAAC,EACT,YAAY,EAAE,CAAC,GACd,YAAY,IAAI,CAAC,GAAG,QAAQ,CAAC,kBAAkB,EAAE,0BAA0B,CAAC,CAAC,CAAC,CAAC,CAOjF;AAED,wBAAgB,0BAA0B,CACxC,CAAC,SAAS,qBAAqB,CAAC,gBAAgB,CAAC,EACjD,CAAC,SAAS,OAAO,CAAC,kBAAkB,CAAC,EAErC,MAAM,EAAE,CAAC,EACT,YAAY,EAAE,CAAC,GACd,YAAY,IAAI,CAAC,GAAG,QAAQ,CAAC,kBAAkB,EAAE,+BAA+B,CAAC,CAAC,CAAC,CAAC,CAOtF;AAED;;GAEG;AACH,wBAAgB,mBAAmB,CACjC,CAAC,SAAS,KAAK,CAAC,kBAAkB,CAAC,EACnC,CAAC,SAAS,OAAO,CAAC,kBAAkB,CAAC,EACrC,YAAY,EAAE,CAAC,EAAE,UAAU,EAAE,CAAC,GAAG,YAAY,IAAI,CAAC,GAAG,QAAQ,CAAC,kBAAkB,EAAE,CAAC,CAAC,CAGrF;AAED;;GAEG;AACH,wBAAgB,mBAAmB,CACjC,CAAC,SAAS,KAAK,CAAC,kBAAkB,CAAC,EACnC,CAAC,SAAS,OAAO,CAAC,kBAAkB,CAAC,EACrC,YAAY,EAAE,CAAC,EAAE,UAAU,EAAE,CAAC,GAAG,YAAY,IAAI,CAAC,GAAG,QAAQ,CAAC,kBAAkB,EAAE,CAAC,CAAC,CAGrF;AAED;;GAEG;AACH,wBAAgB,aAAa,CAC3B,YAAY,EAAE,kBAAkB,GAC/B,YAAY,IAAI,kBAAkB,GAAG;IACtC,aAAa,EAAE,WAAW,CAAC,kBAAkB,CAAC,eAAe,CAAC,CAAC,CAAC;CACjE,CAEA;AAED;;GAEG;AACH,wBAAgB,kBAAkB,CAChC,YAAY,EAAE,kBAAkB,GAC/B,YAAY,IAAI,kBAAkB,GAAG;IACtC,kBAAkB,EAAE,WAAW,CAAC,kBAAkB,CAAC,oBAAoB,CAAC,CAAC,CAAC;CAC3E,CAEA;AAED;;GAEG;AACH,wBAAgB,kBAAkB,CAChC,YAAY,EAAE,kBAAkB,GAC/B,YAAY,IAAI,kBAAkB,GAAG;IACtC,kBAAkB,EAAE,WAAW,CAAC,kBAAkB,CAAC,oBAAoB,CAAC,CAAC,CAAC;CAC3E,CAEA;AAED;;GAEG;AACH,wBAAgB,kBAAkB,CAChC,YAAY,EAAE,kBAAkB,GAC/B,YAAY,IAAI,kBAAkB,GAAG;IACtC,kBAAkB,EAAE,WAAW,CAAC,kBAAkB,CAAC,oBAAoB,CAAC,CAAC,CAAC;CAC3E,CAEA;AAED;;GAEG;AACH,wBAAgB,sBAAsB,CACpC,YAAY,EAAE,kBAAkB,GAC/B,YAAY,IAAI,kBAAkB,GAAG;IACtC,sBAAsB,EAAE,WAAW,CAAC,kBAAkB,CAAC,wBAAwB,CAAC,CAAC,CAAC;CACnF,CAEA;AAED;;GAEG;AACH,wBAAgB,wBAAwB,CACtC,YAAY,EAAE,kBAAkB,GAC/B,YAAY,IAAI,kBAAkB,GAAG;IAAE,SAAS,EAAE;QAAE,gBAAgB,EAAE;YAAE,SAAS,EAAE,IAAI,CAAA;SAAE,CAAA;KAAE,CAAA;CAAE,CAE/F;AAED,wBAAgB,4BAA4B,CAC1C,YAAY,EAAE,kBAAkB,GAC/B,YAAY,IAAI,kBAAkB,GAAG;IACtC,oBAAoB,EAAE,WAAW,CAAC,kBAAkB,CAAC,sBAAsB,CAAC,CAAC,CAAC;CAC/E,CAIA;AAED;;GAEG;AACH,wBAAgB,oBAAoB,CAClC,YAAY,EAAE,kBAAkB,GAC/B,YAAY,IAAI,kBAAkB,GAAG;IACtC,SAAS,EAAE;QAAE,qBAAqB,EAAE;YAAE,mBAAmB,EAAE,IAAI,CAAA;SAAE,CAAA;KAAE,CAAC;CACrE,CAEA;AAED;;GAEG;AACH,wBAAgB,wBAAwB,CACtC,YAAY,EAAE,kBAAkB,GAC/B,YAAY,IAAI,kBAAkB,GAAG;IAAE,MAAM,EAAE;QAAE,gBAAgB,EAAE,IAAI,CAAA;KAAE,CAAA;CAAE,CAE7E"}
+{"version":3,"file":"capabilities.d.ts","sourceRoot":"","sources":["../../src/protocol/capabilities.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,KAAK,EAAE,kBAAkB,EAAE,kBAAkB,EAAE,MAAM,gCAAgC,CAAC;AAC7F,OAAO,KAAK,EAAE,KAAK,EAAE,QAAQ,EAAE,MAAM,WAAW,CAAC;AACjD,OAAO,EAKL,KAAK,qBAAqB,EAC1B,KAAK,gBAAgB,EACrB,KAAK,+BAA+B,EACpC,KAAK,0BAA0B,EAC/B,KAAK,+BAA+B,EACpC,KAAK,0BAA0B,EAChC,MAAM,YAAY,CAAC;AAGpB,YAAY,EAAE,kBAAkB,EAAE,kBAAkB,EAAE,CAAC;AAoCvD;;;GAGG;AAEH;;GAEG;AAEH;;;;;;;GAOG;AACH,wBAAgB,qBAAqB,CAAC,CAAC,SAAS,gBAAgB,CAAC,gBAAgB,CAAC,EAChF,MAAM,EAAE,CAAC,EACT,YAAY,EAAE,kBAAkB,GAC/B,YAAY,IAAI,kBAAkB,GACnC,QAAQ,CAAC,kBAAkB,EAAE,0BAA0B,CAAC,CAAC,CAAC,CAAC,CAO5D;AAED;;;;;;;GAOG;AACH,wBAAgB,0BAA0B,CACxC,CAAC,SAAS,qBAAqB,CAAC,gBAAgB,CAAC,EACjD,CAAC,SAAS,OAAO,CAAC,kBAAkB,CAAC,EAErC,MAAM,EAAE,CAAC,EACT,YAAY,EAAE,CAAC,GACd,YAAY,IAAI,CAAC,GAAG,QAAQ,CAAC,kBAAkB,EAAE,+BAA+B,CAAC,CAAC,CAAC,CAAC,CAOtF;AAED;;;;;;;GAOG;AACH,wBAAgB,qBAAqB,CACnC,CAAC,SAAS,gBAAgB,CAAC,gBAAgB,CAAC,EAC5C,CAAC,SAAS,OAAO,CAAC,kBAAkB,CAAC,EAErC,MAAM,EAAE,CAAC,EACT,YAAY,EAAE,CAAC,GACd,YAAY,IAAI,CAAC,GAAG,QAAQ,CAAC,kBAAkB,EAAE,0BAA0B,CAAC,CAAC,CAAC,CAAC,CAOjF;AAED;;;;;;;GAOG;AACH,wBAAgB,0BAA0B,CACxC,CAAC,SAAS,qBAAqB,CAAC,gBAAgB,CAAC,EACjD,CAAC,SAAS,OAAO,CAAC,kBAAkB,CAAC,EAErC,MAAM,EAAE,CAAC,EACT,YAAY,EAAE,CAAC,GACd,YAAY,IAAI,CAAC,GAAG,QAAQ,CAAC,kBAAkB,EAAE,+BAA+B,CAAC,CAAC,CAAC,CAAC,CAOtF;AAED;;;;;;;GAOG;AACH,wBAAgB,mBAAmB,CACjC,CAAC,SAAS,KAAK,CAAC,kBAAkB,CAAC,EACnC,CAAC,SAAS,OAAO,CAAC,kBAAkB,CAAC,EACrC,YAAY,EAAE,CAAC,EAAE,UAAU,EAAE,CAAC,GAAG,YAAY,IAAI,CAAC,GAAG,QAAQ,CAAC,kBAAkB,EAAE,CAAC,CAAC,CAGrF;AAED;;;;;;;GAOG;AACH,wBAAgB,mBAAmB,CACjC,CAAC,SAAS,KAAK,CAAC,kBAAkB,CAAC,EACnC,CAAC,SAAS,OAAO,CAAC,kBAAkB,CAAC,EACrC,YAAY,EAAE,CAAC,EAAE,UAAU,EAAE,CAAC,GAAG,YAAY,IAAI,CAAC,GAAG,QAAQ,CAAC,kBAAkB,EAAE,CAAC,CAAC,CAGrF;AAED;;;;;GAKG;AACH,wBAAgB,aAAa,CAC3B,YAAY,EAAE,kBAAkB,GAC/B,YAAY,IAAI,kBAAkB,GAAG;IACtC,aAAa,EAAE,WAAW,CAAC,kBAAkB,CAAC,eAAe,CAAC,CAAC,CAAC;CACjE,CAEA;AAED;;;;;GAKG;AACH,wBAAgB,kBAAkB,CAChC,YAAY,EAAE,kBAAkB,GAC/B,YAAY,IAAI,kBAAkB,GAAG;IACtC,kBAAkB,EAAE,WAAW,CAAC,kBAAkB,CAAC,oBAAoB,CAAC,CAAC,CAAC;CAC3E,CAEA;AAED;;;;;GAKG;AACH,wBAAgB,kBAAkB,CAChC,YAAY,EAAE,kBAAkB,GAC/B,YAAY,IAAI,kBAAkB,GAAG;IACtC,kBAAkB,EAAE,WAAW,CAAC,kBAAkB,CAAC,oBAAoB,CAAC,CAAC,CAAC;CAC3E,CAEA;AAED;;;;;GAKG;AACH,wBAAgB,kBAAkB,CAChC,YAAY,EAAE,kBAAkB,GAC/B,YAAY,IAAI,kBAAkB,GAAG;IACtC,kBAAkB,EAAE,WAAW,CAAC,kBAAkB,CAAC,oBAAoB,CAAC,CAAC,CAAC;CAC3E,CAEA;AAED;;;;;GAKG;AACH,wBAAgB,sBAAsB,CACpC,YAAY,EAAE,kBAAkB,GAC/B,YAAY,IAAI,kBAAkB,GAAG;IACtC,sBAAsB,EAAE,WAAW,CAAC,kBAAkB,CAAC,wBAAwB,CAAC,CAAC,CAAC;CACnF,CAEA;AAED;;;;;GAKG;AACH,wBAAgB,wBAAwB,CACtC,YAAY,EAAE,kBAAkB,GAC/B,YAAY,IAAI,kBAAkB,GAAG;IAAE,SAAS,EAAE;QAAE,gBAAgB,EAAE;YAAE,SAAS,EAAE,IAAI,CAAA;SAAE,CAAA;KAAE,CAAA;CAAE,CAE/F;AAED;;;;;GAKG;AACH,wBAAgB,4BAA4B,CAC1C,YAAY,EAAE,kBAAkB,GAC/B,YAAY,IAAI,kBAAkB,GAAG;IACtC,oBAAoB,EAAE,WAAW,CAAC,kBAAkB,CAAC,sBAAsB,CAAC,CAAC,CAAC;CAC/E,CAIA;AAED;;;;;GAKG;AACH,wBAAgB,oBAAoB,CAClC,YAAY,EAAE,kBAAkB,GAC/B,YAAY,IAAI,kBAAkB,GAAG;IACtC,SAAS,EAAE;QAAE,qBAAqB,EAAE;YAAE,mBAAmB,EAAE,IAAI,CAAA;SAAE,CAAA;KAAE,CAAC;CACrE,CAEA;AAED;;;;;GAKG;AACH,wBAAgB,wBAAwB,CACtC,YAAY,EAAE,kBAAkB,GAC/B,YAAY,IAAI,kBAAkB,GAAG;IAAE,MAAM,EAAE;QAAE,gBAAgB,EAAE,IAAI,CAAA;KAAE,CAAA;CAAE,CAE7E"}