mcp-docs-service 0.2.0 → 0.2.1

package/dist/schemas/tools.js

@@ -0,0 +1,46 @@
+import { z } from "zod";
+// Base schema for tool inputs
+export const ToolInputSchema = z.object({
+    path: z.string().optional(),
+});
+// Documentation schemas
+export const ReadDocumentSchema = ToolInputSchema.extend({
+    path: z.string(),
+});
+export const ListDocumentsSchema = ToolInputSchema.extend({
+    basePath: z.string().optional(),
+});
+export const GetStructureSchema = ToolInputSchema.extend({
+    basePath: z.string().optional(),
+});
+export const GetNavigationSchema = ToolInputSchema.extend({
+    basePath: z.string().optional(),
+});
+export const GetDocsKnowledgeBaseSchema = ToolInputSchema.extend({
+    basePath: z.string().optional(),
+    includeSummaries: z.boolean().optional(),
+    maxSummaryLength: z.number().optional(),
+});
+export const WriteDocumentSchema = ToolInputSchema.extend({
+    path: z.string(),
+    content: z.string(),
+    metadata: z.record(z.any()).optional(),
+});
+export const EditDocumentSchema = ToolInputSchema.extend({
+    path: z.string(),
+    edits: z.array(z.object({
+        oldText: z.string(),
+        newText: z.string(),
+    })),
+});
+export const DeleteDocumentSchema = ToolInputSchema.extend({
+    path: z.string(),
+});
+export const SearchDocumentsSchema = ToolInputSchema.extend({
+    basePath: z.string().optional(),
+    query: z.string().optional(),
+    excludePatterns: z.array(z.string()).optional(),
+    tags: z.array(z.string()).optional(),
+    status: z.string().optional(),
+});
+//# sourceMappingURL=tools.js.map

package/dist/schemas/tools.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"tools.js","sourceRoot":"","sources":["../../src/schemas/tools.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB,8BAA8B;AAC9B,MAAM,CAAC,MAAM,eAAe,GAAG,CAAC,CAAC,MAAM,CAAC;IACtC,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;CAC5B,CAAC,CAAC;AAEH,wBAAwB;AACxB,MAAM,CAAC,MAAM,kBAAkB,GAAG,eAAe,CAAC,MAAM,CAAC;IACvD,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE;CACjB,CAAC,CAAC;AAEH,MAAM,CAAC,MAAM,mBAAmB,GAAG,eAAe,CAAC,MAAM,CAAC;IACxD,QAAQ,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;CAChC,CAAC,CAAC;AAEH,MAAM,CAAC,MAAM,kBAAkB,GAAG,eAAe,CAAC,MAAM,CAAC;IACvD,QAAQ,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;CAChC,CAAC,CAAC;AAEH,MAAM,CAAC,MAAM,mBAAmB,GAAG,eAAe,CAAC,MAAM,CAAC;IACxD,QAAQ,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;CAChC,CAAC,CAAC;AAEH,MAAM,CAAC,MAAM,0BAA0B,GAAG,eAAe,CAAC,MAAM,CAAC;IAC/D,QAAQ,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC/B,gBAAgB,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE;IACxC,gBAAgB,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;CACxC,CAAC,CAAC;AAEH,MAAM,CAAC,MAAM,mBAAmB,GAAG,eAAe,CAAC,MAAM,CAAC;IACxD,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE;IAChB,OAAO,EAAE,CAAC,CAAC,MAAM,EAAE;IACnB,QAAQ,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,GAAG,EAAE,CAAC,CAAC,QAAQ,EAAE;CACvC,CAAC,CAAC;AAEH,MAAM,CAAC,MAAM,kBAAkB,GAAG,eAAe,CAAC,MAAM,CAAC;IACvD,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE;IAChB,KAAK,EAAE,CAAC,CAAC,KAAK,CACZ,CAAC,CAAC,MAAM,CAAC;QACP,OAAO,EAAE,CAAC,CAAC,MAAM,EAAE;QACnB,OAAO,EAAE,CAAC,CAAC,MAAM,EAAE;KACpB,CAAC,CACH;CACF,CAAC,CAAC;AAEH,MAAM,CAAC,MAAM,oBAAoB,GAAG,eAAe,CAAC,MAAM,CAAC;IACzD,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE;CACjB,CAAC,CAAC;AAEH,MAAM,CAAC,MAAM,qBAAqB,GAAG,eAAe,CAAC,MAAM,CAAC;IAC1D,QAAQ,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC/B,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC5B,eAAe,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC,QAAQ,EAAE;IAC/C,IAAI,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC,QAAQ,EAAE;IACpC,MAAM,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;CAC9B,CAAC,CAAC"}

package/dist/types/docs.d.ts

@@ -0,0 +1,49 @@
+/**
+ * Metadata for documentation files
+ */
+export interface DocumentMetadata {
+    title?: string;
+    order?: number;
+    description?: string;
+    author?: string;
+    date?: Date;
+    tags?: string[];
+    status?: string;
+    [key: string]: any;
+}
+/**
+ * Entry for a documentation file
+ */
+export interface DocumentEntry {
+    path: string;
+    name: string;
+    metadata: DocumentMetadata;
+}
+/**
+ * Tree entry for documentation structure
+ */
+export interface TreeEntry {
+    name: string;
+    path: string;
+    type: string;
+    metadata?: DocumentMetadata;
+    children: TreeEntry[];
+    error?: string;
+}
+/**
+ * Navigation item for documentation
+ */
+export interface NavigationItem {
+    title: string;
+    path: string | null;
+    order: number;
+}
+/**
+ * Navigation section for documentation
+ */
+export interface NavigationSection {
+    title: string;
+    path: string | null;
+    items: NavigationItem[];
+    order: number;
+}

package/dist/types/docs.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=docs.js.map

package/dist/types/docs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"docs.js","sourceRoot":"","sources":["../../src/types/docs.ts"],"names":[],"mappings":""}

package/dist/types/file.d.ts

@@ -0,0 +1,21 @@
+/**
+ * File information structure
+ */
+export interface FileInfo {
+    size: number;
+    created: Date;
+    modified: Date;
+    accessed: Date;
+    isDirectory: boolean;
+    isFile: boolean;
+    permissions: string;
+}
+/**
+ * Tree entry for directory structure
+ */
+export interface FileTreeEntry {
+    name: string;
+    path: string;
+    type: "file" | "directory";
+    children?: FileTreeEntry[];
+}

package/dist/types/file.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=file.js.map

package/dist/types/file.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"file.js","sourceRoot":"","sources":["../../src/types/file.ts"],"names":[],"mappings":""}

package/dist/types/index.d.ts

@@ -1,53 +1,44 @@
-/**
- * Types for the MCP Documentation Management Service
- */
-export interface DocMetadata {
-    title: string;
+export interface DocumentMetadata {
+    title?: string;
+    order?: number;
     description?: string;
+    author?: string;
+    date?: Date;
     tags?: string[];
-    lastUpdated?: string;
-    status?: "draft" | "review" | "published";
-    globs?: string[];
-    alwaysApply?: boolean;
-}
-export interface DocContent {
-    metadata: DocMetadata;
-    content: string;
-    path: string;
-}
-export interface SearchOptions {
-    query: string;
-    tags?: string[];
-    status?: "draft" | "review" | "published";
-    directory?: string;
+    status?: string;
+    [key: string]: any;
 }
-export interface DocUpdateParams {
+export interface DocumentEntry {
     path: string;
-    content?: string;
-    metadata?: Partial<DocMetadata>;
+    name: string;
+    metadata: DocumentMetadata;
 }
-export interface DocCreateParams {
+export interface TreeEntry {
+    name: string;
     path: string;
-    content: string;
-    metadata: DocMetadata;
-}
-export interface MCPQueryResult {
-    success: boolean;
-    data?: any;
+    type: string;
+    metadata?: DocumentMetadata;
+    children: TreeEntry[];
     error?: string;
 }
-export interface DocSummary {
+export interface NavigationItem {
     title: string;
-    description?: string;
-    path: string;
-    lastUpdated?: string;
-    tags?: string[];
-    status?: "draft" | "review" | "published";
-}
-export interface DocAnalysisResult {
-    documentCount: number;
-    byStatus?: Record<string, number>;
-    byDirectory?: Record<string, number>;
-    recentlyUpdated?: DocSummary[];
-    missingDescriptions?: DocSummary[];
+    path: string | null;
+    order: number;
 }
+export interface NavigationSection {
+    title: string;
+    path: string | null;
+    items: NavigationItem[];
+    order: number;
+}
+export type ToolResponse = {
+    content: Array<{
+        type: string;
+        text: string;
+    }>;
+    metadata?: Record<string, any>;
+    isError?: boolean;
+};
+export * from "./docs.js";
+export * from "./tools.js";

package/dist/types/index.js

@@ -1,6 +1,4 @@
-"use strict";
-/**
- * Types for the MCP Documentation Management Service
- */
-Object.defineProperty(exports, "__esModule", { value: true });
+// Re-export all types from specialized modules
+export * from "./docs.js";
+export * from "./tools.js";
 //# sourceMappingURL=index.js.map

package/dist/types/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/types/index.ts"],"names":[],"mappings":";AAAA;;GAEG"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/types/index.ts"],"names":[],"mappings":"AAiDA,+CAA+C;AAC/C,cAAc,WAAW,CAAC;AAC1B,cAAc,YAAY,CAAC"}

package/dist/types/tools.d.ts

@@ -0,0 +1,11 @@
+/**
+ * Standard response format for tools
+ */
+export type ToolResponse = {
+    content: Array<{
+        type: string;
+        text: string;
+    }>;
+    metadata?: Record<string, any>;
+    isError?: boolean;
+};

package/dist/types/tools.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=tools.js.map

package/dist/types/tools.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"tools.js","sourceRoot":"","sources":["../../src/types/tools.ts"],"names":[],"mappings":""}

package/dist/utils/file.d.ts

@@ -0,0 +1,24 @@
+import { FileInfo } from "../types/file.js";
+/**
+ * Gets file statistics and information
+ */
+export declare function getFileStats(filePath: string): Promise<FileInfo>;
+/**
+ * Searches for files matching a pattern
+ */
+export declare function searchFiles(rootPath: string, pattern: string, excludePatterns?: string[]): Promise<string[]>;
+/**
+ * Normalizes line endings to LF
+ */
+export declare function normalizeLineEndings(text: string): string;
+/**
+ * Creates a unified diff between two text contents
+ */
+export declare function createUnifiedDiff(originalContent: string, newContent: string, filepath?: string): string;
+/**
+ * Applies edits to a file
+ */
+export declare function applyFileEdits(filePath: string, edits: Array<{
+    oldText: string;
+    newText: string;
+}>, dryRun?: boolean): Promise<string>;

package/dist/utils/file.js

@@ -0,0 +1,94 @@
+import fs from "fs/promises";
+import path from "path";
+import { createTwoFilesPatch } from "diff";
+import { minimatch } from "minimatch";
+/**
+ * Gets file statistics and information
+ */
+export async function getFileStats(filePath) {
+    const stats = await fs.stat(filePath);
+    // Convert file mode to permission string (e.g., "rwxr-xr-x")
+    const mode = stats.mode;
+    const permissions = [
+        stats.mode & 0o400 ? "r" : "-",
+        stats.mode & 0o200 ? "w" : "-",
+        stats.mode & 0o100 ? "x" : "-",
+        stats.mode & 0o040 ? "r" : "-",
+        stats.mode & 0o020 ? "w" : "-",
+        stats.mode & 0o010 ? "x" : "-",
+        stats.mode & 0o004 ? "r" : "-",
+        stats.mode & 0o002 ? "w" : "-",
+        stats.mode & 0o001 ? "x" : "-",
+    ].join("");
+    return {
+        size: stats.size,
+        created: stats.birthtime,
+        modified: stats.mtime,
+        accessed: stats.atime,
+        isDirectory: stats.isDirectory(),
+        isFile: stats.isFile(),
+        permissions,
+    };
+}
+/**
+ * Searches for files matching a pattern
+ */
+export async function searchFiles(rootPath, pattern, excludePatterns = []) {
+    const results = [];
+    async function search(currentPath) {
+        const entries = await fs.readdir(currentPath, { withFileTypes: true });
+        for (const entry of entries) {
+            const entryPath = path.join(currentPath, entry.name);
+            const relativePath = path.relative(rootPath, entryPath);
+            // Check if path should be excluded
+            if (excludePatterns.some((excludePattern) => minimatch(relativePath, excludePattern))) {
+                continue;
+            }
+            if (entry.isDirectory()) {
+                await search(entryPath);
+            }
+            else if (minimatch(relativePath, pattern)) {
+                results.push(entryPath);
+            }
+        }
+    }
+    await search(rootPath);
+    return results;
+}
+/**
+ * Normalizes line endings to LF
+ */
+export function normalizeLineEndings(text) {
+    return text.replace(/\r\n/g, "\n");
+}
+/**
+ * Creates a unified diff between two text contents
+ */
+export function createUnifiedDiff(originalContent, newContent, filepath = "file") {
+    return createTwoFilesPatch(filepath, filepath, normalizeLineEndings(originalContent), normalizeLineEndings(newContent), "", "", { context: 3 });
+}
+/**
+ * Applies edits to a file
+ */
+export async function applyFileEdits(filePath, edits, dryRun = false) {
+    let content = await fs.readFile(filePath, "utf-8");
+    content = normalizeLineEndings(content);
+    // Apply all edits
+    for (const edit of edits) {
+        const { oldText, newText } = edit;
+        const normalizedOldText = normalizeLineEndings(oldText);
+        if (!content.includes(normalizedOldText)) {
+            throw new Error(`Edit failed: Could not find text to replace in ${filePath}`);
+        }
+        content = content.replace(normalizedOldText, normalizeLineEndings(newText));
+    }
+    // Create a diff to show changes
+    const originalContent = await fs.readFile(filePath, "utf-8");
+    const diff = createUnifiedDiff(originalContent, content, filePath);
+    // Write the changes if not a dry run
+    if (!dryRun) {
+        await fs.writeFile(filePath, content);
+    }
+    return diff;
+}
+//# sourceMappingURL=file.js.map

package/dist/utils/file.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"file.js","sourceRoot":"","sources":["../../src/utils/file.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,aAAa,CAAC;AAC7B,OAAO,IAAI,MAAM,MAAM,CAAC;AAExB,OAAO,EAAE,mBAAmB,EAAE,MAAM,MAAM,CAAC;AAC3C,OAAO,EAAE,SAAS,EAAE,MAAM,WAAW,CAAC;AAEtC;;GAEG;AACH,MAAM,CAAC,KAAK,UAAU,YAAY,CAAC,QAAgB;IACjD,MAAM,KAAK,GAAG,MAAM,EAAE,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;IAEtC,6DAA6D;IAC7D,MAAM,IAAI,GAAG,KAAK,CAAC,IAAI,CAAC;IACxB,MAAM,WAAW,GAAG;QAClB,KAAK,CAAC,IAAI,GAAG,KAAK,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG;QAC9B,KAAK,CAAC,IAAI,GAAG,KAAK,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG;QAC9B,KAAK,CAAC,IAAI,GAAG,KAAK,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG;QAC9B,KAAK,CAAC,IAAI,GAAG,KAAK,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG;QAC9B,KAAK,CAAC,IAAI,GAAG,KAAK,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG;QAC9B,KAAK,CAAC,IAAI,GAAG,KAAK,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG;QAC9B,KAAK,CAAC,IAAI,GAAG,KAAK,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG;QAC9B,KAAK,CAAC,IAAI,GAAG,KAAK,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG;QAC9B,KAAK,CAAC,IAAI,GAAG,KAAK,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG;KAC/B,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IAEX,OAAO;QACL,IAAI,EAAE,KAAK,CAAC,IAAI;QAChB,OAAO,EAAE,KAAK,CAAC,SAAS;QACxB,QAAQ,EAAE,KAAK,CAAC,KAAK;QACrB,QAAQ,EAAE,KAAK,CAAC,KAAK;QACrB,WAAW,EAAE,KAAK,CAAC,WAAW,EAAE;QAChC,MAAM,EAAE,KAAK,CAAC,MAAM,EAAE;QACtB,WAAW;KACZ,CAAC;AACJ,CAAC;AAED;;GAEG;AACH,MAAM,CAAC,KAAK,UAAU,WAAW,CAC/B,QAAgB,EAChB,OAAe,EACf,kBAA4B,EAAE;IAE9B,MAAM,OAAO,GAAa,EAAE,CAAC;IAE7B,KAAK,UAAU,MAAM,CAAC,WAAmB;QACvC,MAAM,OAAO,GAAG,MAAM,EAAE,CAAC,OAAO,CAAC,WAAW,EAAE,EAAE,aAAa,EAAE,IAAI,EAAE,CAAC,CAAC;QAEvE,KAAK,MAAM,KAAK,IAAI,OAAO,EAAE,CAAC;YAC5B,MAAM,SAAS,GAAG,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE,KAAK,CAAC,IAAI,CAAC,CAAC;YACrD,MAAM,YAAY,GAAG,IAAI,CAAC,QAAQ,CAAC,QAAQ,EAAE,SAAS,CAAC,CAAC;YAExD,mCAAmC;YACnC,IACE,eAAe,CAAC,IAAI,CAAC,CAAC,cAAc,EAAE,EAAE,CACtC,SAAS,CAAC,YAAY,EAAE,cAAc,CAAC,CACxC,EACD,CAAC;gBACD,SAAS;YACX,CAAC;YAED,IAAI,KAAK,CAAC,WAAW,EAAE,EAAE,CAAC;gBACxB,MAAM,MAAM,CAAC,SAAS,CAAC,CAAC;YAC1B,CAAC;iBAAM,IAAI,SAAS,CAAC,YAAY,EAAE,OAAO,CAAC,EAAE,CAAC;gBAC5C,OAAO,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;YAC1B,CAAC;QACH,CAAC;IACH,CAAC;IAED,MAAM,MAAM,CAAC,QAAQ,CAAC,CAAC;IACvB,OAAO,OAAO,CAAC;AACjB,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,oBAAoB,CAAC,IAAY;IAC/C,OAAO,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE,IAAI,CAAC,CAAC;AACrC,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,iBAAiB,CAC/B,eAAuB,EACvB,UAAkB,EAClB,WAAmB,MAAM;IAEzB,OAAO,mBAAmB,CACxB,QAAQ,EACR,QAAQ,EACR,oBAAoB,CAAC,eAAe,CAAC,EACrC,oBAAoB,CAAC,UAAU,CAAC,EAChC,EAAE,EACF,EAAE,EACF,EAAE,OAAO,EAAE,CAAC,EAAE,CACf,CAAC;AACJ,CAAC;AAED;;GAEG;AACH,MAAM,CAAC,KAAK,UAAU,cAAc,CAClC,QAAgB,EAChB,KAAkD,EAClD,MAAM,GAAG,KAAK;IAEd,IAAI,OAAO,GAAG,MAAM,EAAE,CAAC,QAAQ,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC;IACnD,OAAO,GAAG,oBAAoB,CAAC,OAAO,CAAC,CAAC;IAExC,kBAAkB;IAClB,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;QACzB,MAAM,EAAE,OAAO,EAAE,OAAO,EAAE,GAAG,IAAI,CAAC;QAClC,MAAM,iBAAiB,GAAG,oBAAoB,CAAC,OAAO,CAAC,CAAC;QAExD,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,iBAAiB,CAAC,EAAE,CAAC;YACzC,MAAM,IAAI,KAAK,CACb,kDAAkD,QAAQ,EAAE,CAC7D,CAAC;QACJ,CAAC;QAED,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC,iBAAiB,EAAE,oBAAoB,CAAC,OAAO,CAAC,CAAC,CAAC;IAC9E,CAAC;IAED,gCAAgC;IAChC,MAAM,eAAe,GAAG,MAAM,EAAE,CAAC,QAAQ,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC;IAC7D,MAAM,IAAI,GAAG,iBAAiB,CAAC,eAAe,EAAE,OAAO,EAAE,QAAQ,CAAC,CAAC;IAEnE,qCAAqC;IACrC,IAAI,CAAC,MAAM,EAAE,CAAC;QACZ,MAAM,EAAE,CAAC,SAAS,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC;IACxC,CAAC;IAED,OAAO,IAAI,CAAC;AACd,CAAC"}

package/dist/utils/index.d.ts

@@ -1,60 +1 @@
-/**
- * Utility functions for the MCP Documentation Service
- */
-/**
- * Check if a path is valid
- * @param path - Path to check
- * @returns True if the path is valid, false otherwise
- */
-export declare function isValidPath(path: string): boolean;
-/**
- * Normalize a path
- * @param path - Path to normalize
- * @returns Normalized path
- */
-export declare function normalizePath(path: string): string;
-/**
- * Get file extension
- * @param path - Path to get extension from
- * @returns File extension
- */
-export declare function getFileExtension(path: string): string;
-/**
- * Get file name
- * @param path - Path to get name from
- * @returns File name
- */
-export declare function getFileName(path: string): string;
-/**
- * Get directory name
- * @param path - Path to get directory name from
- * @returns Directory name
- */
-export declare function getDirectoryName(path: string): string;
-/**
- * Join paths
- * @param paths - Paths to join
- * @returns Joined path
- */
-export declare function joinPaths(...paths: string[]): string;
-/**
- * Escape regex special characters
- * @param str - String to escape
- * @returns Escaped string
- */
-export declare function escapeRegex(str: string): string;
-/**
- * Calculate relevance score
- * @param text - Text to search in
- * @param query - Query to search for
- * @returns Relevance score (0-1)
- */
-export declare function calculateRelevance(text: string, query: string): number;
-/**
- * Generate excerpt
- * @param text - Text to generate excerpt from
- * @param query - Query to highlight
- * @param length - Excerpt length
- * @returns Excerpt
- */
-export declare function generateExcerpt(text: string, query: string, length?: number): string;
+export * from "./path.js";

package/dist/utils/index.js

@@ -1,152 +1,3 @@
-"use strict";
-/**
- * Utility functions for the MCP Documentation Service
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.generateExcerpt = exports.calculateRelevance = exports.escapeRegex = exports.joinPaths = exports.getDirectoryName = exports.getFileName = exports.getFileExtension = exports.normalizePath = exports.isValidPath = void 0;
-/**
- * Check if a path is valid
- * @param path - Path to check
- * @returns True if the path is valid, false otherwise
- */
-function isValidPath(path) {
-    // Ensure path doesn't contain invalid characters or sequences
-    return !path.includes("..") && !path.includes("//") && !path.startsWith("/");
-}
-exports.isValidPath = isValidPath;
-/**
- * Normalize a path
- * @param path - Path to normalize
- * @returns Normalized path
- */
-function normalizePath(path) {
-    // Replace backslashes with forward slashes
-    path = path.replace(/\\/g, "/");
-    // Remove leading and trailing slashes
-    path = path.replace(/^\/+|\/+$/g, "");
-    // Replace multiple slashes with a single slash
-    path = path.replace(/\/+/g, "/");
-    return path;
-}
-exports.normalizePath = normalizePath;
-/**
- * Get file extension
- * @param path - Path to get extension from
- * @returns File extension
- */
-function getFileExtension(path) {
-    const match = path.match(/\.([^.]+)$/);
-    return match ? `.${match[1].toLowerCase()}` : "";
-}
-exports.getFileExtension = getFileExtension;
-/**
- * Get file name
- * @param path - Path to get name from
- * @returns File name
- */
-function getFileName(path) {
-    const match = path.match(/([^/]+)$/);
-    return match ? match[1] : "";
-}
-exports.getFileName = getFileName;
-/**
- * Get directory name
- * @param path - Path to get directory name from
- * @returns Directory name
- */
-function getDirectoryName(path) {
-    const match = path.match(/([^/]+)\/[^/]+$/);
-    return match ? match[1] : "";
-}
-exports.getDirectoryName = getDirectoryName;
-/**
- * Join paths
- * @param paths - Paths to join
- * @returns Joined path
- */
-function joinPaths(...paths) {
-    return normalizePath(paths.join("/"));
-}
-exports.joinPaths = joinPaths;
-/**
- * Escape regex special characters
- * @param str - String to escape
- * @returns Escaped string
- */
-function escapeRegex(str) {
-    return str.replace(/[.*+?^${}()|[\]\\]/g, "\\$&");
-}
-exports.escapeRegex = escapeRegex;
-/**
- * Calculate relevance score
- * @param text - Text to search in
- * @param query - Query to search for
- * @returns Relevance score (0-1)
- */
-function calculateRelevance(text, query) {
-    if (!query || !text)
-        return 0;
-    // Convert to lowercase for case-insensitive matching
-    const lowerText = text.toLowerCase();
-    const lowerQuery = query.toLowerCase();
-    // Check if the query is in the text
-    if (!lowerText.includes(lowerQuery))
-        return 0;
-    // Calculate relevance based on frequency and position
-    const frequency = (lowerText.match(new RegExp(escapeRegex(lowerQuery), "g")) || []).length;
-    const position = lowerText.indexOf(lowerQuery);
-    const textLength = text.length;
-    // Higher relevance for:
-    // - More occurrences of the query
-    // - Earlier position of the query
-    // - Shorter text (query is more significant in shorter text)
-    const frequencyFactor = Math.min(frequency / 5, 1); // Cap at 1
-    const positionFactor = 1 - position / textLength;
-    const lengthFactor = 1 - Math.min(textLength / 1000, 0.9); // Cap at 0.9
-    return frequencyFactor * 0.4 + positionFactor * 0.4 + lengthFactor * 0.2;
-}
-exports.calculateRelevance = calculateRelevance;
-/**
- * Generate excerpt
- * @param text - Text to generate excerpt from
- * @param query - Query to highlight
- * @param length - Excerpt length
- * @returns Excerpt
- */
-function generateExcerpt(text, query, length = 150) {
-    if (!text)
-        return "";
-    if (!query)
-        return text.substring(0, length);
-    // Find the position of the query
-    const lowerText = text.toLowerCase();
-    const lowerQuery = query.toLowerCase();
-    const position = lowerText.indexOf(lowerQuery);
-    if (position === -1) {
-        // Query not found, return the beginning of the text
-        return text.substring(0, length) + (text.length > length ? "..." : "");
-    }
-    // Calculate start and end positions for the excerpt
-    const halfLength = Math.floor(length / 2);
-    let start = Math.max(0, position - halfLength);
-    let end = Math.min(text.length, position + query.length + halfLength);
-    // Adjust if the excerpt is shorter than the desired length
-    if (end - start < length) {
-        if (start === 0) {
-            end = Math.min(text.length, length);
-        }
-        else if (end === text.length) {
-            start = Math.max(0, text.length - length);
-        }
-    }
-    // Generate the excerpt
-    let excerpt = text.substring(start, end);
-    // Add ellipsis if needed
-    if (start > 0)
-        excerpt = "..." + excerpt;
-    if (end < text.length)
-        excerpt = excerpt + "...";
-    return excerpt;
-}
-exports.generateExcerpt = generateExcerpt;
+// Re-export all utility functions
+export * from "./path.js";
 //# sourceMappingURL=index.js.map

package/dist/utils/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/utils/index.ts"],"names":[],"mappings":";AAAA;;GAEG;;;AAEH;;;;GAIG;AACH,SAAgB,WAAW,CAAC,IAAY;IACtC,8DAA8D;IAC9D,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC;AAC/E,CAAC;AAHD,kCAGC;AAED;;;;GAIG;AACH,SAAgB,aAAa,CAAC,IAAY;IACxC,2CAA2C;IAC3C,IAAI,GAAG,IAAI,CAAC,OAAO,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC;IAEhC,sCAAsC;IACtC,IAAI,GAAG,IAAI,CAAC,OAAO,CAAC,YAAY,EAAE,EAAE,CAAC,CAAC;IAEtC,+CAA+C;IAC/C,IAAI,GAAG,IAAI,CAAC,OAAO,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IAEjC,OAAO,IAAI,CAAC;AACd,CAAC;AAXD,sCAWC;AAED;;;;GAIG;AACH,SAAgB,gBAAgB,CAAC,IAAY;IAC3C,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,YAAY,CAAC,CAAC;IACvC,OAAO,KAAK,CAAC,CAAC,CAAC,IAAI,KAAK,CAAC,CAAC,CAAC,CAAC,WAAW,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;AACnD,CAAC;AAHD,4CAGC;AAED;;;;GAIG;AACH,SAAgB,WAAW,CAAC,IAAY;IACtC,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC;IACrC,OAAO,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;AAC/B,CAAC;AAHD,kCAGC;AAED;;;;GAIG;AACH,SAAgB,gBAAgB,CAAC,IAAY;IAC3C,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,iBAAiB,CAAC,CAAC;IAC5C,OAAO,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;AAC/B,CAAC;AAHD,4CAGC;AAED;;;;GAIG;AACH,SAAgB,SAAS,CAAC,GAAG,KAAe;IAC1C,OAAO,aAAa,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC;AACxC,CAAC;AAFD,8BAEC;AAED;;;;GAIG;AACH,SAAgB,WAAW,CAAC,GAAW;IACrC,OAAO,GAAG,CAAC,OAAO,CAAC,qBAAqB,EAAE,MAAM,CAAC,CAAC;AACpD,CAAC;AAFD,kCAEC;AAED;;;;;GAKG;AACH,SAAgB,kBAAkB,CAAC,IAAY,EAAE,KAAa;IAC5D,IAAI,CAAC,KAAK,IAAI,CAAC,IAAI;QAAE,OAAO,CAAC,CAAC;IAE9B,qDAAqD;IACrD,MAAM,SAAS,GAAG,IAAI,CAAC,WAAW,EAAE,CAAC;IACrC,MAAM,UAAU,GAAG,KAAK,CAAC,WAAW,EAAE,CAAC;IAEvC,oCAAoC;IACpC,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,UAAU,CAAC;QAAE,OAAO,CAAC,CAAC;IAE9C,sDAAsD;IACtD,MAAM,SAAS,GAAG,CAChB,SAAS,CAAC,KAAK,CAAC,IAAI,MAAM,CAAC,WAAW,CAAC,UAAU,CAAC,EAAE,GAAG,CAAC,CAAC,IAAI,EAAE,CAChE,CAAC,MAAM,CAAC;IACT,MAAM,QAAQ,GAAG,SAAS,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC;IAC/C,MAAM,UAAU,GAAG,IAAI,CAAC,MAAM,CAAC;IAE/B,wBAAwB;IACxB,kCAAkC;IAClC,kCAAkC;IAClC,6DAA6D;IAC7D,MAAM,eAAe,GAAG,IAAI,CAAC,GAAG,CAAC,SAAS,GAAG,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,WAAW;IAC/D,MAAM,cAAc,GAAG,CAAC,GAAG,QAAQ,GAAG,UAAU,CAAC;IACjD,MAAM,YAAY,GAAG,CAAC,GAAG,IAAI,CAAC,GAAG,CAAC,UAAU,GAAG,IAAI,EAAE,GAAG,CAAC,CAAC,CAAC,aAAa;IAExE,OAAO,eAAe,GAAG,GAAG,GAAG,cAAc,GAAG,GAAG,GAAG,YAAY,GAAG,GAAG,CAAC;AAC3E,CAAC;AA1BD,gDA0BC;AAED;;;;;;GAMG;AACH,SAAgB,eAAe,CAC7B,IAAY,EACZ,KAAa,EACb,SAAiB,GAAG;IAEpB,IAAI,CAAC,IAAI;QAAE,OAAO,EAAE,CAAC;IACrB,IAAI,CAAC,KAAK;QAAE,OAAO,IAAI,CAAC,SAAS,CAAC,CAAC,EAAE,MAAM,CAAC,CAAC;IAE7C,iCAAiC;IACjC,MAAM,SAAS,GAAG,IAAI,CAAC,WAAW,EAAE,CAAC;IACrC,MAAM,UAAU,GAAG,KAAK,CAAC,WAAW,EAAE,CAAC;IACvC,MAAM,QAAQ,GAAG,SAAS,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC;IAE/C,IAAI,QAAQ,KAAK,CAAC,CAAC,EAAE;QACnB,oDAAoD;QACpD,OAAO,IAAI,CAAC,SAAS,CAAC,CAAC,EAAE,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC;KACxE;IAED,oDAAoD;IACpD,MAAM,UAAU,GAAG,IAAI,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;IAC1C,IAAI,KAAK,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,QAAQ,GAAG,UAAU,CAAC,CAAC;IAC/C,IAAI,GAAG,GAAG,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,MAAM,EAAE,QAAQ,GAAG,KAAK,CAAC,MAAM,GAAG,UAAU,CAAC,CAAC;IAEtE,2DAA2D;IAC3D,IAAI,GAAG,GAAG,KAAK,GAAG,MAAM,EAAE;QACxB,IAAI,KAAK,KAAK,CAAC,EAAE;YACf,GAAG,GAAG,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;SACrC;aAAM,IAAI,GAAG,KAAK,IAAI,CAAC,MAAM,EAAE;YAC9B,KAAK,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC,CAAC;SAC3C;KACF;IAED,uBAAuB;IACvB,IAAI,OAAO,GAAG,IAAI,CAAC,SAAS,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC;IAEzC,yBAAyB;IACzB,IAAI,KAAK,GAAG,CAAC;QAAE,OAAO,GAAG,KAAK,GAAG,OAAO,CAAC;IACzC,IAAI,GAAG,GAAG,IAAI,CAAC,MAAM;QAAE,OAAO,GAAG,OAAO,GAAG,KAAK,CAAC;IAEjD,OAAO,OAAO,CAAC;AACjB,CAAC;AAxCD,0CAwCC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/utils/index.ts"],"names":[],"mappings":"AAAA,kCAAkC;AAClC,cAAc,WAAW,CAAC"}

package/dist/utils/path.d.ts

@@ -0,0 +1,16 @@
+/**
+ * Normalizes a path consistently
+ */
+export declare function normalizePath(p: string): string;
+/**
+ * Expands the home directory tilde (~) in a path
+ */
+export declare function expandHome(filepath: string): string;
+/**
+ * Validates that a path is within allowed directories
+ * @param p The path to validate
+ * @param allowedDirectories Array of allowed directory paths
+ * @returns The normalized path if valid
+ * @throws Error if path is not within allowed directories
+ */
+export declare function validatePath(p: string, allowedDirectories: string[]): Promise<string>;