@reftrixmcp/mcp-server 0.1.7 → 0.2.0

package/dist/utils/error-messages.d.ts

@@ -1,233 +0,0 @@
-/**
- * MCPツール用エラーメッセージユーティリティ
- * Zodエラーを人間が読みやすいメッセージに変換する
- *
- * 機能:
- * - Zodエラーの構造化変換
- * - 日本語/英語の多言語対応（環境変数で切り替え可能）
- * - 一貫したエラーコード体系
- * - フィールドパス情報の保持
- *
- * @module @reftrixmcp/mcp-server/utils/error-messages
- */
-import { ZodError } from "zod";
-/**
- * MCPツールエラーのインターフェース
- * 統一されたエラーレスポンス構造
- */
-export interface McpToolError {
-    /** エラーコード（一意の識別子） */
-    code: string;
-    /** 人間が読めるエラーメッセージ */
-    message: string;
-    /** エラーのあるフィールド（オプション） */
-    field?: string;
-    /** 追加情報（オプション） */
-    details?: Record<string, unknown>;
-}
-/**
- * サポートされるロケール
- */
-export type ErrorLocale = "en" | "ja";
-/**
- * エラーコード定義
- */
-export declare const ERROR_CODES: {
-    readonly INVALID_UUID: "INVALID_UUID";
-    readonly REQUIRED_FIELD: "REQUIRED_FIELD";
-    readonly OUT_OF_RANGE: "OUT_OF_RANGE";
-    readonly INVALID_ENUM: "INVALID_ENUM";
-    readonly STRING_TOO_SHORT: "STRING_TOO_SHORT";
-    readonly STRING_TOO_LONG: "STRING_TOO_LONG";
-    readonly INVALID_TYPE: "INVALID_TYPE";
-    readonly INVALID_FORMAT: "INVALID_FORMAT";
-    readonly ARRAY_TOO_LONG: "ARRAY_TOO_LONG";
-    readonly ARRAY_TOO_SHORT: "ARRAY_TOO_SHORT";
-    readonly CUSTOM_ERROR: "CUSTOM_ERROR";
-    readonly UNKNOWN_ERROR: "UNKNOWN_ERROR";
-    readonly SERVICE_UNAVAILABLE: "SERVICE_UNAVAILABLE";
-};
-export type ErrorCodeType = (typeof ERROR_CODES)[keyof typeof ERROR_CODES];
-/**
- * エラーメッセージ定数（外部エクスポート用）
- */
-export declare const ErrorMessages: {
-    readonly en: {
-        readonly INVALID_UUID: (_field: string) => string;
-        readonly REQUIRED_FIELD: (field: string) => string;
-        readonly OUT_OF_RANGE: (value: number, min?: number, max?: number) => string;
-        readonly INVALID_ENUM: (value: string, options: string[]) => string;
-        readonly STRING_TOO_SHORT: (field: string, min: number) => string;
-        readonly STRING_TOO_LONG: (field: string, max: number) => string;
-        readonly INVALID_TYPE: (expected: string, received: string) => string;
-        readonly INVALID_FORMAT: (field: string, format: string) => string;
-        readonly ARRAY_TOO_LONG: (field: string, max: number) => string;
-        readonly ARRAY_TOO_SHORT: (field: string, min: number) => string;
-        readonly CUSTOM_ERROR: (message: string) => string;
-        readonly UNKNOWN_ERROR: (message: string) => string;
-    };
-    readonly ja: {
-        readonly INVALID_UUID: (_field: string) => string;
-        readonly REQUIRED_FIELD: (field: string) => string;
-        readonly OUT_OF_RANGE: (value: number, min?: number, max?: number) => string;
-        readonly INVALID_ENUM: (value: string, options: string[]) => string;
-        readonly STRING_TOO_SHORT: (field: string, min: number) => string;
-        readonly STRING_TOO_LONG: (field: string, max: number) => string;
-        readonly INVALID_TYPE: (expected: string, received: string) => string;
-        readonly INVALID_FORMAT: (field: string, format: string) => string;
-        readonly ARRAY_TOO_LONG: (field: string, max: number) => string;
-        readonly ARRAY_TOO_SHORT: (field: string, min: number) => string;
-        readonly CUSTOM_ERROR: (message: string) => string;
-        readonly UNKNOWN_ERROR: (message: string) => string;
-    };
-};
-/**
- * 現在のロケールを取得
- */
-export declare function getErrorMessageLocale(): ErrorLocale;
-/**
- * ロケールを設定
- * @param locale - 設定するロケール ('en' | 'ja')
- */
-export declare function setErrorMessageLocale(locale: ErrorLocale): void;
-/**
- * ZodErrorを人間が読みやすいMcpToolError配列に変換
- *
- * @param zodError - 変換するZodError
- * @returns McpToolErrorの配列
- * @throws Error - zodErrorがZodErrorインスタンスでない場合
- *
- * @example
- * ```typescript
- * const schema = z.object({ query: z.string().min(1) });
- * const result = schema.safeParse({});
- * if (!result.success) {
- *   const errors = formatZodError(result.error);
- *   // [{ code: 'REQUIRED_FIELD', message: "Required field 'query' is missing", field: 'query' }]
- * }
- * ```
- */
-export declare function formatZodError(zodError: ZodError): McpToolError[];
-/**
- * ZodErrorからMcpToolError配列を生成するエイリアス
- * formatZodErrorと同じ機能
- *
- * @param zodError - 変換するZodError
- * @returns McpToolErrorの配列
- */
-export declare function createValidationError(zodError: ZodError): McpToolError[];
-/**
- * 単一のMcpToolErrorを文字列形式にフォーマット
- *
- * @param error - フォーマットするエラー
- * @returns フォーマットされたエラー文字列
- */
-export declare function formatSingleError(error: McpToolError): string;
-/**
- * McpToolError配列を単一のエラーメッセージ文字列に結合
- *
- * @param errors - エラーの配列
- * @param separator - 区切り文字（デフォルト: ', '）
- * @returns 結合されたエラーメッセージ
- */
-export declare function formatMultipleErrors(errors: McpToolError[], separator?: string): string;
-/**
- * 詳細なバリデーションエラー情報
- * 具体的な値、期待値、ヒントを含む
- */
-export interface DetailedValidationError {
-    /** フィールドパス (e.g., 'items.0.html') */
-    field: string;
-    /** エラーコード */
-    code: string;
-    /** 人間が読めるエラーメッセージ */
-    message: string;
-    /** 期待される値/型の説明 */
-    expected?: string;
-    /** 実際に受信した値 */
-    received?: string;
-    /** 修正方法のヒント */
-    hint?: string;
-}
-/**
- * ツール固有のヒントを含むエラー結果
- */
-export interface ValidationErrorWithHints {
-    /** ツール名 */
-    toolName: string;
-    /** 詳細なエラー配列 */
-    errors: DetailedValidationError[];
-}
-/**
- * ZodErrorを詳細なバリデーションエラー形式に変換
- *
- * @param zodError - 変換するZodError
- * @returns 詳細なエラー情報を含むオブジェクト
- *
- * @example
- * ```typescript
- * const schema = z.object({ html: z.string().min(1) });
- * const result = schema.safeParse({});
- * if (!result.success) {
- *   const detailed = formatDetailedValidationError(result.error);
- *   // { errors: [{ field: 'html', code: 'REQUIRED_FIELD', ... }] }
- * }
- * ```
- */
-export declare function formatDetailedValidationError(zodError: ZodError): {
-    errors: DetailedValidationError[];
-};
-/**
- * ツール固有のヒントを追加してエラー情報を生成
- *
- * @param zodError - 変換するZodError
- * @param toolName - MCPツール名
- * @returns ツール固有のヒントを含むエラー情報
- *
- * @example
- * ```typescript
- * const schema = z.object({ html: z.string().min(1) });
- * const result = schema.safeParse({});
- * if (!result.success) {
- *   const errorWithHints = createValidationErrorWithHints(result.error, 'layout.ingest');
- * }
- * ```
- */
-export declare function createValidationErrorWithHints(zodError: ZodError, toolName: string): ValidationErrorWithHints;
-/**
- * 詳細エラーを構造化された文字列フォーマットに変換
- *
- * @param error - 詳細なエラー情報
- * @returns フォーマットされた文字列
- *
- * @example
- * Output format:
- * ```
- * Validation Error: html is required
- *   Field: html
- *   Expected: non-empty string
- *   Received: undefined
- *   Hint: Provide html as a string, e.g., '<html>...</html>'
- * ```
- */
-export declare function formatDetailedError(error: DetailedValidationError): string;
-/**
- * 複数の詳細エラーをフォーマット
- */
-export declare function formatMultipleDetailedErrors(errors: DetailedValidationError[], separator?: string): string;
-/**
- * ツール固有のi18nエラーメッセージを取得
- *
- * @param toolName - MCPツール名 (e.g., 'layout.inspect')
- * @param code - エラーコード (e.g., 'SERVICE_UNAVAILABLE')
- * @returns ローカライズされたエラーメッセージ、見つからない場合はundefined
- *
- * @example
- * ```typescript
- * const message = getToolErrorMessage('layout.inspect', 'SERVICE_UNAVAILABLE');
- * // en: 'WebPage service is not available...'
- * // ja: 'WebPageサービスが利用できません...'
- * ```
- */
-export declare function getToolErrorMessage(toolName: string, code: string): string | undefined;
-//# sourceMappingURL=error-messages.d.ts.map

package/dist/utils/error-messages.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"error-messages.d.ts","sourceRoot":"","sources":["../../src/utils/error-messages.ts"],"names":[],"mappings":"AAGA;;;;;;;;;;;GAWG;AAEH,OAAO,EAAE,QAAQ,EAA+B,MAAM,KAAK,CAAC;AAM5D;;;GAGG;AACH,MAAM,WAAW,YAAY;IAC3B,qBAAqB;IACrB,IAAI,EAAE,MAAM,CAAC;IACb,qBAAqB;IACrB,OAAO,EAAE,MAAM,CAAC;IAChB,yBAAyB;IACzB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,kBAAkB;IAClB,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CACnC;AAED;;GAEG;AACH,MAAM,MAAM,WAAW,GAAG,IAAI,GAAG,IAAI,CAAC;AAEtC;;GAEG;AACH,eAAO,MAAM,WAAW;;;;;;;;;;;;;;CAcd,CAAC;AAEX,MAAM,MAAM,aAAa,GAAG,CAAC,OAAO,WAAW,CAAC,CAAC,MAAM,OAAO,WAAW,CAAC,CAAC;AAgF3E;;GAEG;AACH,eAAO,MAAM,aAAa;;wCAzED,MAAM,KAAG,MAAM;yCAEd,MAAM,KAAG,MAAM;uCACjB,MAAM,QAAQ,MAAM,QAAQ,MAAM,KAAG,MAAM;uCAY3C,MAAM,WAAW,MAAM,EAAE,KAAG,MAAM;2CAE9B,MAAM,OAAO,MAAM,KAAG,MAAM;0CAE7B,MAAM,OAAO,MAAM,KAAG,MAAM;0CAE5B,MAAM,YAAY,MAAM,KAAG,MAAM;yCAElC,MAAM,UAAU,MAAM,KAAG,MAAM;yCAE/B,MAAM,OAAO,MAAM,KAAG,MAAM;0CAE3B,MAAM,OAAO,MAAM,KAAG,MAAM;yCAE7B,MAAM,KAAG,MAAM;0CACd,MAAM,KAAG,MAAM;;;wCAOjB,MAAM,KAAG,MAAM;yCAEd,MAAM,KAAG,MAAM;uCACjB,MAAM,QAAQ,MAAM,QAAQ,MAAM,KAAG,MAAM;uCAY3C,MAAM,WAAW,MAAM,EAAE,KAAG,MAAM;2CAE9B,MAAM,OAAO,MAAM,KAAG,MAAM;0CAE7B,MAAM,OAAO,MAAM,KAAG,MAAM;0CAE5B,MAAM,YAAY,MAAM,KAAG,MAAM;yCAElC,MAAM,UAAU,MAAM,KAAG,MAAM;yCAE/B,MAAM,OAAO,MAAM,KAAG,MAAM;0CAE3B,MAAM,OAAO,MAAM,KAAG,MAAM;yCAE7B,MAAM,KAAG,MAAM;0CACd,MAAM,KAAG,MAAM;;CAmChC,CAAC;AAWX;;GAEG;AACH,wBAAgB,qBAAqB,IAAI,WAAW,CAEnD;AAED;;;GAGG;AACH,wBAAgB,qBAAqB,CAAC,MAAM,EAAE,WAAW,GAAG,IAAI,CAE/D;AAoMD;;;;;;;;;;;;;;;;GAgBG;AACH,wBAAgB,cAAc,CAAC,QAAQ,EAAE,QAAQ,GAAG,YAAY,EAAE,CA0CjE;AAED;;;;;;GAMG;AACH,wBAAgB,qBAAqB,CAAC,QAAQ,EAAE,QAAQ,GAAG,YAAY,EAAE,CAExE;AAMD;;;;;GAKG;AACH,wBAAgB,iBAAiB,CAAC,KAAK,EAAE,YAAY,GAAG,MAAM,CAG7D;AAED;;;;;;GAMG;AACH,wBAAgB,oBAAoB,CAAC,MAAM,EAAE,YAAY,EAAE,EAAE,SAAS,GAAE,MAAa,GAAG,MAAM,CAE7F;AAMD;;;GAGG;AACH,MAAM,WAAW,uBAAuB;IACtC,qCAAqC;IACrC,KAAK,EAAE,MAAM,CAAC;IACd,aAAa;IACb,IAAI,EAAE,MAAM,CAAC;IACb,qBAAqB;IACrB,OAAO,EAAE,MAAM,CAAC;IAChB,kBAAkB;IAClB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,eAAe;IACf,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,eAAe;IACf,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED;;GAEG;AACH,MAAM,WAAW,wBAAwB;IACvC,WAAW;IACX,QAAQ,EAAE,MAAM,CAAC;IACjB,eAAe;IACf,MAAM,EAAE,uBAAuB,EAAE,CAAC;CACnC;AA0QD;;;;;;;;;;;;;;;GAeG;AACH,wBAAgB,6BAA6B,CAAC,QAAQ,EAAE,QAAQ,GAAG;IACjE,MAAM,EAAE,uBAAuB,EAAE,CAAC;CACnC,CAOA;AAED;;;;;;;;;;;;;;;GAeG;AACH,wBAAgB,8BAA8B,CAC5C,QAAQ,EAAE,QAAQ,EAClB,QAAQ,EAAE,MAAM,GACf,wBAAwB,CAyB1B;AAED;;;;;;;;;;;;;;;GAeG;AACH,wBAAgB,mBAAmB,CAAC,KAAK,EAAE,uBAAuB,GAAG,MAAM,CAgC1E;AAED;;GAEG;AACH,wBAAgB,4BAA4B,CAC1C,MAAM,EAAE,uBAAuB,EAAE,EACjC,SAAS,GAAE,MAAe,GACzB,MAAM,CAER;AA0BD;;;;;;;;;;;;;GAaG;AACH,wBAAgB,mBAAmB,CAAC,QAAQ,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS,CAKtF"}