refactor(search): centralize pf search, get resources

* options.defaults, refactor for initial pf versions
* pf.getResources, api prep, centralize all pf related data
* pf.helpers, pf versions from options, disable findClosestPFVersion
* pf.search, refactor, centralize pf search

Author: cdcabrera

jest.config.ts

@@ -32,7 +32,10 @@ export default {
           {
             ...tsConfig,
             diagnostics: {
-              ignoreCodes: [1343]
+              // See codes https://github.com/Microsoft/TypeScript/blob/main/src/compiler/diagnosticMessages.json
+              // 1324 - Dynamic imports only support a second argument when the '--module' option is...
+              // 1343 - The 'import.meta' meta-property is only allowed when the '--module' option is...
+              ignoreCodes: [1324, 1343]
             },
             astTransformers: {
               before: [

src/__tests__/__snapshots__/options.defaults.test.ts.snap

@@ -34,8 +34,18 @@ exports[`options defaults should return specific properties: defaults 1`] = `
     "availableResourceVersions": [
       "6.0.0",
     ],
+    "availableSchemasVersions": [
+      "v6",
+    ],
+    "availableSearchVersions": [
+      "current",
+      "latest",
+      "v6",
+    ],
     "default": {
-      "defaultVersion": "6.0.0",
+      "latestSchemasVersion": "v6",
+      "latestSemVer": "6.0.0",
+      "latestVersion": "v6",
       "versionStrategy": "highest",
       "versionWhitelist": [
         "@patternfly/react-core",

src/__tests__/__snapshots__/patternFly.getResources.test.ts.snap

@@ -0,0 +1,48 @@
+// Jest Snapshot v1, https://jestjs.io/docs/snapshot-testing
+
+exports[`getPatternFlyMcpResources should return multiple organized facets: properties 1`] = `
+[
+  "availableVersions",
+  "availableSchemasVersions",
+  "enumeratedVersions",
+  "envSemVer",
+  "envVersion",
+  "latestVersion",
+  "latestSchemasVersion",
+  "isEnvTheLatestVersion",
+  "isEnvTheLatestSchemasVersion",
+  "resources",
+  "docsIndex",
+  "componentsIndex",
+  "keywordsIndex",
+  "isFallbackDocumentation",
+  "pathIndex",
+  "byPath",
+  "byUri",
+  "byVersion",
+  "byVersionComponentNames",
+]
+`;
+
+exports[`getPatternFlyReactComponentNames should return multiple organized facets: properties 1`] = `
+[
+  "byVersion",
+  "componentNamesIndex",
+  "componentNamesWithSchemasIndex",
+  "componentNamesWithSchemasMap",
+]
+`;
+
+exports[`setCategoryDisplayLabel should normalize categories and apply linking markdown, accessibility 1`] = `"Accessibility"`;
+
+exports[`setCategoryDisplayLabel should normalize categories and apply linking markdown, design 1`] = `"Design Guidelines"`;
+
+exports[`setCategoryDisplayLabel should normalize categories and apply linking markdown, empty string 1`] = `"Documentation"`;
+
+exports[`setCategoryDisplayLabel should normalize categories and apply linking markdown, example 1`] = `"Examples"`;
+
+exports[`setCategoryDisplayLabel should normalize categories and apply linking markdown, guidelines 1`] = `"AI Guidance"`;
+
+exports[`setCategoryDisplayLabel should normalize categories and apply linking markdown, null 1`] = `"Documentation"`;
+
+exports[`setCategoryDisplayLabel should normalize categories and apply linking markdown, undefined 1`] = `"Documentation"`;

src/__tests__/__snapshots__/patternFly.search.test.ts.snap

@@ -0,0 +1,9 @@
+// Jest Snapshot v1, https://jestjs.io/docs/snapshot-testing
+
+exports[`searchPatternFly should return an array of search results: keys 1`] = `
+[
+  "isSearchWildCardAll",
+  "firstExactMatch",
+  "exactMatches",
+]
+`;

src/__tests__/patternFly.getResources.test.ts

@@ -0,0 +1,109 @@
+import {
+  setCategoryDisplayLabel,
+  getPatternFlyComponentSchema,
+  getPatternFlyReactComponentNames,
+  getPatternFlyMcpResources
+} from '../patternFly.getResources';
+
+describe('setCategoryDisplayLabel', () => {
+  it.each([
+    {
+      description: 'empty string',
+      entry: ''
+    },
+    {
+      description: 'undefined',
+      entry: undefined
+    },
+    {
+      description: 'null',
+      entry: null
+    },
+    {
+      description: 'design',
+      entry: {
+        displayName: 'Lorem Ipsum',
+        section: 'components',
+        category: 'design-guidelines',
+        path: 'https://www.patternfly.org/v6/components/lorem-ipsum/design-guidelines'
+      }
+    },
+    {
+      description: 'accessibility',
+      entry: {
+        displayName: 'Dolor Sit',
+        section: 'components',
+        category: 'accessibility',
+        path: 'https://www.patternfly.org/v6/components/dolor-sit/accessibility'
+      }
+    },
+    {
+      description: 'example',
+      entry: {
+        displayName: 'Lorem Sit',
+        section: 'components',
+        category: 'react',
+        path: 'https://www.patternfly.org/v6/components/lorem-sit/components'
+      }
+    },
+    {
+      description: 'guidelines',
+      entry:
+        {
+          displayName: 'Sit Sit',
+          section: 'guidelines',
+          category: 'react',
+          path: 'documentation:components/sit-sit/guidelines.md'
+        }
+    }
+  ])('should normalize categories and apply linking markdown, $description', ({ entry }) => {
+    expect(setCategoryDisplayLabel(entry as any)).toMatchSnapshot();
+  });
+});
+
+describe('getPatternFlyComponentSchema', () => {
+  it.each([
+    {
+      description: 'default',
+      componentName: 'Button',
+      expected: true
+    },
+    {
+      description: 'unknown component',
+      componentName: 'Lorem',
+      expected: false
+    }
+  ])('should attempt to return a schema', async ({ componentName, expected }) => {
+    const output = await getPatternFlyComponentSchema(componentName);
+
+    expect(Boolean(output)).toBe(expected);
+  });
+
+  it('should have a memoized property', () => {
+    expect(getPatternFlyComponentSchema).toHaveProperty('memo');
+  });
+});
+
+describe('getPatternFlyReactComponentNames', () => {
+  it('should return multiple organized facets', async () => {
+    const result = await getPatternFlyReactComponentNames();
+
+    expect(Object.keys(result)).toMatchSnapshot('properties');
+  });
+
+  it('should have a memoized property', () => {
+    expect(getPatternFlyReactComponentNames).toHaveProperty('memo');
+  });
+});
+
+describe('getPatternFlyMcpResources', () => {
+  it('should return multiple organized facets', async () => {
+    const result = await getPatternFlyMcpResources();
+
+    expect(Object.keys(result)).toMatchSnapshot('properties');
+  });
+
+  it('should have a memoized property', async () => {
+    expect(getPatternFlyMcpResources).toHaveProperty('memo');
+  });
+});

src/__tests__/patternFly.helpers.test.ts

@@ -1,4 +1,4 @@
-import { findClosestPatternFlyVersion } from '../patternFly.helpers';
+import { disabled_findClosestPatternFlyVersion } from '../patternFly.helpers';
 import { readLocalFileFunction } from '../server.getResources';
 import { DEFAULT_OPTIONS } from '../options.defaults';
 
@@ -24,7 +24,7 @@ describe('findClosestPatternFlyVersion', () => {
       expected: '6.0.0'
     }
   ])('should return default version if no package.json is found, $description', async ({ path, expected }) => {
-    const version = await findClosestPatternFlyVersion(path as any);
+    const version = await disabled_findClosestPatternFlyVersion(path as any);
 
     expect(version).toBe(expected);
   });
@@ -143,11 +143,11 @@ describe('findClosestPatternFlyVersion', () => {
     }));
 
     // Use the PF MCP package.json so we can override with "mockReadLocalFile". Override available resource versions.
-    const version = await findClosestPatternFlyVersion(process.cwd(), {
+    const version = await disabled_findClosestPatternFlyVersion(process.cwd(), {
       ...DEFAULT_OPTIONS,
       patternflyOptions: {
         ...DEFAULT_OPTIONS.patternflyOptions,
-        availableResourceVersions: ['4.0.0', '5.0.0', '6.0.0']
+        availableResourceVersions: ['4.0.0', '5.0.0', '6.0.0'] as any
       }
     });
 

src/__tests__/patternFly.search.test.ts

@@ -0,0 +1,20 @@
+import { searchPatternFly } from '../patternFly.search';
+
+describe('searchPatternFly', () => {
+  it('should return an array of search results', async () => {
+    const { searchResults, ...rest } = await searchPatternFly('*', { allowWildCardAll: true });
+
+    expect(searchResults.length).toBeGreaterThan(0);
+    expect(Object.keys(rest)).toMatchSnapshot('keys');
+  });
+
+  it('should find a suffix match', async () => {
+    const { searchResults } = await searchPatternFly('utton');
+
+    expect(searchResults.filter(({ matchType }) => matchType === 'suffix')).toEqual([
+      expect.objectContaining({
+        item: expect.stringContaining('utton')
+      })
+    ]);
+  });
+});

src/options.defaults.ts

@@ -20,6 +20,9 @@ import { type ToolModule } from './server.toolsUser';
  * @property maxSearchLength - Maximum length for search strings.
  * @property recommendedMaxDocsToLoad - Recommended maximum number of docs to load.
  * @property {typeof MODE_LEVELS} mode - Specifies the mode of operation.
+ *    - `cli`: Command-line interface mode.
+ *    - `programmatic`: Programmatic interaction mode where the application is used as a library or API.
+ *    - `test`: Testing or debugging mode.
  * @property {ModeOptions} modeOptions - Mode-specific options.
  * @property name - Name of the package.
  * @property nodeVersion - Node.js major version.
@@ -159,18 +162,27 @@ interface ModeOptions {
 /**
  * PatternFly-specific options.
  *
- * @property availableResourceVersions List of intended available PatternFly resource versions to the MCP server.
+ * @property availableResourceVersions List of available PatternFly resource versions to the MCP server.
+ * @property availableSearchVersions List of available PatternFly search versions to the MCP server.
+ * @property availableSchemasVersions List of available PatternFly schema versions to the MCP server.
  * @property default Default specific options.
- * @property default.defaultVersion Default PatternFly version.
+ * @property default.latestSemVer Default PatternFly `SemVer` major version (e.g., '6.0.0').
+ * @property default.latestVersion Default PatternFly `tag` major version, used for display and file paths (e.g., 'v6').
+ * @property default.latestSchemasVersion Default PatternFly `tag` major version, used for schemas.
  * @property default.versionWhitelist List of mostly reliable dependencies to scan for when detecting the PatternFly version.
  * @property default.versionStrategy Strategy to use when multiple PatternFly versions are detected.
  *    - 'highest': Use the highest major version found.
  *    - 'lowest': Use the lowest major version found.
  */
 interface PatternFlyOptions {
-  availableResourceVersions: string[];
+  availableResourceVersions: ('6.0.0')[];
+  // availableSearchVersions: ('current' | 'detected' | 'latest' | 'v3' | 'v4' | 'v5' | 'v6')[];
+  availableSearchVersions: ('current' | 'detected' | 'latest' | 'v6')[];
+  availableSchemasVersions: ('v6')[];
   default: {
-    defaultVersion: string;
+    latestSemVer: '6.0.0';
+    latestVersion: 'v6';
+    latestSchemasVersion: 'v6';
     versionWhitelist: string[];
     versionStrategy: 'highest' | 'lowest';
   }
@@ -349,8 +361,12 @@ const LOG_BASENAME = 'pf-mcp:log';
  */
 const PATTERNFLY_OPTIONS: PatternFlyOptions = {
   availableResourceVersions: ['6.0.0'],
+  availableSearchVersions: ['current', 'latest', 'v6'],
+  availableSchemasVersions: ['v6'],
   default: {
-    defaultVersion: '6.0.0',
+    latestSemVer: '6.0.0',
+    latestVersion: 'v6',
+    latestSchemasVersion: 'v6',
     versionWhitelist: [
       '@patternfly/react-core',
       '@patternfly/patternfly'
@@ -366,11 +382,6 @@ const URL_REGEX = /^(https?:)\/\//i;
 
 /**
  * Available operational modes for the MCP server.
- *
- * Each mode represents an operational domain:
- * - `cli`: Command-line interface mode.
- * - `programmatic`: Programmatic interaction mode where the application is used as a library or API.
- * - `test`: Testing or debugging mode.
  */
 const MODE_LEVELS: DefaultOptions['mode'][] = ['cli', 'programmatic', 'test'];