@enokdev/springdocs-mcp 1.2.7 → 1.4.1

package/build/services/spring-projects-config.js

@@ -0,0 +1,397 @@
+/**
+ * Spring Projects Configuration Service
+ *
+ * Central registry for all Spring project metadata, enabling generic multi-project
+ * architecture without hardcoding specific projects in service implementations.
+ *
+ * This configuration-driven approach allows adding new Spring projects (Security,
+ * Data, Cloud, etc.) with zero code changes - only configuration updates.
+ */
+import { normalizeVersion } from './url.js';
+/**
+ * Spring Projects Registry
+ *
+ * Single source of truth for all supported Spring projects.
+ * To add a new Spring project, simply add a new entry here - no code changes required.
+ */
+export const SPRING_PROJECTS = new Map([
+    [
+        'boot',
+        {
+            id: 'boot',
+            githubRepo: 'spring-projects/spring-boot',
+            githubTagPrefix: 'v',
+            versionInsertAfter: 'https://docs.spring.io/spring-boot/',
+            displayName: 'Spring Boot',
+            referenceBaseUrl: 'https://docs.spring.io/spring-boot',
+            referenceLayout: 'directory',
+            referencePaths: {
+                'deployment': 'how-to/deployment',
+                'native-image': 'reference/packaging/native-image',
+                'application-properties': 'appendix/application-properties'
+            },
+            hasVersionedDocs: true,
+            cacheStrategy: 'long', // Stable releases, cache aggressively
+            referenceSections: [
+                'features',
+                'using',
+                'web',
+                'data',
+                'messaging',
+                'io',
+                'actuator',
+                'deployment',
+                'native-image',
+                'testing',
+                'application-properties'
+            ]
+        }
+    ],
+    [
+        'ai',
+        {
+            id: 'ai',
+            githubRepo: 'spring-projects/spring-ai',
+            githubTagPrefix: 'v',
+            versionInsertAfter: 'https://docs.spring.io/spring-ai/reference/',
+            displayName: 'Spring AI',
+            referenceBaseUrl: 'https://docs.spring.io/spring-ai/reference/api',
+            referenceLayout: 'flat',
+            hasVersionedDocs: true, // Verified: https://docs.spring.io/spring-ai/reference/1.1/api/chatclient.html
+            cacheStrategy: 'short', // AI documentation evolves rapidly, shorter cache
+            referenceSections: [
+                'chatclient',
+                'chatmodel',
+                'embeddings',
+                'vectordbs',
+                'retrieval-augmented-generation',
+                'tools',
+                'prompt',
+                'structured-output'
+            ]
+        }
+    ],
+    [
+        'framework',
+        {
+            id: 'framework',
+            githubRepo: 'spring-projects/spring-framework',
+            githubTagPrefix: 'v',
+            versionInsertAfter: 'https://docs.spring.io/spring-framework/reference/',
+            displayName: 'Spring Framework',
+            referenceBaseUrl: 'https://docs.spring.io/spring-framework/reference',
+            referenceLayout: 'flat',
+            hasVersionedDocs: true,
+            cacheStrategy: 'long',
+            referenceSections: [
+                'core',
+                'web',
+                'web-reactive',
+                'data-access',
+                'integration',
+                'languages',
+                'testing'
+            ]
+        }
+    ],
+    [
+        'security',
+        {
+            id: 'security',
+            githubRepo: 'spring-projects/spring-security',
+            githubTagPrefix: '',
+            versionInsertAfter: 'https://docs.spring.io/spring-security/reference/',
+            displayName: 'Spring Security',
+            referenceBaseUrl: 'https://docs.spring.io/spring-security',
+            referenceLayout: 'directory',
+            // Directory layout: subsections only resolve to <dir>/<subsection>.html, so nested folders
+            // (oauth2/login/..., authentication/passwords/...) are not reachable; hence the top-level paths below.
+            referencePaths: {
+                'authentication': 'reference/servlet/authentication',
+                'authorization': 'reference/servlet/authorization',
+                'oauth2': 'reference/servlet/oauth2',
+                'exploits': 'reference/servlet/exploits',
+                'integrations': 'reference/servlet/integrations',
+                'testing': 'reference/servlet/test'
+            },
+            hasVersionedDocs: true, // Verified: https://docs.spring.io/spring-security/reference/6.5/index.html
+            cacheStrategy: 'long',
+            referenceSections: [
+                'servlet',
+                'reactive',
+                'features',
+                'migration',
+                'authentication',
+                'authorization',
+                'oauth2',
+                'exploits',
+                'integrations',
+                'testing'
+            ]
+        }
+    ],
+    [
+        'data-jpa',
+        {
+            id: 'data-jpa',
+            githubRepo: 'spring-projects/spring-data-jpa',
+            githubTagPrefix: '',
+            versionInsertAfter: 'https://docs.spring.io/spring-data/jpa/reference/',
+            displayName: 'Spring Data JPA',
+            referenceBaseUrl: 'https://docs.spring.io/spring-data/jpa/reference',
+            referenceLayout: 'flat',
+            hasVersionedDocs: true, // Verified: https://docs.spring.io/spring-data/jpa/reference/3.5/index.html
+            cacheStrategy: 'long',
+            referenceSections: [
+                'jpa',
+                'auditing',
+                // repositories.html alone returns 404 (verified): this section only works with a subsection, e.g. 'core-concepts'
+                'repositories'
+            ]
+        }
+    ],
+    [
+        'batch',
+        {
+            id: 'batch',
+            githubRepo: 'spring-projects/spring-batch',
+            githubTagPrefix: 'v',
+            versionInsertAfter: 'https://docs.spring.io/spring-batch/reference/',
+            displayName: 'Spring Batch',
+            referenceBaseUrl: 'https://docs.spring.io/spring-batch/reference',
+            referenceLayout: 'flat',
+            hasVersionedDocs: true, // Verified: https://docs.spring.io/spring-batch/reference/5.2/index.html
+            cacheStrategy: 'long',
+            referenceSections: [
+                'spring-batch-architecture',
+                'whatsnew',
+                'domain',
+                'job',
+                'step',
+                'readersAndWriters',
+                'processor',
+                'scalability',
+                'repeat',
+                'retry',
+                'testing',
+                'common-patterns'
+            ]
+        }
+    ],
+    [
+        'integration',
+        {
+            id: 'integration',
+            githubRepo: 'spring-projects/spring-integration',
+            githubTagPrefix: 'v',
+            versionInsertAfter: 'https://docs.spring.io/spring-integration/reference/',
+            displayName: 'Spring Integration',
+            referenceBaseUrl: 'https://docs.spring.io/spring-integration/reference',
+            referenceLayout: 'flat',
+            hasVersionedDocs: true, // Verified: https://docs.spring.io/spring-integration/reference/6.5/index.html
+            cacheStrategy: 'long',
+            referenceSections: [
+                'overview',
+                'message',
+                'channel',
+                'endpoint',
+                'router',
+                'transformer',
+                'dsl',
+                'http',
+                'jms',
+                'amqp',
+                'kafka',
+                'testing',
+                'whats-new'
+            ]
+        }
+    ],
+    [
+        'kafka',
+        {
+            id: 'kafka',
+            githubRepo: 'spring-projects/spring-kafka',
+            githubTagPrefix: 'v',
+            versionInsertAfter: 'https://docs.spring.io/spring-kafka/reference/',
+            displayName: 'Spring for Apache Kafka',
+            referenceBaseUrl: 'https://docs.spring.io/spring-kafka/reference',
+            referenceLayout: 'flat',
+            hasVersionedDocs: true, // Verified: https://docs.spring.io/spring-kafka/reference/3.3/index.html
+            cacheStrategy: 'long',
+            referenceSections: [
+                'introduction',
+                'quick-tour',
+                'kafka',
+                'retrytopic',
+                'streams',
+                'testing',
+                'whats-new'
+            ]
+        }
+    ],
+    [
+        'modulith',
+        {
+            id: 'modulith',
+            githubRepo: 'spring-projects/spring-modulith',
+            githubTagPrefix: '',
+            versionInsertAfter: 'https://docs.spring.io/spring-modulith/reference/',
+            displayName: 'Spring Modulith',
+            referenceBaseUrl: 'https://docs.spring.io/spring-modulith/reference',
+            referenceLayout: 'flat',
+            hasVersionedDocs: true, // Verified: https://docs.spring.io/spring-modulith/reference/1.4/index.html
+            cacheStrategy: 'long',
+            referenceSections: [
+                'fundamentals',
+                'events',
+                'testing',
+                'verification',
+                'documentation',
+                'appendix'
+            ]
+        }
+    ],
+    [
+        'cloud-gateway',
+        {
+            id: 'cloud-gateway',
+            githubRepo: 'spring-cloud/spring-cloud-gateway',
+            githubTagPrefix: 'v',
+            versionInsertAfter: 'https://docs.spring.io/spring-cloud-gateway/reference/',
+            displayName: 'Spring Cloud Gateway',
+            referenceBaseUrl: 'https://docs.spring.io/spring-cloud-gateway/reference',
+            referenceLayout: 'flat',
+            hasVersionedDocs: true, // Verified: https://docs.spring.io/spring-cloud-gateway/reference/4.3/index.html
+            cacheStrategy: 'long',
+            referenceSections: [
+                'spring-cloud-gateway-server-webflux',
+                'spring-cloud-gateway-server-webmvc',
+                'appendix'
+            ]
+        }
+    ],
+    [
+        'cloud-config',
+        {
+            id: 'cloud-config',
+            githubRepo: 'spring-cloud/spring-cloud-config',
+            githubTagPrefix: 'v',
+            versionInsertAfter: 'https://docs.spring.io/spring-cloud-config/reference/',
+            displayName: 'Spring Cloud Config',
+            referenceBaseUrl: 'https://docs.spring.io/spring-cloud-config/reference',
+            referenceLayout: 'flat',
+            hasVersionedDocs: true, // Verified: https://docs.spring.io/spring-cloud-config/reference/4.3/index.html
+            cacheStrategy: 'long',
+            referenceSections: [
+                'quickstart',
+                'server',
+                'client'
+            ]
+        }
+    ]
+    // Future projects can be added here (e.g. 'cloud-*' siblings, 'data-*' modules, 'graphql', 'session').
+]);
+/**
+ * Spring Projects Configuration Manager
+ *
+ * Provides type-safe access to Spring project configurations with validation
+ * and helper methods for URL construction.
+ */
+export class SpringProjectsConfig {
+    projects;
+    constructor(projectsMap = SPRING_PROJECTS) {
+        this.projects = projectsMap;
+    }
+    /**
+     * Get configuration for a specific Spring project
+     * @throws Error if project not found
+     */
+    getProject(projectId) {
+        const project = this.projects.get(projectId);
+        if (!project) {
+            const availableProjects = Array.from(this.projects.keys()).join(', ');
+            throw new Error(`Unknown Spring project: "${projectId}". Available projects: ${availableProjects}`);
+        }
+        return project;
+    }
+    /**
+     * Get all supported project IDs
+     */
+    getAllProjectIds() {
+        return Array.from(this.projects.keys());
+    }
+    /**
+     * Get all project configurations
+     */
+    getAllProjects() {
+        return Array.from(this.projects.values());
+    }
+    /**
+     * Build documentation reference URL for a project (current documentation version)
+     *
+     * @param projectId - Project identifier
+     * @param section - Documentation section (e.g., "web", "chatclient"), already validated as a safe URL segment
+     * @param subsection - Optional page inside the section (e.g., "servlet" for boot/web)
+     * @param version - Optional documentation version ("3.4" or "3.4.2"); omitted or "current" means the current docs
+     * @returns Complete URL to the documentation page
+     */
+    buildReferenceUrl(projectId, section, subsection, version) {
+        const normalizedVersion = normalizeVersion(version);
+        const project = this.getProject(projectId);
+        const base = project.referenceBaseUrl;
+        let url;
+        if (project.referenceLayout === 'directory') {
+            const dir = project.referencePaths?.[section] ?? `reference/${section}`;
+            url = `${base}/${dir}/${subsection ? `${subsection}.html` : 'index.html'}`;
+        }
+        else {
+            url = subsection ? `${base}/${section}/${subsection}.html` : `${base}/${section}.html`;
+        }
+        if (!normalizedVersion)
+            return url;
+        const prefix = project.versionInsertAfter;
+        if (!project.hasVersionedDocs || !prefix) {
+            throw new Error(`Project "${projectId}" does not support versioned documentation`);
+        }
+        if (!url.startsWith(prefix)) {
+            throw new Error(`Invalid configuration for project "${projectId}": versionInsertAfter is not a prefix of ${url}`);
+        }
+        return `${prefix}${normalizedVersion}/${url.slice(prefix.length)}`;
+    }
+    /**
+     * Get cache TTL in milliseconds for a project
+     *
+     * @param projectId - Project identifier
+     * @returns TTL in milliseconds
+     */
+    getCacheTTL(projectId) {
+        const project = this.getProject(projectId);
+        // Convert strategy to milliseconds
+        switch (project.cacheStrategy) {
+            case 'short':
+                return 30 * 60 * 1000; // 30 minutes
+            case 'long':
+                return 24 * 60 * 60 * 1000; // 24 hours
+            default:
+                return 30 * 60 * 1000; // Default to 30 minutes
+        }
+    }
+    /**
+     * Validate if a section exists for a project
+     * Returns true if validation passes or if project doesn't define sections
+     */
+    validateSection(projectId, section) {
+        const project = this.getProject(projectId);
+        // If project doesn't define sections, allow any section
+        if (!project.referenceSections || project.referenceSections.length === 0) {
+            return true;
+        }
+        return project.referenceSections.includes(section);
+    }
+}
+/**
+ * Singleton instance for application-wide use
+ */
+export const springProjectsConfig = new SpringProjectsConfig();
+//# sourceMappingURL=spring-projects-config.js.map

package/build/services/spring-projects-config.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"spring-projects-config.js","sourceRoot":"","sources":["../../src/services/spring-projects-config.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AAEH,OAAO,EAAE,gBAAgB,EAAE,MAAM,UAAU,CAAC;AA6C5C;;;;;GAKG;AACH,MAAM,CAAC,MAAM,eAAe,GAAqC,IAAI,GAAG,CAA8B;IACpG;QACE,MAAM;QACN;YACE,EAAE,EAAE,MAAM;YACV,UAAU,EAAE,6BAA6B;YACzC,eAAe,EAAE,GAAG;YACpB,kBAAkB,EAAE,qCAAqC;YACzD,WAAW,EAAE,aAAa;YAC1B,gBAAgB,EAAE,oCAAoC;YACtD,eAAe,EAAE,WAAW;YAC5B,cAAc,EAAE;gBACd,YAAY,EAAE,mBAAmB;gBACjC,cAAc,EAAE,kCAAkC;gBAClD,wBAAwB,EAAE,iCAAiC;aAC5D;YACD,gBAAgB,EAAE,IAAI;YACtB,aAAa,EAAE,MAAM,EAAE,sCAAsC;YAC7D,iBAAiB,EAAE;gBACjB,UAAU;gBACV,OAAO;gBACP,KAAK;gBACL,MAAM;gBACN,WAAW;gBACX,IAAI;gBACJ,UAAU;gBACV,YAAY;gBACZ,cAAc;gBACd,SAAS;gBACT,wBAAwB;aACzB;SACF;KACF;IACD;QACE,IAAI;QACJ;YACE,EAAE,EAAE,IAAI;YACR,UAAU,EAAE,2BAA2B;YACvC,eAAe,EAAE,GAAG;YACpB,kBAAkB,EAAE,6CAA6C;YACjE,WAAW,EAAE,WAAW;YACxB,gBAAgB,EAAE,gDAAgD;YAClE,eAAe,EAAE,MAAM;YACvB,gBAAgB,EAAE,IAAI,EAAE,+EAA+E;YACvG,aAAa,EAAE,OAAO,EAAE,kDAAkD;YAC1E,iBAAiB,EAAE;gBACjB,YAAY;gBACZ,WAAW;gBACX,YAAY;gBACZ,WAAW;gBACX,gCAAgC;gBAChC,OAAO;gBACP,QAAQ;gBACR,mBAAmB;aACpB;SACF;KACF;IACD;QACE,WAAW;QACX;YACE,EAAE,EAAE,WAAW;YACf,UAAU,EAAE,kCAAkC;YAC9C,eAAe,EAAE,GAAG;YACpB,kBAAkB,EAAE,oDAAoD;YACxE,WAAW,EAAE,kBAAkB;YAC/B,gBAAgB,EAAE,mDAAmD;YACrE,eAAe,EAAE,MAAM;YACvB,gBAAgB,EAAE,IAAI;YACtB,aAAa,EAAE,MAAM;YACrB,iBAAiB,EAAE;gBACjB,MAAM;gBACN,KAAK;gBACL,cAAc;gBACd,aAAa;gBACb,aAAa;gBACb,WAAW;gBACX,SAAS;aACV;SACF;KACF;IACD;QACE,UAAU;QACV;YACE,EAAE,EAAE,UAAU;YACd,UAAU,EAAE,iCAAiC;YAC7C,eAAe,EAAE,EAAE;YACnB,kBAAkB,EAAE,mDAAmD;YACvE,WAAW,EAAE,iBAAiB;YAC9B,gBAAgB,EAAE,wCAAwC;YAC1D,eAAe,EAAE,WAAW;YAC5B,2FAA2F;YAC3F,uGAAuG;YACvG,cAAc,EAAE;gBACd,gBAAgB,EAAE,kCAAkC;gBACpD,eAAe,EAAE,iCAAiC;gBAClD,QAAQ,EAAE,0BAA0B;gBACpC,UAAU,EAAE,4BAA4B;gBACxC,cAAc,EAAE,gCAAgC;gBAChD,SAAS,EAAE,wBAAwB;aACpC;YACD,gBAAgB,EAAE,IAAI,EAAE,4EAA4E;YACpG,aAAa,EAAE,MAAM;YACrB,iBAAiB,EAAE;gBACjB,SAAS;gBACT,UAAU;gBACV,UAAU;gBACV,WAAW;gBACX,gBAAgB;gBAChB,eAAe;gBACf,QAAQ;gBACR,UAAU;gBACV,cAAc;gBACd,SAAS;aACV;SACF;KACF;IACD;QACE,UAAU;QACV;YACE,EAAE,EAAE,UAAU;YACd,UAAU,EAAE,iCAAiC;YAC7C,eAAe,EAAE,EAAE;YACnB,kBAAkB,EAAE,mDAAmD;YACvE,WAAW,EAAE,iBAAiB;YAC9B,gBAAgB,EAAE,kDAAkD;YACpE,eAAe,EAAE,MAAM;YACvB,gBAAgB,EAAE,IAAI,EAAE,4EAA4E;YACpG,aAAa,EAAE,MAAM;YACrB,iBAAiB,EAAE;gBACjB,KAAK;gBACL,UAAU;gBACV,kHAAkH;gBAClH,cAAc;aACf;SACF;KACF;IACD;QACE,OAAO;QACP;YACE,EAAE,EAAE,OAAO;YACX,UAAU,EAAE,8BAA8B;YAC1C,eAAe,EAAE,GAAG;YACpB,kBAAkB,EAAE,gDAAgD;YACpE,WAAW,EAAE,cAAc;YAC3B,gBAAgB,EAAE,+CAA+C;YACjE,eAAe,EAAE,MAAM;YACvB,gBAAgB,EAAE,IAAI,EAAE,yEAAyE;YACjG,aAAa,EAAE,MAAM;YACrB,iBAAiB,EAAE;gBACjB,2BAA2B;gBAC3B,UAAU;gBACV,QAAQ;gBACR,KAAK;gBACL,MAAM;gBACN,mBAAmB;gBACnB,WAAW;gBACX,aAAa;gBACb,QAAQ;gBACR,OAAO;gBACP,SAAS;gBACT,iBAAiB;aAClB;SACF;KACF;IACD;QACE,aAAa;QACb;YACE,EAAE,EAAE,aAAa;YACjB,UAAU,EAAE,oCAAoC;YAChD,eAAe,EAAE,GAAG;YACpB,kBAAkB,EAAE,sDAAsD;YAC1E,WAAW,EAAE,oBAAoB;YACjC,gBAAgB,EAAE,qDAAqD;YACvE,eAAe,EAAE,MAAM;YACvB,gBAAgB,EAAE,IAAI,EAAE,+EAA+E;YACvG,aAAa,EAAE,MAAM;YACrB,iBAAiB,EAAE;gBACjB,UAAU;gBACV,SAAS;gBACT,SAAS;gBACT,UAAU;gBACV,QAAQ;gBACR,aAAa;gBACb,KAAK;gBACL,MAAM;gBACN,KAAK;gBACL,MAAM;gBACN,OAAO;gBACP,SAAS;gBACT,WAAW;aACZ;SACF;KACF;IACD;QACE,OAAO;QACP;YACE,EAAE,EAAE,OAAO;YACX,UAAU,EAAE,8BAA8B;YAC1C,eAAe,EAAE,GAAG;YACpB,kBAAkB,EAAE,gDAAgD;YACpE,WAAW,EAAE,yBAAyB;YACtC,gBAAgB,EAAE,+CAA+C;YACjE,eAAe,EAAE,MAAM;YACvB,gBAAgB,EAAE,IAAI,EAAE,yEAAyE;YACjG,aAAa,EAAE,MAAM;YACrB,iBAAiB,EAAE;gBACjB,cAAc;gBACd,YAAY;gBACZ,OAAO;gBACP,YAAY;gBACZ,SAAS;gBACT,SAAS;gBACT,WAAW;aACZ;SACF;KACF;IACD;QACE,UAAU;QACV;YACE,EAAE,EAAE,UAAU;YACd,UAAU,EAAE,iCAAiC;YAC7C,eAAe,EAAE,EAAE;YACnB,kBAAkB,EAAE,mDAAmD;YACvE,WAAW,EAAE,iBAAiB;YAC9B,gBAAgB,EAAE,kDAAkD;YACpE,eAAe,EAAE,MAAM;YACvB,gBAAgB,EAAE,IAAI,EAAE,4EAA4E;YACpG,aAAa,EAAE,MAAM;YACrB,iBAAiB,EAAE;gBACjB,cAAc;gBACd,QAAQ;gBACR,SAAS;gBACT,cAAc;gBACd,eAAe;gBACf,UAAU;aACX;SACF;KACF;IACD;QACE,eAAe;QACf;YACE,EAAE,EAAE,eAAe;YACnB,UAAU,EAAE,mCAAmC;YAC/C,eAAe,EAAE,GAAG;YACpB,kBAAkB,EAAE,wDAAwD;YAC5E,WAAW,EAAE,sBAAsB;YACnC,gBAAgB,EAAE,uDAAuD;YACzE,eAAe,EAAE,MAAM;YACvB,gBAAgB,EAAE,IAAI,EAAE,iFAAiF;YACzG,aAAa,EAAE,MAAM;YACrB,iBAAiB,EAAE;gBACjB,qCAAqC;gBACrC,oCAAoC;gBACpC,UAAU;aACX;SACF;KACF;IACD;QACE,cAAc;QACd;YACE,EAAE,EAAE,cAAc;YAClB,UAAU,EAAE,kCAAkC;YAC9C,eAAe,EAAE,GAAG;YACpB,kBAAkB,EAAE,uDAAuD;YAC3E,WAAW,EAAE,qBAAqB;YAClC,gBAAgB,EAAE,sDAAsD;YACxE,eAAe,EAAE,MAAM;YACvB,gBAAgB,EAAE,IAAI,EAAE,gFAAgF;YACxG,aAAa,EAAE,MAAM;YACrB,iBAAiB,EAAE;gBACjB,YAAY;gBACZ,QAAQ;gBACR,QAAQ;aACT;SACF;KACF;IACD,uGAAuG;CACxG,CAAC,CAAC;AAEH;;;;;GAKG;AACH,MAAM,OAAO,oBAAoB;IACd,QAAQ,CAAmC;IAE5D,YAAY,cAAgD,eAAe;QACzE,IAAI,CAAC,QAAQ,GAAG,WAAW,CAAC;IAC9B,CAAC;IAED;;;OAGG;IACH,UAAU,CAAC,SAAiB;QAC1B,MAAM,OAAO,GAAG,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC;QAC7C,IAAI,CAAC,OAAO,EAAE,CAAC;YACb,MAAM,iBAAiB,GAAG,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,IAAI,EAAE,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YACtE,MAAM,IAAI,KAAK,CACb,4BAA4B,SAAS,0BAA0B,iBAAiB,EAAE,CACnF,CAAC;QACJ,CAAC;QACD,OAAO,OAAO,CAAC;IACjB,CAAC;IAED;;OAEG;IACH,gBAAgB;QACd,OAAO,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,IAAI,EAAE,CAAC,CAAC;IAC1C,CAAC;IAED;;OAEG;IACH,cAAc;QACZ,OAAO,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,MAAM,EAAE,CAAC,CAAC;IAC5C,CAAC;IAED;;;;;;;;OAQG;IACH,iBAAiB,CAAC,SAAiB,EAAE,OAAe,EAAE,UAAmB,EAAE,OAAgB;QACzF,MAAM,iBAAiB,GAAG,gBAAgB,CAAC,OAAO,CAAC,CAAC;QACpD,MAAM,OAAO,GAAG,IAAI,CAAC,UAAU,CAAC,SAAS,CAAC,CAAC;QAC3C,MAAM,IAAI,GAAG,OAAO,CAAC,gBAAgB,CAAC;QAEtC,IAAI,GAAW,CAAC;QAChB,IAAI,OAAO,CAAC,eAAe,KAAK,WAAW,EAAE,CAAC;YAC5C,MAAM,GAAG,GAAG,OAAO,CAAC,cAAc,EAAE,CAAC,OAAO,CAAC,IAAI,aAAa,OAAO,EAAE,CAAC;YACxE,GAAG,GAAG,GAAG,IAAI,IAAI,GAAG,IAAI,UAAU,CAAC,CAAC,CAAC,GAAG,UAAU,OAAO,CAAC,CAAC,CAAC,YAAY,EAAE,CAAC;QAC7E,CAAC;aAAM,CAAC;YACN,GAAG,GAAG,UAAU,CAAC,CAAC,CAAC,GAAG,IAAI,IAAI,OAAO,IAAI,UAAU,OAAO,CAAC,CAAC,CAAC,GAAG,IAAI,IAAI,OAAO,OAAO,CAAC;QACzF,CAAC;QACD,IAAI,CAAC,iBAAiB;YAAE,OAAO,GAAG,CAAC;QAEnC,MAAM,MAAM,GAAG,OAAO,CAAC,kBAAkB,CAAC;QAC1C,IAAI,CAAC,OAAO,CAAC,gBAAgB,IAAI,CAAC,MAAM,EAAE,CAAC;YACzC,MAAM,IAAI,KAAK,CAAC,YAAY,SAAS,4CAA4C,CAAC,CAAC;QACrF,CAAC;QACD,IAAI,CAAC,GAAG,CAAC,UAAU,CAAC,MAAM,CAAC,EAAE,CAAC;YAC5B,MAAM,IAAI,KAAK,CAAC,sCAAsC,SAAS,4CAA4C,GAAG,EAAE,CAAC,CAAC;QACpH,CAAC;QACD,OAAO,GAAG,MAAM,GAAG,iBAAiB,IAAI,GAAG,CAAC,KAAK,CAAC,MAAM,CAAC,MAAM,CAAC,EAAE,CAAC;IACrE,CAAC;IAED;;;;;OAKG;IACH,WAAW,CAAC,SAAiB;QAC3B,MAAM,OAAO,GAAG,IAAI,CAAC,UAAU,CAAC,SAAS,CAAC,CAAC;QAE3C,mCAAmC;QACnC,QAAQ,OAAO,CAAC,aAAa,EAAE,CAAC;YAC9B,KAAK,OAAO;gBACV,OAAO,EAAE,GAAG,EAAE,GAAG,IAAI,CAAC,CAAC,aAAa;YACtC,KAAK,MAAM;gBACT,OAAO,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,IAAI,CAAC,CAAC,WAAW;YACzC;gBACE,OAAO,EAAE,GAAG,EAAE,GAAG,IAAI,CAAC,CAAC,wBAAwB;QACnD,CAAC;IACH,CAAC;IAED;;;OAGG;IACH,eAAe,CAAC,SAAiB,EAAE,OAAe;QAChD,MAAM,OAAO,GAAG,IAAI,CAAC,UAAU,CAAC,SAAS,CAAC,CAAC;QAE3C,wDAAwD;QACxD,IAAI,CAAC,OAAO,CAAC,iBAAiB,IAAI,OAAO,CAAC,iBAAiB,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YACzE,OAAO,IAAI,CAAC;QACd,CAAC;QAED,OAAO,OAAO,CAAC,iBAAiB,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC;IACrD,CAAC;CACF;AAED;;GAEG;AACH,MAAM,CAAC,MAAM,oBAAoB,GAAG,IAAI,oBAAoB,EAAE,CAAC"}

package/build/services/springboot-docs-optimized.d.ts

@@ -1,30 +1,41 @@
+import { CacheService } from './cache.js';
+import { WikiDocument } from './boot-wiki.js';
+import { SpringProjectsConfig } from './spring-projects-config.js';
+import { SearchIndex } from './search-index.js';
+import { MigrationProject } from './migration-sources.js';
 /**
- * Clean Spring Boot Documentation Service - uses ONLY real Spring documentation APIs
- * No mock data whatsoever - everything is fetched from actual Spring sources
+ * Spring Documentation Service - Supports multiple Spring projects (Boot, AI, Framework, etc.)
+ * Uses ONLY real Spring documentation APIs - no mock data
+ *
+ * Architecture: Configuration-driven multi-project support via SpringProjectsConfig
  */
 export declare class SpringBootDocsServiceOptimized {
     private readonly baseUrl;
     private readonly springProjectsUrl;
     private readonly springGuideUrl;
-    private readonly springBootVersion;
-    private turndownService;
+    private projectsConfig;
     private cache;
-    private readonly REQUEST_TIMEOUT;
-    private readonly MAX_RETRIES;
-    constructor();
-    /**
-     * Extract content intelligently based on detail level
-     * Preserves code blocks, key sections, and structure
-     */
-    private extractIntelligentContent;
+    private searchIndex;
+    constructor(projectsConfig?: SpringProjectsConfig, cache?: CacheService, searchIndex?: SearchIndex);
+    /** Feeds the full-text index with a page already fetched; never breaks the read path. */
+    private indexPage;
+    /** Re-feeds the index from the cache when a page was evicted or read before the index existed. */
+    private reindexIfMissing;
     /**
      * Search Spring projects with caching and retry logic - REAL API ONLY
      */
     searchSpringProjects(query: string, limit?: number): Promise<any[]>;
+    /**
+     * Get the full markdown of a Spring project page (cached) - REAL API ONLY
+     */
+    getProjectMarkdown(projectName: string): Promise<{
+        markdown: string;
+        url: string;
+    }>;
     /**
      * Get Spring project details - REAL API ONLY
      */
-    getSpringProject(projectName: string): Promise<string>;
+    getSpringProject(projectName: string, offset?: number): Promise<string>;
     /**
      * Get all Spring guides - REAL API ONLY
      */
@@ -34,31 +45,71 @@ export declare class SpringBootDocsServiceOptimized {
      */
     getGuide(guideId: string, detailLevel?: string): Promise<string>;
     /**
-     * Get Spring reference documentation - alias for backward compatibility
+     * Get Spring reference documentation - backward compatibility (defaults to Spring Boot)
+     * @deprecated Use getSpringReference('boot', section) instead
      */
     getReference(section: string, subsection?: string): Promise<string>;
     /**
-     * Get Spring reference documentation - REAL API ONLY
+     * Get Spring reference documentation for any Spring project
+     * Supports: Spring Boot, Spring AI, Spring Framework, and future projects
+     *
+     * @param projectId - Project identifier ('boot', 'ai', 'framework', etc.)
+     * @param section - Documentation section (e.g., 'web', 'chatclient', 'core')
+     * @param subsection - Optional subsection for deeper navigation
+     * @param offset - Character offset for paginated reads
+     * @param version - Optional documentation version ('3.4' or '3.4.2'; omitted/'current' = latest)
+     * @returns Formatted markdown documentation with source URL
+     */
+    getSpringReference(projectId: string, section: string, subsection?: string, offset?: number, version?: string): Promise<string>;
+    /**
+     * Get the Spring Boot migration guide or upgrade release notes from the GitHub wiki
+     *
+     * @param version - Target version ('3.0', '3.4' or '3.4.2'; the patch is ignored)
+     * @param document - 'auto' (migration guide for x.0, release notes otherwise) or an explicit document
+     * @param section - Optional keyword; only matching headings (with sub-sections) are returned
+     * @param offset - Character offset for paginated reads
+     */
+    getMigrationGuide(version: string, document?: 'auto' | WikiDocument, section?: string, offset?: number, project?: MigrationProject): Promise<string>;
+    private fetchBootWikiPage;
+    /** Raw markdown wiki page (Framework, Batch): a missing page is a real 404, an HTML body is never a guide. */
+    private fetchRawWikiPage;
+    private referenceTitle;
+    /**
+     * Format one page of a full markdown document with a pagination footer
      */
-    getSpringReference(section: string, subsection?: string): Promise<string>;
+    private formatPage;
     /**
      * Search Spring concepts - alias for backward compatibility
      */
-    searchConcepts(concept: string, category?: string): Promise<string>;
+    searchConcepts(concept: string, version?: string): Promise<string>;
+    /**
+     * Entry page of the Spring Boot reference documentation: the current docs (legacy URL, unchanged)
+     * or the page of a published version ("3.4" or "3.4.2"; the patch is ignored).
+     */
+    private bootReferenceIndexUrl;
+    private bootVersionNotFound;
     /**
      * Search Spring concepts - using real documentation
+     *
+     * @param version - Optional Spring Boot documentation version ('3.4' or '3.4.2'; omitted/'current' = latest)
      */
-    searchSpringConcepts(concept: string, category?: string): Promise<string>;
+    searchSpringConcepts(concept: string, version?: string): Promise<string>;
     /**
      * Search documentation with real API - alias for backward compatibility
      */
-    searchDocumentation(query: string, docType?: string, limit?: number): Promise<any[]>;
+    searchDocumentation(query: string, docType?: string, limit?: number, version?: string): Promise<any[]>;
     /**
      * Search documentation with real API
+     *
+     * @param version - Optional Spring Boot documentation version for the Boot reference part
+     *   ('3.4' or '3.4.2'; omitted/'current' = latest). Guides and projects are not versioned and ignore it.
      */
-    searchSpringDocs(query: string, docType?: string, limit?: number): Promise<any[]>;
+    searchSpringDocs(query: string, docType?: string, limit?: number, version?: string): Promise<any[]>;
+    private mergeContentResults;
+    private searchTitleSources;
     private searchInReference;
-    private processHtmlGuide;
+    private extractGuideMarkdown;
+    private formatGuide;
     private fetchWithRetry;
 }
 //# sourceMappingURL=springboot-docs-optimized.d.ts.map

package/build/services/springboot-docs-optimized.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"springboot-docs-optimized.d.ts","sourceRoot":"","sources":["../../src/services/springboot-docs-optimized.ts"],"names":[],"mappings":"AAKA;;;GAGG;AACH,qBAAa,8BAA8B;IACzC,OAAO,CAAC,QAAQ,CAAC,OAAO,CAA4B;IACpD,OAAO,CAAC,QAAQ,CAAC,iBAAiB,CAAgC;IAClE,OAAO,CAAC,QAAQ,CAAC,cAAc,CAA8B;IAC7D,OAAO,CAAC,QAAQ,CAAC,iBAAiB,CAAW;IAC7C,OAAO,CAAC,eAAe,CAAkB;IACzC,OAAO,CAAC,KAAK,CAAe;IAC5B,OAAO,CAAC,QAAQ,CAAC,eAAe,CAAS;IACzC,OAAO,CAAC,QAAQ,CAAC,WAAW,CAAK;;IAajC;;;OAGG;IACH,OAAO,CAAC,yBAAyB;IA6DjC;;OAEG;IACG,oBAAoB,CAAC,KAAK,EAAE,MAAM,EAAE,KAAK,GAAE,MAAW;IAkD5D;;OAEG;IACG,gBAAgB,CAAC,WAAW,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAsC5D;;OAEG;IACG,kBAAkB,CAAC,QAAQ,CAAC,EAAE,MAAM,EAAE,KAAK,GAAE,MAAW,GAAG,OAAO,CAAC,GAAG,EAAE,CAAC;IAmD/E;;OAEG;IACG,QAAQ,CAAC,OAAO,EAAE,MAAM,EAAE,WAAW,GAAE,MAAiB,GAAG,OAAO,CAAC,MAAM,CAAC;IAoDhF;;OAEG;IACG,YAAY,CAAC,OAAO,EAAE,MAAM,EAAE,UAAU,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAIzE;;OAEG;IACG,kBAAkB,CAAC,OAAO,EAAE,MAAM,EAAE,UAAU,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAqC/E;;OAEG;IACG,cAAc,CAAC,OAAO,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAIzE;;OAEG;IACG,oBAAoB,CAAC,OAAO,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAkD/E;;OAEG;IACG,mBAAmB,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,GAAE,MAAc,EAAE,KAAK,GAAE,MAAW,GAAG,OAAO,CAAC,GAAG,EAAE,CAAC;IAIrG;;OAEG;IACG,gBAAgB,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,GAAE,MAAc,EAAE,KAAK,GAAE,MAAW,GAAG,OAAO,CAAC,GAAG,EAAE,CAAC;YAoCpF,iBAAiB;IA+B/B,OAAO,CAAC,gBAAgB;YA0BV,cAAc;CA0B7B"}
+{"version":3,"file":"springboot-docs-optimized.d.ts","sourceRoot":"","sources":["../../src/services/springboot-docs-optimized.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,YAAY,EAAE,MAAM,YAAY,CAAC;AAM1C,OAAO,EAAE,YAAY,EAA0G,MAAM,gBAAgB,CAAC;AACtJ,OAAO,EAAE,oBAAoB,EAAwB,MAAM,6BAA6B,CAAC;AACzF,OAAO,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC;AAChD,OAAO,EAAE,gBAAgB,EAAgI,MAAM,wBAAwB,CAAC;AAKxL;;;;;GAKG;AACH,qBAAa,8BAA8B;IACzC,OAAO,CAAC,QAAQ,CAAC,OAAO,CAA4B;IACpD,OAAO,CAAC,QAAQ,CAAC,iBAAiB,CAAgC;IAClE,OAAO,CAAC,QAAQ,CAAC,cAAc,CAA8B;IAC7D,OAAO,CAAC,cAAc,CAAuB;IAC7C,OAAO,CAAC,KAAK,CAAe;IAC5B,OAAO,CAAC,WAAW,CAAc;gBAG/B,cAAc,GAAE,oBAA2C,EAC3D,KAAK,GAAE,YAAiC,EACxC,WAAW,GAAE,WAA+B;IAO9C,yFAAyF;IACzF,OAAO,CAAC,SAAS;IAQjB,kGAAkG;IAClG,OAAO,CAAC,gBAAgB;IAIxB;;OAEG;IACG,oBAAoB,CAAC,KAAK,EAAE,MAAM,EAAE,KAAK,GAAE,MAAW;IAkD5D;;OAEG;IACG,kBAAkB,CAAC,WAAW,EAAE,MAAM,GAAG,OAAO,CAAC;QAAE,QAAQ,EAAE,MAAM,CAAC;QAAC,GAAG,EAAE,MAAM,CAAA;KAAE,CAAC;IAyCzF;;OAEG;IACG,gBAAgB,CAAC,WAAW,EAAE,MAAM,EAAE,MAAM,SAAI,GAAG,OAAO,CAAC,MAAM,CAAC;IAKxE;;OAEG;IACG,kBAAkB,CAAC,QAAQ,CAAC,EAAE,MAAM,EAAE,KAAK,GAAE,MAAW,GAAG,OAAO,CAAC,GAAG,EAAE,CAAC;IAqB/E;;OAEG;IACG,QAAQ,CAAC,OAAO,EAAE,MAAM,EAAE,WAAW,GAAE,MAAiB,GAAG,OAAO,CAAC,MAAM,CAAC;IAoEhF;;;OAGG;IACG,YAAY,CAAC,OAAO,EAAE,MAAM,EAAE,UAAU,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAKzE;;;;;;;;;;OAUG;IACG,kBAAkB,CACtB,SAAS,EAAE,MAAM,EACjB,OAAO,EAAE,MAAM,EACf,UAAU,CAAC,EAAE,MAAM,EACnB,MAAM,SAAI,EACV,OAAO,CAAC,EAAE,MAAM,GACf,OAAO,CAAC,MAAM,CAAC;IA+ElB;;;;;;;OAOG;IACG,iBAAiB,CACrB,OAAO,EAAE,MAAM,EACf,QAAQ,GAAE,MAAM,GAAG,YAAqB,EACxC,OAAO,CAAC,EAAE,MAAM,EAChB,MAAM,SAAI,EACV,OAAO,GAAE,gBAAgC,GACxC,OAAO,CAAC,MAAM,CAAC;YAmCJ,iBAAiB;IAY/B,8GAA8G;YAChG,gBAAgB;IAe9B,OAAO,CAAC,cAAc;IAKtB;;OAEG;IACH,OAAO,CAAC,UAAU;IAalB;;OAEG;IACG,cAAc,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAIxE;;;OAGG;IACH,OAAO,CAAC,qBAAqB;IAM7B,OAAO,CAAC,mBAAmB;IAM3B;;;;OAIG;IACG,oBAAoB,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAoD9E;;OAEG;IACG,mBAAmB,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,GAAE,MAAc,EAAE,KAAK,GAAE,MAAW,EAAE,OAAO,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,EAAE,CAAC;IAIvH;;;;;OAKG;IACG,gBAAgB,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,GAAE,MAAc,EAAE,KAAK,GAAE,MAAW,EAAE,OAAO,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,EAAE,CAAC;IAgBpH,OAAO,CAAC,mBAAmB;YA2Bb,kBAAkB;YA4ClB,iBAAiB;IAqC/B,OAAO,CAAC,oBAAoB;IA8B5B,OAAO,CAAC,WAAW;IAOnB,OAAO,CAAC,cAAc;CAGvB"}