@slbdn/mcp-tester 1.0.2 → 1.2.0

package/dist/matchers.d.ts

@@ -0,0 +1,262 @@
+import { Tool, Resource, Prompt, CallToolResult, ReadResourceResult, GetPromptResult } from '@modelcontextprotocol/sdk/types.js';
+declare global {
+    namespace jest {
+        interface Matchers<R> {
+            toHaveTool(toolName: string): R;
+            toHaveResource(uri: string): R;
+            toHavePrompt(promptName: string): R;
+            toHaveToolWithSchema(toolName: string): R;
+            toHaveToolCount(count: number): R;
+            toHaveResourceCount(count: number): R;
+            toHavePromptCount(count: number): R;
+            toHaveResourceByName(name: string): R;
+            toHavePromptWithArgs(promptName: string): R;
+            toReturnText(expected?: string): R;
+            toReturnTextContaining(substring: string): R;
+            toReturnError(): R;
+            toReturnOk(): R;
+            toReturnJson(expected: unknown): R;
+            toReturnContentCount(count: number): R;
+            toReturnImage(): R;
+            toReturnResourceText(expected?: string): R;
+            toReturnResourceTextContaining(substring: string): R;
+            toReturnPromptTextContaining(substring: string): R;
+            toReturnPromptMessageCount(count: number): R;
+        }
+    }
+}
+/**
+ * Check if a tool with the given name exists in the tools array.
+ * Works with `.not` for negation.
+ *
+ *   expect(tools).toHaveTool('echo');
+ *   expect(tools).not.toHaveTool('deprecated_tool');
+ */
+export declare const toHaveTool: (received: Tool[], toolName: string) => {
+    pass: boolean;
+    message: () => string;
+};
+/**
+ * Check if a resource with the given URI exists.
+ *
+ *   expect(resources).toHaveResource('config://settings');
+ */
+export declare const toHaveResource: (received: Resource[], uri: string) => {
+    pass: boolean;
+    message: () => string;
+};
+/**
+ * Check if a prompt with the given name exists.
+ *
+ *   expect(prompts).toHavePrompt('greet');
+ */
+export declare const toHavePrompt: (received: Prompt[], promptName: string) => {
+    pass: boolean;
+    message: () => string;
+};
+/**
+ * Check if a tool exists and has an input schema.
+ *
+ *   expect(tools).toHaveToolWithSchema('echo');
+ */
+export declare const toHaveToolWithSchema: (received: Tool[], toolName: string) => {
+    pass: boolean;
+    message: () => string;
+};
+/**
+ * Check that the tools array has exactly `count` items.
+ *
+ *   expect(tools).toHaveToolCount(5);
+ */
+export declare const toHaveToolCount: (received: Tool[], count: number) => {
+    pass: boolean;
+    message: () => string;
+};
+/**
+ * Check that the resources array has exactly `count` items.
+ *
+ *   expect(resources).toHaveResourceCount(3);
+ */
+export declare const toHaveResourceCount: (received: Resource[], count: number) => {
+    pass: boolean;
+    message: () => string;
+};
+/**
+ * Check that the prompts array has exactly `count` items.
+ *
+ *   expect(prompts).toHavePromptCount(2);
+ */
+export declare const toHavePromptCount: (received: Prompt[], count: number) => {
+    pass: boolean;
+    message: () => string;
+};
+/**
+ * Check if a resource with the given display name exists.
+ *
+ *   expect(resources).toHaveResourceByName('Settings');
+ */
+export declare const toHaveResourceByName: (received: Resource[], name: string) => {
+    pass: boolean;
+    message: () => string;
+};
+/**
+ * Check if a prompt exists and has defined arguments (is parameterized).
+ *
+ *   expect(prompts).toHavePromptWithArgs('greet');
+ */
+export declare const toHavePromptWithArgs: (received: Prompt[], promptName: string) => {
+    pass: boolean;
+    message: () => string;
+};
+/**
+ * Check that a tool result has text content.
+ * Optionally check that the text equals an exact string.
+ *
+ *   expect(result).toReturnText();               // has any text
+ *   expect(result).toReturnText('Hello World');    // text equals exactly
+ */
+export declare const toReturnText: (received: CallToolResult, expected?: string) => {
+    pass: boolean;
+    message: () => string;
+};
+/**
+ * Check that a tool result's text contains a substring.
+ *
+ *   expect(result).toReturnTextContaining('hello');
+ */
+export declare const toReturnTextContaining: (received: CallToolResult, substring: string) => {
+    pass: boolean;
+    message: () => string;
+};
+/**
+ * Check that a tool result indicates an error (isError flag or "error" in text).
+ *
+ *   expect(result).toReturnError();
+ */
+export declare const toReturnError: (received: CallToolResult) => {
+    pass: boolean;
+    message: () => "Expected tool result to NOT be an error" | "Expected tool result to be an error, but it succeeded";
+};
+/**
+ * Check that a tool result indicates success (no error).
+ *
+ *   expect(result).toReturnOk();
+ */
+export declare const toReturnOk: (received: CallToolResult) => {
+    pass: boolean;
+    message: () => string;
+};
+/**
+ * Parse tool result text as JSON and deep-compare to expected object.
+ *
+ *   expect(result).toReturnJson({ status: 'ok', count: 5 });
+ */
+export declare const toReturnJson: (received: CallToolResult, expected: unknown) => {
+    pass: boolean;
+    message: () => string;
+};
+/**
+ * Check that a tool result has exactly `count` content items.
+ *
+ *   expect(result).toReturnContentCount(2);  // e.g. text + image
+ */
+export declare const toReturnContentCount: (received: CallToolResult, count: number) => {
+    pass: boolean;
+    message: () => string;
+};
+/**
+ * Check that a tool result contains at least one image content item.
+ *
+ *   expect(result).toReturnImage();
+ */
+export declare const toReturnImage: (received: CallToolResult) => {
+    pass: boolean;
+    message: () => string;
+};
+/**
+ * Check that a resource result has text content.
+ * Optionally check that the text equals an exact string.
+ *
+ *   expect(result).toReturnResourceText();              // has any text
+ *   expect(result).toReturnResourceText('expected');    // text equals exactly
+ */
+export declare const toReturnResourceText: (received: ReadResourceResult, expected?: string) => {
+    pass: boolean;
+    message: () => string;
+};
+/**
+ * Check that a resource result's text contains a substring.
+ *
+ *   expect(result).toReturnResourceTextContaining('connection');
+ */
+export declare const toReturnResourceTextContaining: (received: ReadResourceResult, substring: string) => {
+    pass: boolean;
+    message: () => string;
+};
+/**
+ * Check that a prompt result's first message text contains a substring.
+ *
+ *   expect(result).toReturnPromptTextContaining('Alice');
+ */
+export declare const toReturnPromptTextContaining: (received: GetPromptResult, substring: string) => {
+    pass: boolean;
+    message: () => string;
+};
+/**
+ * Check that a prompt result has exactly `count` messages.
+ *
+ *   expect(result).toReturnPromptMessageCount(2);
+ */
+export declare const toReturnPromptMessageCount: (received: GetPromptResult, count: number) => {
+    pass: boolean;
+    message: () => string;
+};
+/**
+ * Register all custom matchers with Jest.
+ * Call once in test setup:
+ *
+ *   import { setupJestMatchers } from '@slbdn/mcp-tester';
+ *   beforeAll(() => setupJestMatchers());
+ *
+ * Or add to jest.setup.js for global availability.
+ *
+ * Also works as `setupCustomMatchers()` (alias kept for backward compat).
+ */
+export declare const setupJestMatchers: () => void;
+/** @deprecated Use setupJestMatchers() instead */
+export declare const setupCustomMatchers: () => void;
+/**
+ * Register all custom matchers with Vitest.
+ * Call once in test setup:
+ *
+ *   import { setupVitestMatchers } from '@slbdn/mcp-tester';
+ *   import { beforeAll } from 'vitest';
+ *   beforeAll(() => setupVitestMatchers());
+ */
+export declare const setupVitestMatchers: () => void;
+/**
+ * Assert that a tool result has text content (optionally matching exactly).
+ * Works with any test runner — throws AssertionError on failure.
+ */
+export declare function assertToolText(result: CallToolResult, expected?: string, msg?: string): void;
+/**
+ * Assert that a tool result text contains a substring.
+ * Works with any test runner — throws AssertionError on failure.
+ */
+export declare function assertToolTextContains(result: CallToolResult, substring: string, msg?: string): void;
+/**
+ * Assert that tools list contains a tool with the given name.
+ * Works with any test runner — throws AssertionError on failure.
+ */
+export declare function assertHasTool(tools: Tool[], name: string, msg?: string): void;
+/**
+ * Assert that resources list contains a resource with the given URI.
+ * Works with any test runner — throws AssertionError on failure.
+ */
+export declare function assertHasResource(resources: Resource[], uri: string, msg?: string): void;
+/**
+ * Assert that prompts list contains a prompt with the given name.
+ * Works with any test runner — throws AssertionError on failure.
+ */
+export declare function assertHasPrompt(prompts: Prompt[], name: string, msg?: string): void;
+//# sourceMappingURL=matchers.d.ts.map

package/dist/matchers.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"matchers.d.ts","sourceRoot":"","sources":["../src/matchers.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,IAAI,EACJ,QAAQ,EACR,MAAM,EACN,cAAc,EACd,kBAAkB,EAClB,eAAe,EAChB,MAAM,oCAAoC,CAAC;AAK5C,OAAO,CAAC,MAAM,CAAC;IAEb,UAAU,IAAI,CAAC;QACb,UAAU,QAAQ,CAAC,CAAC;YAElB,UAAU,CAAC,QAAQ,EAAE,MAAM,GAAG,CAAC,CAAC;YAChC,cAAc,CAAC,GAAG,EAAE,MAAM,GAAG,CAAC,CAAC;YAC/B,YAAY,CAAC,UAAU,EAAE,MAAM,GAAG,CAAC,CAAC;YACpC,oBAAoB,CAAC,QAAQ,EAAE,MAAM,GAAG,CAAC,CAAC;YAC1C,eAAe,CAAC,KAAK,EAAE,MAAM,GAAG,CAAC,CAAC;YAClC,mBAAmB,CAAC,KAAK,EAAE,MAAM,GAAG,CAAC,CAAC;YACtC,iBAAiB,CAAC,KAAK,EAAE,MAAM,GAAG,CAAC,CAAC;YACpC,oBAAoB,CAAC,IAAI,EAAE,MAAM,GAAG,CAAC,CAAC;YACtC,oBAAoB,CAAC,UAAU,EAAE,MAAM,GAAG,CAAC,CAAC;YAG5C,YAAY,CAAC,QAAQ,CAAC,EAAE,MAAM,GAAG,CAAC,CAAC;YACnC,sBAAsB,CAAC,SAAS,EAAE,MAAM,GAAG,CAAC,CAAC;YAC7C,aAAa,IAAI,CAAC,CAAC;YACnB,UAAU,IAAI,CAAC,CAAC;YAChB,YAAY,CAAC,QAAQ,EAAE,OAAO,GAAG,CAAC,CAAC;YACnC,oBAAoB,CAAC,KAAK,EAAE,MAAM,GAAG,CAAC,CAAC;YACvC,aAAa,IAAI,CAAC,CAAC;YAGnB,oBAAoB,CAAC,QAAQ,CAAC,EAAE,MAAM,GAAG,CAAC,CAAC;YAC3C,8BAA8B,CAAC,SAAS,EAAE,MAAM,GAAG,CAAC,CAAC;YAGrD,4BAA4B,CAAC,SAAS,EAAE,MAAM,GAAG,CAAC,CAAC;YACnD,0BAA0B,CAAC,KAAK,EAAE,MAAM,GAAG,CAAC,CAAC;SAC9C;KACF;CACF;AAeD;;;;;;GAMG;AACH,eAAO,MAAM,UAAU,GAAI,UAAU,IAAI,EAAE,EAAE,UAAU,MAAM;;;CAS5D,CAAC;AAEF;;;;GAIG;AACH,eAAO,MAAM,cAAc,GAAI,UAAU,QAAQ,EAAE,EAAE,KAAK,MAAM;;;CAS/D,CAAC;AAEF;;;;GAIG;AACH,eAAO,MAAM,YAAY,GAAI,UAAU,MAAM,EAAE,EAAE,YAAY,MAAM;;;CASlE,CAAC;AAEF;;;;GAIG;AACH,eAAO,MAAM,oBAAoB,GAAI,UAAU,IAAI,EAAE,EAAE,UAAU,MAAM;;;CAiBtE,CAAC;AAEF;;;;GAIG;AACH,eAAO,MAAM,eAAe,GAAI,UAAU,IAAI,EAAE,EAAE,OAAO,MAAM;;;CAS9D,CAAC;AAEF;;;;GAIG;AACH,eAAO,MAAM,mBAAmB,GAAI,UAAU,QAAQ,EAAE,EAAE,OAAO,MAAM;;;CAStE,CAAC;AAEF;;;;GAIG;AACH,eAAO,MAAM,iBAAiB,GAAI,UAAU,MAAM,EAAE,EAAE,OAAO,MAAM;;;CASlE,CAAC;AAEF;;;;GAIG;AACH,eAAO,MAAM,oBAAoB,GAAI,UAAU,QAAQ,EAAE,EAAE,MAAM,MAAM;;;CAStE,CAAC;AAEF;;;;GAIG;AACH,eAAO,MAAM,oBAAoB,GAAI,UAAU,MAAM,EAAE,EAAE,YAAY,MAAM;;;CAiB1E,CAAC;AAIF;;;;;;GAMG;AACH,eAAO,MAAM,YAAY,GAAI,UAAU,cAAc,EAAE,WAAW,MAAM;;;CA0BvE,CAAC;AAEF;;;;GAIG;AACH,eAAO,MAAM,sBAAsB,GAAI,UAAU,cAAc,EAAE,WAAW,MAAM;;;CAiBjF,CAAC;AAEF;;;;GAIG;AACH,eAAO,MAAM,aAAa,GAAI,UAAU,cAAc;;;CAWrD,CAAC;AAEF;;;;GAIG;AACH,eAAO,MAAM,UAAU,GAAI,UAAU,cAAc;;;CAWlD,CAAC;AAEF;;;;GAIG;AACH,eAAO,MAAM,YAAY,GAAI,UAAU,cAAc,EAAE,UAAU,OAAO;;;CA4BvE,CAAC;AAEF;;;;GAIG;AACH,eAAO,MAAM,oBAAoB,GAAI,UAAU,cAAc,EAAE,OAAO,MAAM;;;CAS3E,CAAC;AAEF;;;;GAIG;AACH,eAAO,MAAM,aAAa,GAAI,UAAU,cAAc;;;CAUrD,CAAC;AAIF;;;;;;GAMG;AACH,eAAO,MAAM,oBAAoB,GAAI,UAAU,kBAAkB,EAAE,WAAW,MAAM;;;CA2BnF,CAAC;AAEF;;;;GAIG;AACH,eAAO,MAAM,8BAA8B,GAAI,UAAU,kBAAkB,EAAE,WAAW,MAAM;;;CAmB7F,CAAC;AAIF;;;;GAIG;AACH,eAAO,MAAM,4BAA4B,GAAI,UAAU,eAAe,EAAE,WAAW,MAAM;;;CAmBxF,CAAC;AAEF;;;;GAIG;AACH,eAAO,MAAM,0BAA0B,GAAI,UAAU,eAAe,EAAE,OAAO,MAAM;;;CASlF,CAAC;AAIF;;;;;;;;;;GAUG;AACH,eAAO,MAAM,iBAAiB,YA2B7B,CAAC;AAEF,kDAAkD;AAClD,eAAO,MAAM,mBAAmB,YAAoB,CAAC;AAErD;;;;;;;GAOG;AACH,eAAO,MAAM,mBAAmB,YAoC/B,CAAC;AAUF;;;GAGG;AACH,wBAAgB,cAAc,CAAC,MAAM,EAAE,cAAc,EAAE,QAAQ,CAAC,EAAE,MAAM,EAAE,GAAG,CAAC,EAAE,MAAM,GAAG,IAAI,CAO5F;AAED;;;GAGG;AACH,wBAAgB,sBAAsB,CACpC,MAAM,EAAE,cAAc,EACtB,SAAS,EAAE,MAAM,EACjB,GAAG,CAAC,EAAE,MAAM,GACX,IAAI,CAON;AAED;;;GAGG;AACH,wBAAgB,aAAa,CAAC,KAAK,EAAE,IAAI,EAAE,EAAE,IAAI,EAAE,MAAM,EAAE,GAAG,CAAC,EAAE,MAAM,GAAG,IAAI,CAM7E;AAED;;;GAGG;AACH,wBAAgB,iBAAiB,CAAC,SAAS,EAAE,QAAQ,EAAE,EAAE,GAAG,EAAE,MAAM,EAAE,GAAG,CAAC,EAAE,MAAM,GAAG,IAAI,CAOxF;AAED;;;GAGG;AACH,wBAAgB,eAAe,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE,IAAI,EAAE,MAAM,EAAE,GAAG,CAAC,EAAE,MAAM,GAAG,IAAI,CAMnF"}