@synergy-design-system/mcp 2.14.1 → 3.0.0

package/dist/build/build.js

@@ -1,35 +0,0 @@
-import ora from 'ora';
-import { buildAssets } from './assets.js';
-import { buildComponents } from './components.js';
-import { buildFonts } from './fonts.js';
-import { buildFrameworkFiles } from './frameworks.js';
-import { buildStaticFiles } from './static.js';
-import { buildTokens } from './tokens.js';
-import { buildStyles } from './styles.js';
-const spinner = ora({
-    prefixText: 'MCP:',
-    text: 'Generating static metadata...',
-});
-const build = async () => {
-    spinner.start();
-    await buildAssets();
-    await buildComponents();
-    await buildFrameworkFiles();
-    await buildFonts();
-    await buildTokens();
-    await buildStyles();
-    // Should be run last as we will copy files where we see fit and paths must exist
-    await buildStaticFiles();
-};
-build()
-    .then(() => {
-    spinner.succeed('Static metadata generated successfully.');
-    process.exit(0);
-})
-    .catch((error) => {
-    spinner.fail(`Failed to generate static metadata. Error: ${error}`);
-    process.exit(1);
-})
-    .finally(() => {
-    spinner.stop();
-});

package/dist/build/components.d.ts

@@ -1,4 +0,0 @@
-/**
- * Sets up all data from the components and framework packages and adds them to the static metadata.
- */
-export declare const buildComponents: () => Promise<void>;

package/dist/build/components.js

@@ -1,133 +0,0 @@
-import { existsSync, mkdirSync } from 'node:fs';
-import { copyFile } from 'node:fs/promises';
-import { basename, join } from 'node:path';
-import { rimraf } from 'rimraf';
-import ora from 'ora';
-import { pascalCase } from 'change-case';
-import { componentPath, componentStaticPath, createPath, getAbsolutePath, } from '../utilities/index.js';
-const directories = {
-    angularPackageDir: getAbsolutePath('../../../../packages/angular'),
-    componentDir: getAbsolutePath('../../../../packages/components'),
-    reactPackageDir: getAbsolutePath('../../../../packages/react'),
-    vuePackageDir: getAbsolutePath('../../../../packages/vue'),
-};
-/**
- * Gets the file list for a specific component.
- * @param component The module to get the file list for.
- * @returns An array of tuples that define file paths related to the component.
- */
-const getComponentFileList = (component) => {
-    const { tagName, tagNameWithoutPrefix, } = component;
-    const staticFiles = [];
-    const vueComponentName = pascalCase([
-        'syn',
-        'vue',
-        tagNameWithoutPrefix,
-    ].join('-'));
-    // Dynamic paths to generated wrappers
-    const angularFile = `${directories.angularPackageDir}/components/${tagNameWithoutPrefix}/${tagNameWithoutPrefix}.component.ts`;
-    const componentFile = `${directories.componentDir}/src/components/${tagNameWithoutPrefix}/${tagNameWithoutPrefix}.component.ts`;
-    const reactFile = `${directories.reactPackageDir}/src/components/${tagNameWithoutPrefix}.ts`;
-    const vueFile = `${directories.vuePackageDir}/src/components/${vueComponentName}.vue`;
-    // Add support for styles
-    const defaultStyleFile = `${directories.componentDir}/src/components/${tagNameWithoutPrefix}/${tagNameWithoutPrefix}.styles.ts`;
-    const customStyleFile = `${directories.componentDir}/src/components/${tagNameWithoutPrefix}/${tagNameWithoutPrefix}.custom.styles.ts`;
-    staticFiles.push([
-        angularFile,
-        'component.angular.ts',
-    ]);
-    staticFiles.push([
-        componentFile,
-        'component.ts',
-    ]);
-    staticFiles.push([
-        reactFile,
-        'component.react.ts',
-    ]);
-    staticFiles.push([
-        vueFile,
-        'component.vue',
-    ]);
-    staticFiles.push([
-        defaultStyleFile,
-        'component.styles.ts',
-    ]);
-    staticFiles.push([
-        customStyleFile,
-        'component.custom.styles.ts',
-    ]);
-    return {
-        componentName: tagName,
-        entries: staticFiles
-            .filter(([fileName]) => existsSync(fileName)),
-    };
-};
-/**
- * Sets up all data from the components and framework packages and adds them to the static metadata.
- */
-export const buildComponents = async () => {
-    const spinner = ora({
-        prefixText: 'Components:',
-        text: 'Generating static metadata...',
-    }).start();
-    try {
-        // Import the custom elements manifest
-        const customElementsManifestImport = await import('@synergy-design-system/components/custom-elements.json', {
-            with: { type: 'json' },
-        });
-        const customElementsManifest = customElementsManifestImport.default?.modules;
-        spinner.text = 'Cleaning up old metadata...';
-        await rimraf(componentPath);
-        spinner.succeed('Old metadata cleaned up.');
-        spinner.text = 'Creating new metadata directory...';
-        // Create the components directory if it doesn't exist
-        await createPath(componentPath);
-        spinner.text = 'Generating components metadata...';
-        // Create and populate the metadata for each component
-        const componentMetadata = customElementsManifest
-            .filter(module => module.declarations && module.declarations.length === 1)
-            .filter(module => module
-            .declarations
-            .some(declaration => declaration.tagName))
-            .map(module => module.declarations[0])
-            .map(getComponentFileList)
-            .flat()
-            .map(({ componentName, entries }) => {
-            const absoluteComponentPath = join(componentPath, componentName);
-            // Create the component directory if it doesn't exist
-            if (!existsSync(absoluteComponentPath)) {
-                mkdirSync(absoluteComponentPath, { recursive: true });
-            }
-            return entries.map(([source, target]) => {
-                const targetFileName = join(absoluteComponentPath, target);
-                return copyFile(source, targetFileName);
-            });
-        });
-        // eslint-disable-next-line @typescript-eslint/await-thenable
-        await Promise.all(componentMetadata);
-        spinner.succeed('Components metadata generated successfully.');
-        spinner.text = 'Generating static metadata...';
-        if (!existsSync(componentStaticPath)) {
-            mkdirSync(componentStaticPath, { recursive: true });
-        }
-        const staticFiles = [
-            'README.md',
-            'CHANGELOG.md',
-            'LIMITATIONS.md',
-        ]
-            .map(staticFile => join(getAbsolutePath('../../../../packages/components'), staticFile))
-            .filter(existsSync)
-            .map(staticFile => {
-            const base = basename(staticFile);
-            const target = join(componentStaticPath, base);
-            return copyFile(staticFile, target);
-        });
-        await Promise.all(staticFiles);
-        spinner.succeed('Static metadata generated successfully.');
-        spinner.succeed('Generation of metadata generated successfully.');
-    }
-    catch (error) {
-        spinner.fail(`Failed to generate components metadata. Error: ${error}`);
-        throw error;
-    }
-};

package/dist/build/fonts.d.ts

@@ -1,4 +0,0 @@
-/**
- * Sets up all wanted data from the fonts package and adds it to the static metadata.
- */
-export declare const buildFonts: () => Promise<void>;

package/dist/build/fonts.js

@@ -1,49 +0,0 @@
-import { existsSync } from 'node:fs';
-import { copyFile } from 'node:fs/promises';
-import { basename, join } from 'node:path';
-import { rimraf } from 'rimraf';
-import ora from 'ora';
-import { createPath, fontsPath, getAbsolutePath, } from '../utilities/index.js';
-/**
- * List of relative paths to files that should be copied to the static metadata directory.
- */
-const staticFilesToCopy = [
-    'README.md',
-    'CHANGELOG.md',
-    'package.json',
-].map(file => ([
-    getAbsolutePath(`../../../../packages/fonts/${file}`),
-    join(fontsPath, ''),
-]));
-/**
- * Sets up all wanted data from the fonts package and adds it to the static metadata.
- */
-export const buildFonts = async () => {
-    const spinner = ora({
-        prefixText: 'Fonts:',
-        text: 'Generating static metadata...',
-    }).start();
-    try {
-        spinner.text = 'Cleaning up old metadata...';
-        await rimraf(fontsPath);
-        spinner.succeed('Old metadata cleaned up.');
-        spinner.text = 'Creating new metadata directory...';
-        // Create the fonts directory if it doesn't exist
-        await createPath(fontsPath);
-        spinner.succeed('New metadata directory created.');
-        spinner.text = 'Copying files to metadata directory...';
-        const staticFiles = staticFilesToCopy
-            .filter(file => existsSync(file.at(0)))
-            .map(async ([staticFile, target]) => {
-            await createPath(target);
-            return copyFile(staticFile, join(target, basename(staticFile)));
-        });
-        await Promise.all(staticFiles);
-        spinner.succeed('Framework metadata generated successfully.');
-        spinner.succeed('Generation of metadata generated successfully.');
-    }
-    catch (error) {
-        spinner.fail(`Failed to generate fonts metadata. Error: ${error}`);
-        throw error; // Re-throw to handle it in the calling function
-    }
-};

package/dist/build/frameworks.d.ts

@@ -1,4 +0,0 @@
-/**
- * Sets up all static data from the supported frameworks.
- */
-export declare const buildFrameworkFiles: () => Promise<void>;

package/dist/build/frameworks.js

@@ -1,61 +0,0 @@
-import { existsSync } from 'node:fs';
-import { copyFile } from 'node:fs/promises';
-import { basename, join } from 'node:path';
-import ora from 'ora';
-import { angularPath, createPath, getAbsolutePath, reactPath, vuePath, } from '../utilities/index.js';
-/**
- * List of static files that should be copied to the static metadata directory.
- */
-const staticFilesToCopy = [
-    // Angular specific documentation
-    [
-        getAbsolutePath('../../../../packages/angular/README.md'),
-        angularPath,
-    ],
-    [
-        getAbsolutePath('../../../../packages/angular/LIMITATIONS.md'),
-        angularPath,
-    ],
-    // React specific documentation
-    [
-        getAbsolutePath('../../../../packages/react/README.md'),
-        reactPath,
-    ],
-    [
-        getAbsolutePath('../../../../packages/react/LIMITATIONS.md'),
-        reactPath,
-    ],
-    // Vue specific documentation
-    [
-        getAbsolutePath('../../../../packages/vue/README.md'),
-        vuePath,
-    ],
-    [
-        getAbsolutePath('../../../../packages/vue/LIMITATIONS.md'),
-        vuePath,
-    ],
-];
-/**
- * Sets up all static data from the supported frameworks.
- */
-export const buildFrameworkFiles = async () => {
-    const spinner = ora({
-        prefixText: 'Framework files:',
-        text: 'Generating framework metadata...',
-    }).start();
-    try {
-        const staticFiles = staticFilesToCopy
-            .filter(file => existsSync(file.at(0)))
-            .map(async ([staticFile, target]) => {
-            await createPath(target);
-            return copyFile(staticFile, join(target, basename(staticFile)));
-        });
-        await Promise.all(staticFiles);
-        spinner.succeed('Framework metadata generated successfully.');
-        spinner.succeed('Generation of metadata generated successfully.');
-    }
-    catch (error) {
-        spinner.fail(`Failed to generate framework metadata. Error: ${error}`);
-        throw error;
-    }
-};

package/dist/build/static.d.ts

@@ -1,4 +0,0 @@
-/**
- * Sets up all data from the components and framework packages and adds them to the static metadata.
- */
-export declare const buildStaticFiles: () => Promise<void>;

package/dist/build/static.js

@@ -1,65 +0,0 @@
-import { existsSync } from 'node:fs';
-import { copyFile, readdir } from 'node:fs/promises';
-import { basename, join } from 'node:path';
-import ora from 'ora';
-import { componentMigrationPath, createPath, getAbsolutePath, setupPath, staticMigrationPath, } from '../utilities/index.js';
-/**
- * List of static files that should be copied to the static metadata directory.
- */
-const staticFilesToCopy = [
-    // The icon usage documentation needs to be copied to the static metadata directory
-    [
-        getAbsolutePath('../../../../packages/docs/src/static/icon-usage.md'),
-        setupPath,
-    ],
-    // Copy prerequisites as it includes information about font setup
-    [
-        getAbsolutePath('../../../../packages/docs/src/static/prerequisites.md'),
-        setupPath,
-    ],
-    // Copy the migration guide
-    [
-        getAbsolutePath('../../../../packages/components/BREAKING_CHANGES.md'),
-        componentMigrationPath,
-    ],
-];
-/**
- * Sets up all data from the components and framework packages and adds them to the static metadata.
- */
-export const buildStaticFiles = async () => {
-    const spinner = ora({
-        prefixText: 'Static files:',
-        text: 'Generating static metadata...',
-    }).start();
-    try {
-        // Create the wanted directories if they don't exist
-        const createAllPaths = Promise.all(staticFilesToCopy.map(([, target]) => createPath(target)));
-        await createAllPaths;
-        const staticFiles = staticFilesToCopy
-            .filter(file => existsSync(file.at(0)))
-            .map(([staticFile, target]) => {
-            const targetFileName = join(target, basename(staticFile));
-            return copyFile(staticFile, targetFileName);
-        });
-        await Promise.all(staticFiles);
-        // Copy all migration guides from the docs package into the static
-        // migration metadata directory so they can be consumed by the MCP server.
-        const migrationSourceDir = getAbsolutePath('../../../../packages/docs/src/static/migration');
-        if (existsSync(migrationSourceDir)) {
-            await createPath(staticMigrationPath);
-            const migrationFiles = await readdir(migrationSourceDir);
-            const migrationCopies = migrationFiles.map((file) => {
-                const source = join(migrationSourceDir, file);
-                const target = join(staticMigrationPath, file);
-                return copyFile(source, target);
-            });
-            await Promise.all(migrationCopies);
-        }
-        spinner.succeed('Static metadata generated successfully.');
-        spinner.succeed('Generation of metadata generated successfully.');
-    }
-    catch (error) {
-        spinner.fail(`Failed to generate components metadata. Error: ${error}`);
-        throw error;
-    }
-};

package/dist/build/styles.d.ts

@@ -1,4 +0,0 @@
-/**
- * Sets up all wanted data from the styles package and adds it to the static metadata.
- */
-export declare const buildStyles: () => Promise<void>;

package/dist/build/styles.js

@@ -1,58 +0,0 @@
-import fs from 'node:fs/promises';
-import { fileURLToPath } from 'url';
-import path from 'path';
-import { globby } from 'globby';
-import { rimraf } from 'rimraf';
-import ora from 'ora';
-import { createPath, stylesPath, } from '../utilities/index.js';
-/**
- * List of relative paths to files that should be copied to the static metadata directory.
- */
-const filesToCopy = [
-    'README.md',
-    'CHANGELOG.md',
-    'BREAKING_CHANGES.md',
-    'dist/*.css',
-];
-/**
- * Sets up all wanted data from the styles package and adds it to the static metadata.
- */
-export const buildStyles = async () => {
-    const spinner = ora({
-        prefixText: 'Styles:',
-        text: 'Generating static metadata...',
-    }).start();
-    try {
-        spinner.text = 'Cleaning up old metadata...';
-        await rimraf(stylesPath);
-        spinner.succeed('Old metadata cleaned up.');
-        spinner.text = 'Creating new metadata directory...';
-        // Create the styles directory if it doesn't exist
-        await createPath(stylesPath);
-        spinner.succeed('New metadata directory created.');
-        spinner.text = 'Copying files to metadata directory...';
-        // Get the module's root directory
-        // Note that the default export resolves to dist/index.css,
-        // so we need to go up one level to get to the root of the package!
-        const moduleUrl = import.meta.resolve('@synergy-design-system/styles');
-        const modulePath = fileURLToPath(moduleUrl);
-        const moduleDir = path.join(path.dirname(modulePath), '../');
-        // Process the files (placeholder for actual logic)
-        const contents = await globby(filesToCopy, {
-            cwd: moduleDir,
-            onlyFiles: true,
-        });
-        // Write the files to the tokens directory into a flat structure
-        const copies = contents.map(file => {
-            const sourcePath = path.join(moduleDir, file);
-            const destPath = path.join(stylesPath, path.basename(file));
-            return fs.copyFile(sourcePath, destPath);
-        });
-        await Promise.all(copies);
-        spinner.succeed('Styles metadata generated successfully.');
-    }
-    catch (error) {
-        spinner.fail(`Failed to generate styles metadata. Error: ${error}`);
-        throw error; // Re-throw to handle it in the calling function
-    }
-};

package/dist/build/tokens.d.ts

@@ -1,4 +0,0 @@
-/**
- * Sets up all wanted data from the tokens package and adds it to the static metadata.
- */
-export declare const buildTokens: () => Promise<void>;

package/dist/build/tokens.js

@@ -1,59 +0,0 @@
-import fs from 'node:fs/promises';
-import { fileURLToPath } from 'url';
-import path from 'path';
-import { globby } from 'globby';
-import { rimraf } from 'rimraf';
-import ora from 'ora';
-import { createPath, tokensPath, } from '../utilities/index.js';
-/**
- * List of relative paths to files that should be copied to the static metadata directory.
- */
-const filesToCopy = [
-    'README.md',
-    'CHANGELOG.md',
-    'BREAKING_CHANGES.md',
-    'dist/js/*.js',
-    'dist/themes/*.css',
-];
-/**
- * Sets up all wanted data from the tokens package and adds it to the static metadata.
- */
-export const buildTokens = async () => {
-    const spinner = ora({
-        prefixText: 'Tokens:',
-        text: 'Generating static metadata...',
-    }).start();
-    try {
-        spinner.text = 'Cleaning up old metadata...';
-        await rimraf(tokensPath);
-        spinner.succeed('Old metadata cleaned up.');
-        spinner.text = 'Creating new metadata directory...';
-        // Create the tokens directory if it doesn't exist
-        await createPath(tokensPath);
-        spinner.succeed('New metadata directory created.');
-        spinner.text = 'Copying files to metadata directory...';
-        // Get the module's root directory
-        // Note that the default export resolves to dist/js/index.js,
-        // so we need to go up two levels to get to the root of the package!
-        const moduleUrl = import.meta.resolve('@synergy-design-system/tokens');
-        const modulePath = fileURLToPath(moduleUrl);
-        const moduleDir = path.join(path.dirname(modulePath), '../../');
-        // Process the files (placeholder for actual logic)
-        const contents = await globby(filesToCopy, {
-            cwd: moduleDir,
-            onlyFiles: true,
-        });
-        // Write the files to the tokens directory into a flat structure
-        const copies = contents.map(file => {
-            const sourcePath = path.join(moduleDir, file);
-            const destPath = path.join(tokensPath, path.basename(file));
-            return fs.copyFile(sourcePath, destPath);
-        });
-        await Promise.all(copies);
-        spinner.succeed('Tokens metadata generated successfully.');
-    }
-    catch (error) {
-        spinner.fail(`Failed to generate tokens metadata. Error: ${error}`);
-        throw error; // Re-throw to handle it in the calling function
-    }
-};

package/dist/tools/davinci-migration.d.ts

@@ -1,3 +0,0 @@
-import type { McpServer } from '@modelcontextprotocol/sdk/server/mcp.js';
-export declare const davinciMigrateComponentList: (server: McpServer) => void;
-export declare const davinciMigrateComponentTool: (server: McpServer) => void;

package/dist/tools/davinci-migration.js

@@ -1,66 +0,0 @@
-import { z } from 'zod';
-import { getStructuredMetaData, metaDataPath } from '../utilities/index.js';
-const data = getStructuredMetaData(`${metaDataPath}/davinci-migration`);
-export const davinciMigrateComponentList = (server) => {
-    server.registerTool('davinci-migrate-list', {
-        description: 'Get a list of all components that have migration information from DaVinci to Synergy.',
-        title: 'DaVinci Migration List',
-    }, async () => {
-        const metadata = await data; // Ensure metadata is loaded
-        if (!metadata || metadata.length === 0) {
-            return {
-                content: [
-                    {
-                        text: `No migration information found for components! Please ensure the metadata files are present in the ${metaDataPath}/davinci-migration directory.`,
-                        type: 'text',
-                    },
-                ],
-            };
-        }
-        // Extract all h3 headings that start with 'davinci-'
-        const matches = Array.from(metadata.at(0).content.matchAll(/^### (davinci-[\w-]+)/gm)).map(match => `- ${match[1].replace('### ', '')}`);
-        return {
-            content: [
-                {
-                    text: `Migration information was found for the following components: ${matches.join(', ')}`,
-                    type: 'text',
-                },
-            ],
-        };
-    });
-};
-export const davinciMigrateComponentTool = (server) => {
-    server.registerTool('davinci-migrate-component', {
-        description: 'Get information about the migration of a specific component from DaVinci to Synergy.',
-        inputSchema: {
-            component: z.string().startsWith('davinci-').describe('The name of the davinci component to get migration information about.'),
-        },
-        title: 'DaVinci Migration Info',
-    }, async ({ component }) => {
-        const metadata = await data; // Ensure metadata is loaded
-        if (!metadata || metadata.length === 0) {
-            return {
-                content: [
-                    {
-                        text: `No migration information found for components! Please ensure the metadata files are present in the ${metaDataPath}/davinci-migration directory.`,
-                        type: 'text',
-                    },
-                ],
-            };
-        }
-        // Only process the the parts of the migration guide we are interested in
-        const regex = new RegExp(`^### ${component.replace(/[-/\\^$*+?.()|[\]{}]/g, '\\$&')}[\\s\\S]*?(?=^### |\\Z)`, 'm');
-        const match = metadata.at(0).content.match(regex);
-        const text = match
-            ? `Migration information for ${component}: ${match.at(0)}`
-            : `No migration information found for component ${component}. Here is some common migration information: ${JSON.stringify(metadata, null, 2)}`;
-        return {
-            content: [
-                {
-                    text,
-                    type: 'text',
-                },
-            ],
-        };
-    });
-};

package/dist/tools/font-info.d.ts

@@ -1,6 +0,0 @@
-import type { McpServer } from '@modelcontextprotocol/sdk/server/mcp.js';
-/**
- * Simple tool to retrieve information about the fonts used in the Synergy Design System.
- * @param server - The MCP server instance to register the tool on.
- */
-export declare const fontInfoTool: (server: McpServer) => void;

package/dist/tools/font-info.js

@@ -1,35 +0,0 @@
-import { getFontsMetaData, getStructuredMetaData, } from '../utilities/index.js';
-/**
- * Simple tool to retrieve information about the fonts used in the Synergy Design System.
- * @param server - The MCP server instance to register the tool on.
- */
-export const fontInfoTool = (server) => {
-    server.registerTool('font-info', {
-        description: 'Get the list of used fonts and their setup for the Synergy Design System.',
-        title: 'Font Information',
-    }, async () => {
-        const aiRules = await getStructuredMetaData('../../metadata/static/fonts');
-        const fontsData = await getFontsMetaData((fileName) => !fileName.toLowerCase().startsWith('changelog'));
-        return {
-            content: [
-                {
-                    text: 'Available fonts in the Synergy Design System:',
-                    type: 'text',
-                },
-                {
-                    text: JSON.stringify([
-                        {
-                            text: JSON.stringify(aiRules, null, 2),
-                            type: 'text',
-                        },
-                    ], null, 2),
-                    type: 'text',
-                },
-                {
-                    text: JSON.stringify(fontsData, null, 2),
-                    type: 'text',
-                },
-            ],
-        };
-    });
-};

package/dist/tools/framework-info.d.ts

@@ -1,7 +0,0 @@
-import type { McpServer } from '@modelcontextprotocol/sdk/server/mcp.js';
-/**
- * Simple tool to list all available components in the Synergy Design System.
- * This tool fetches the component data from the Synergy package and formats it for display.
- * @param server - The MCP server instance to register the tool on.
- */
-export declare const frameworkInfoTool: (server: McpServer) => void;