@mcp-consultant-tools/sharepoint 1.0.0

package/build/SharePointService.d.ts

@@ -0,0 +1,171 @@
+/**
+ * SharePoint Online Service
+ *
+ * Provides read-only access to SharePoint Online sites, document libraries, and files
+ * through Microsoft Graph API with comprehensive PowerPlatform validation capabilities.
+ *
+ * Authentication: Microsoft Entra ID (OAuth 2.0) via MSAL
+ * API: Microsoft Graph API v1.0
+ * Primary Use Case: PowerPlatform-SharePoint integration validation
+ */
+import type { SharePointConfig, SharePointSiteConfig, SiteInfo, DriveInfo, ItemInfo, FolderTree, SearchResult, ConnectionTestResult, ValidationResult, MigrationVerification, SharePointDocumentLocation } from './types/sharepoint-types.js';
+export type { SharePointConfig, SharePointSiteConfig, SiteInfo, DriveInfo, ItemInfo, FolderTree, SearchResult, ConnectionTestResult, ValidationResult, MigrationVerification, SharePointDocumentLocation, };
+/**
+ * SharePoint Online Service
+ *
+ * Manages authentication, caching, and API requests to SharePoint Online via Graph API.
+ * Follows established patterns from ApplicationInsightsService and LogAnalyticsService.
+ */
+export declare class SharePointService {
+    private config;
+    private msalClient;
+    private accessToken;
+    private tokenExpirationTime;
+    private graphClient;
+    private cache;
+    private siteIdCache;
+    private readonly graphBaseUrl;
+    constructor(config: SharePointConfig);
+    /**
+     * Get an access token for Microsoft Graph API (Entra ID auth)
+     * Implements 5-minute token buffer before expiry (follows ApplicationInsightsService pattern)
+     */
+    private getAccessToken;
+    /**
+     * Initialize Graph Client with MSAL token provider
+     */
+    private getGraphClient;
+    /**
+     * Get active sites
+     */
+    getActiveSites(): SharePointSiteConfig[];
+    /**
+     * Get all sites (including inactive)
+     */
+    getAllSites(): SharePointSiteConfig[];
+    /**
+     * Get site configuration by ID
+     */
+    getSiteById(siteId: string): SharePointSiteConfig;
+    /**
+     * Generate cache key for caching API responses
+     * Format: {method}:{siteId}:{resource}:{params}
+     */
+    private getCacheKey;
+    /**
+     * Get cached value if not expired
+     */
+    private getCached;
+    /**
+     * Set cached value with TTL
+     */
+    private setCached;
+    /**
+     * Clear cache (all entries or by pattern/siteId)
+     */
+    clearCache(pattern?: string, siteId?: string): number;
+    /**
+     * Resolve SharePoint site URL to Graph API site ID
+     * Format: {hostname},{site-collection-id},{web-id}
+     * Example: contoso.sharepoint.com,00000000-0000-0000-0000-000000000000,11111111-1111-1111-1111-111111111111
+     */
+    private resolveSiteId;
+    /**
+     * Sanitize error messages (remove sensitive information like tokens)
+     */
+    private sanitizeErrorMessage;
+    /**
+     * Handle errors with user-friendly messages
+     */
+    private handleError;
+    /**
+     * Test connection to a SharePoint site
+     */
+    testConnection(siteId: string): Promise<ConnectionTestResult>;
+    /**
+     * Get site information
+     */
+    getSiteInfo(siteId: string): Promise<SiteInfo>;
+    /**
+     * List drives (document libraries) in a site
+     */
+    listDrives(siteId: string): Promise<DriveInfo[]>;
+    /**
+     * Get drive (document library) information
+     */
+    getDriveInfo(siteId: string, driveId: string): Promise<DriveInfo>;
+    /**
+     * List items (files/folders) in a drive or folder
+     */
+    listItems(siteId: string, driveId: string, folderId?: string): Promise<ItemInfo[]>;
+    /**
+     * Get item (file/folder) by ID
+     */
+    getItem(siteId: string, driveId: string, itemId: string): Promise<ItemInfo>;
+    /**
+     * Get item by path (relative to drive root)
+     */
+    getItemByPath(siteId: string, driveId: string, path: string): Promise<ItemInfo>;
+    /**
+     * Search items in a drive or site
+     */
+    searchItems(siteId: string, query: string, driveId?: string, limit?: number): Promise<SearchResult>;
+    /**
+     * Get recent items in a drive
+     */
+    getRecentItems(siteId: string, driveId: string, limit?: number, days?: number): Promise<ItemInfo[]>;
+    /**
+     * Get folder structure (recursive)
+     */
+    getFolderStructure(siteId: string, driveId: string, folderId?: string, depth?: number): Promise<FolderTree>;
+    /**
+     * Build folder tree recursively
+     */
+    private buildFolderTree;
+    /**
+     * Get CRM document locations from PowerPlatform
+     *
+     * Queries the sharepointdocumentlocation entity in Dataverse to retrieve
+     * document location configurations for validation.
+     *
+     * @param powerPlatformService PowerPlatformService instance for querying Dataverse
+     * @param entityName Optional entity logical name to filter by (e.g., 'account', 'contact')
+     * @param recordId Optional record ID to filter by specific record
+     * @returns Array of SharePoint document location records
+     */
+    getCrmDocumentLocations(powerPlatformService: any, entityName?: string, recordId?: string): Promise<SharePointDocumentLocation[]>;
+    /**
+     * Validate a document location configuration
+     *
+     * Validates that a PowerPlatform document location configuration matches
+     * the actual SharePoint site structure. Checks:
+     * - Site exists and is accessible
+     * - Folder exists at the specified path
+     * - Folder is accessible
+     * - File count and empty folder detection
+     *
+     * @param powerPlatformService PowerPlatformService instance
+     * @param documentLocationId GUID of the sharepointdocumentlocation record
+     * @returns Validation result with status, issues, and recommendations
+     */
+    validateDocumentLocation(powerPlatformService: any, documentLocationId: string): Promise<ValidationResult>;
+    /**
+     * Verify document migration between two SharePoint locations
+     *
+     * Compares file counts, sizes, and names between source and target folders
+     * to verify successful migration.
+     *
+     * @param powerPlatformService PowerPlatformService instance (unused but kept for consistency)
+     * @param sourceSiteId Source SharePoint site ID
+     * @param sourcePath Source folder path
+     * @param targetSiteId Target SharePoint site ID
+     * @param targetPath Target folder path
+     * @returns Migration verification result with comparison details
+     */
+    verifyDocumentMigration(powerPlatformService: any, sourceSiteId: string, sourcePath: string, targetSiteId: string, targetPath: string): Promise<MigrationVerification>;
+    /**
+     * Close service and clear resources
+     */
+    close(): Promise<void>;
+}
+//# sourceMappingURL=SharePointService.d.ts.map

package/build/SharePointService.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"SharePointService.d.ts","sourceRoot":"","sources":["../src/SharePointService.ts"],"names":[],"mappings":"AAAA;;;;;;;;;GASG;AAMH,OAAO,KAAK,EACV,gBAAgB,EAChB,oBAAoB,EACpB,QAAQ,EACR,SAAS,EACT,QAAQ,EACR,UAAU,EACV,YAAY,EAEZ,oBAAoB,EACpB,gBAAgB,EAChB,qBAAqB,EACrB,0BAA0B,EAC3B,MAAM,6BAA6B,CAAC;AAGrC,YAAY,EACV,gBAAgB,EAChB,oBAAoB,EACpB,QAAQ,EACR,SAAS,EACT,QAAQ,EACR,UAAU,EACV,YAAY,EACZ,oBAAoB,EACpB,gBAAgB,EAChB,qBAAqB,EACrB,0BAA0B,GAC3B,CAAC;AAEF;;;;;GAKG;AACH,qBAAa,iBAAiB;IAC5B,OAAO,CAAC,MAAM,CAAmB;IACjC,OAAO,CAAC,UAAU,CAA8C;IAChE,OAAO,CAAC,WAAW,CAAuB;IAC1C,OAAO,CAAC,mBAAmB,CAAa;IACxC,OAAO,CAAC,WAAW,CAAuB;IAG1C,OAAO,CAAC,KAAK,CAA2C;IACxD,OAAO,CAAC,WAAW,CAAkC;IAErD,OAAO,CAAC,QAAQ,CAAC,YAAY,CAAsC;gBAEvD,MAAM,EAAE,gBAAgB;IAoBpC;;;OAGG;YACW,cAAc;IAsC5B;;OAEG;YACW,cAAc;IAgB5B;;OAEG;IACH,cAAc,IAAI,oBAAoB,EAAE;IAIxC;;OAEG;IACH,WAAW,IAAI,oBAAoB,EAAE;IAIrC;;OAEG;IACH,WAAW,CAAC,MAAM,EAAE,MAAM,GAAG,oBAAoB;IAgBjD;;;OAGG;IACH,OAAO,CAAC,WAAW;IAKnB;;OAEG;IACH,OAAO,CAAC,SAAS;IAejB;;OAEG;IACH,OAAO,CAAC,SAAS;IAMjB;;OAEG;IACH,UAAU,CAAC,OAAO,CAAC,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,MAAM,GAAG,MAAM;IA8CrD;;;;OAIG;YACW,aAAa;IAuD3B;;OAEG;IACH,OAAO,CAAC,oBAAoB;IAgB5B;;OAEG;IACH,OAAO,CAAC,WAAW;IAyCnB;;OAEG;IACG,cAAc,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,oBAAoB,CAAC;IAyCnE;;OAEG;IACG,WAAW,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,QAAQ,CAAC;IA6DpD;;OAEG;IACG,UAAU,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,SAAS,EAAE,CAAC;IAoDtD;;OAEG;IACG,YAAY,CAAC,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,SAAS,CAAC;IAmDvE;;OAEG;IACG,SAAS,CAAC,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,QAAQ,EAAE,CAAC;IA6CxF;;OAEG;IACG,OAAO,CAAC,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,QAAQ,CAAC;IAyCjF;;OAEG;IACG,aAAa,CAAC,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,QAAQ,CAAC;IA4CrF;;OAEG;IACG,WAAW,CAAC,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,YAAY,CAAC;IAmDzG;;OAEG;IACG,cAAc,CAAC,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,QAAQ,EAAE,CAAC;IAmDzG;;OAEG;IACG,kBAAkB,CAAC,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,UAAU,CAAC;IAyCjH;;OAEG;YACW,eAAe;IAkC7B;;;;;;;;;;OAUG;IACG,uBAAuB,CAC3B,oBAAoB,EAAE,GAAG,EACzB,UAAU,CAAC,EAAE,MAAM,EACnB,QAAQ,CAAC,EAAE,MAAM,GAChB,OAAO,CAAC,0BAA0B,EAAE,CAAC;IA4FxC;;;;;;;;;;;;;OAaG;IACG,wBAAwB,CAC5B,oBAAoB,EAAE,GAAG,EACzB,kBAAkB,EAAE,MAAM,GACzB,OAAO,CAAC,gBAAgB,CAAC;IA0O5B;;;;;;;;;;;;OAYG;IACG,uBAAuB,CAC3B,oBAAoB,EAAE,GAAG,EACzB,YAAY,EAAE,MAAM,EACpB,UAAU,EAAE,MAAM,EAClB,YAAY,EAAE,MAAM,EACpB,UAAU,EAAE,MAAM,GACjB,OAAO,CAAC,qBAAqB,CAAC;IAoJjC;;OAEG;IACG,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC;CAQ7B"}