powerplatform-mcp/build/services/solution-service.js

PowerPlatform Model Context Protocol server

/**
 * SolutionService
 *
 * Service for querying solutions, publishers, solution components,
 * exporting solutions, adding components, and publishing customizations.
 */
export class SolutionService {
    client;
    constructor(client) {
        this.client = client;
    }
    /**
     * Get all non-readonly publishers in the environment.
     */
    async getPublishers() {
        return this.client.get('api/data/v9.2/publishers?$filter=isreadonly eq false');
    }
    /**
     * Get all visible solutions, ordered by creation date descending.
     */
    async getSolutions() {
        return this.client.get('api/data/v9.2/solutions?$filter=isvisible eq true&$orderby=createdon desc');
    }
    /**
     * Get a specific solution by its unique name.
     * Returns the first matching solution, or null if not found.
     */
    async getSolution(uniqueName) {
        const result = await this.client.get(`api/data/v9.2/solutions?$filter=uniquename eq '${uniqueName}'&$top=1`);
        return result.value && result.value.length > 0 ? result.value[0] : null;
    }
    /**
     * Get all components in a solution, ordered by component type.
     * First resolves the solution by unique name, then fetches its components.
     */
    async getSolutionComponents(solutionUniqueName) {
        const solution = await this.getSolution(solutionUniqueName);
        if (!solution) {
            throw new Error(`Solution '${solutionUniqueName}' not found`);
        }
        return this.client.get(`api/data/v9.2/solutioncomponents?$filter=_solutionid_value eq ${solution.solutionid}&$orderby=componenttype`);
    }
    /**
     * Export a solution as a base64-encoded package.
     * This is a read-only operation that serializes the solution for download.
     *
     * @param solutionName - The unique name of the solution to export
     * @param managed - Whether to export as a managed solution (default: false)
     */
    async exportSolution(solutionName, managed = false) {
        return this.client.post('api/data/v9.2/ExportSolution', {
            SolutionName: solutionName,
            Managed: managed,
            ExportAutoNumberingSettings: true,
            ExportCalendarSettings: true,
            ExportCustomizationSettings: true,
            ExportEmailTrackingSettings: true,
            ExportGeneralSettings: true,
            ExportMarketingSettings: true,
            ExportOutlookSynchronizationSettings: true,
            ExportRelationshipRoles: true,
            ExportIsvConfig: true,
            ExportSales: true,
            ExportExternalApplications: true,
        });
    }
    /**
     * Add a component to a solution.
     * @param solutionUniqueName The unique name of the target solution
     * @param componentId The GUID of the component
     * @param componentType Dataverse component type code (1=Entity, 2=Attribute, 14=SDKMessageProcessingStep, 61=WebResource, etc.)
     * @param addRequiredComponents Whether to also add required dependencies
     */
    async addSolutionComponent(solutionUniqueName, componentId, componentType, addRequiredComponents = false) {
        return this.client.post('api/data/v9.2/AddSolutionComponent', {
            ComponentId: componentId,
            ComponentType: componentType,
            SolutionUniqueName: solutionUniqueName,
            AddRequiredComponents: addRequiredComponents,
        });
    }
    /**
     * Publish customizations for an entity or all entities.
     * @param entityLogicalName If provided, publishes only this entity. Otherwise publishes all.
     */
    async publishCustomizations(entityLogicalName) {
        if (entityLogicalName) {
            await this.client.post('api/data/v9.2/PublishXml', {
                ParameterXml: `<importexportxml><entities><entity>${entityLogicalName}</entity></entities></importexportxml>`,
            });
        }
        else {
            await this.client.post('api/data/v9.2/PublishAllXml');
        }
    }
}