@microsoft/sp-http-msgraph 1.23.2 → 1.24.0-beta.3

package/lib-esm/MSGraphClientFactory.js

@@ -0,0 +1,94 @@
+import { ServiceKey, _SPKillSwitch } from '@microsoft/sp-core-library';
+import { _QosMonitor } from '@microsoft/sp-diagnostics';
+import MSGraphClient from './MSGraphClient';
+class MSGraphClientFactory {
+    getClient(version, options) {
+        if (!version || version === '1') {
+            // returns a v1 version of MSGraphClient
+            /* eslint-disable-next-line @typescript-eslint/no-explicit-any */ if (!MSGraphClient._instance) {
+                return import(/* webpackChunkName: 'sp-http-msgraphclient' */ '@microsoft/microsoft-graph-clientv1/lib/graph-js-sdk-web').then(()=>{
+                    return new MSGraphClient(this._serviceScope);
+                });
+            } else {
+                return Promise.resolve(new MSGraphClient(this._serviceScope));
+            }
+        } else if (version === '3' && !_SPKillSwitch.isActivated('24401914-15d6-4c3c-aeea-4aace46d5586' /* '01/06/2022', 'use new MSGraphVersion' */ )) {
+            const qosMonitor = new _QosMonitor('MSGraphClientFactory.GetClientV3');
+            // returns a v3 version of MSGraphClient
+            // Should only import once no matter how many times it is called
+            return import(/* webpackChunkName: 'sp-http-msgraphclientv3' */ './MSGraphClientV3').then((msGraphClientV3)=>{
+                // We create a new object every time rather than referencing an existing object in case the service scope changes
+                qosMonitor.writeSuccess({
+                    version: 3,
+                    options: !!options
+                });
+                return new msGraphClientV3.default(this._serviceScope, options, undefined);
+            }).catch((error)=>{
+                qosMonitor.writeUnexpectedFailure('ImportMSGraphV3ChunkFailed', error);
+                throw error;
+            });
+        } else {
+            const errorMessage = 'Not yet implemented.';
+            throw Error(errorMessage);
+        }
+    }
+    /**
+   * Returns an instance of the MSGraphClient that communicates with the current tenant's configurable Service Pricipal.
+   * Allows to specify custom middleware options.
+   *
+   * @param version - The version of the Graph API to use. 3.
+   * @param options - Client options for the Graph API.
+   */ getClientWithMiddleware(version, options) {
+        const qosMonitor = new _QosMonitor('MSGraphClientFactory.GetClientV3WithMiddleware');
+        // returns a v3 version of MSGraphClient
+        // Should only import once no matter how many times it is called
+        return import(/* webpackChunkName: 'sp-http-msgraphclientv3' */ './MSGraphClientV3').then((msGraphClientV3)=>{
+            // We create a new object every time rather than referencing an existing object in case the service scope changes
+            qosMonitor.writeSuccess({
+                version: 3
+            });
+            return new msGraphClientV3.default(this._serviceScope, undefined, options);
+        }).catch((error)=>{
+            qosMonitor.writeUnexpectedFailure('ImportMSGraphV3ChunkFailed', error);
+            throw error;
+        });
+    }
+    /**
+   * Returns a v3 version of MSGraphClient with the 1P App Principal
+   *
+   * @internal
+   *
+   */ getClientInternal(version, options) {
+        const qosMonitor = new _QosMonitor('MSGraphClientFactory.GetInternalClientV3');
+        // Should only import once no matter how many times it is called
+        return import(/* webpackChunkName: 'sp-http-msgraphclientv3' */ './MSGraphClientV3').then((msGraphClientV3)=>{
+            // We create a new object every time rather than referencing an existing object in case the service scope changes
+            qosMonitor.writeSuccess({
+                version: 3,
+                options: !!options
+            });
+            return new msGraphClientV3.default(this._serviceScope, options, undefined, true);
+        }).catch((error)=>{
+            qosMonitor.writeUnexpectedFailure('ImportMSGraphV3ChunkFailed', error);
+            throw error;
+        });
+    }
+    /**
+   * @param serviceScope - Provides services for the MSGraphClient to consume.
+   *
+   * @internal
+   */ constructor(serviceScope){
+        this._serviceScope = serviceScope;
+    }
+}
+/**
+   * The service key for MSGraphClientFactory.
+   */ MSGraphClientFactory.serviceKey = ServiceKey.create('sp-http:MSGraphClientFactory', MSGraphClientFactory);
+/**
+ * Returns a preinitialized version of the MSGraphClient.
+ * For more information: {@link https://docs.microsoft.com/en-us/sharepoint/dev/spfx/use-msgraph}
+ *
+ * @public
+ */ export { MSGraphClientFactory as default };
+
+//# sourceMappingURL=./MSGraphClientFactory.js.map

package/lib-esm/MSGraphClientV3.js

@@ -0,0 +1,190 @@
+import { _ClientManifestData, Validate } from '@microsoft/sp-core-library';
+import { _QosMonitor } from '@microsoft/sp-diagnostics';
+import { Client as _InternalGraphClient, AuthenticationHandler, MiddlewareFactory } from '@msinternal/ms-graph-v3-bundle';
+import { _GraphHttpClientContext, _AadTokenProviders, _SPRequestRateMonitor } from '@microsoft/sp-http-base';
+import { isCustomHostsKSActivated, isPassSdkVersionKSActivated, isRequestRateMonitorKSActivated } from './common/Killswitches';
+import { MSGraphAuthenticationProvider } from './MSGraphAuthenticationProvider';
+class MSGraphClientV3 {
+    /**
+   * All calls to Microsoft Graph are chained together starting with the api function.
+   *
+   * @remarks Path supports the following formats:
+   * * me
+   * * /me
+   * * https://graph.microsoft.com/v1.0/me
+   * * https://graph.microsoft.com/beta/me
+   * * me/events?$filter=startswith(subject, 'ship')
+   *
+   * The authProvider and baseUrl option should not be used, as they have already been
+   * provided by the framework. See the official documentation here:
+   * https://github.com/microsoftgraph/msgraph-sdk-javascript
+   *
+   * @param path - The path for the request to MSGraph.
+   */ api(path) {
+        Validate.isNonemptyString(path, 'path');
+        if (!isRequestRateMonitorKSActivated() && this._requestRateMonitor && this._consumerComponentManifest) {
+            const { componentType, alias, id } = this._consumerComponentManifest;
+            if (componentType === 'WebPart' || componentType === 'AdaptiveCardExtension') {
+                const trackingUrl = path.startsWith('http') ? path : new URL(path.replace(/^\//, ''), MSGraphClientV3._graphBaseUrl).href;
+                this._requestRateMonitor.trackRequest(trackingUrl, `${componentType}.${alias}.${id}`);
+            }
+        }
+        if (this._isInternal) {
+            return MSGraphClientV3._internalInstance.api(path);
+        }
+        return MSGraphClientV3._instance.api(path);
+    }
+    /**
+   * Gets the instance of the instantiated Client object from Microsoft Graph SDK.
+   */ get client() {
+        if (this._isInternal) {
+            return MSGraphClientV3._internalInstance;
+        }
+        return MSGraphClientV3._instance;
+    }
+    _createGraphClientInstance(tokenProvider, options) {
+        const qosMonitor = new _QosMonitor('MSGraphClientV3.CreateGraphClientInstance');
+        let graphClient;
+        try {
+            graphClient = this._createClientInstance({
+                ...options,
+                authProvider: undefined
+            }, tokenProvider, false);
+        } catch (e) {
+            qosMonitor.writeUnexpectedFailure(e.message, e);
+            throw e;
+        }
+        return graphClient;
+    }
+    _createGraphClientInstanceWithMiddleware(tokenProvider, options) {
+        const qosMonitor = new _QosMonitor('MSGraphClientV3.CreateGraphClientInstanceWithMiddleware');
+        let graphClient;
+        try {
+            graphClient = this._createClientInstance(options, tokenProvider, false);
+            qosMonitor.writeSuccess();
+            return graphClient;
+        } catch (e) {
+            qosMonitor.writeUnexpectedFailure(e.message, e);
+            throw e;
+        }
+    }
+    _createInternalGraphClientInstance(tokenProvider, options) {
+        const qosMonitor = new _QosMonitor('MSGraphClientV3.CreateInternalGraphClientInstance');
+        let graphClient;
+        try {
+            graphClient = this._createClientInstance({
+                ...options,
+                authProvider: undefined
+            }, tokenProvider, true);
+        } catch (e) {
+            qosMonitor.writeUnexpectedFailure(e.message, e);
+            throw e;
+        }
+        return graphClient;
+    }
+    _createClientInstance(options, tokenProvider, isInternal) {
+        const clientOptions = options || {};
+        clientOptions.baseUrl = MSGraphClientV3._graphBaseUrl;
+        let middlewareChain;
+        if (!clientOptions.middleware) {
+            // creating default chain
+            middlewareChain = MiddlewareFactory.getDefaultMiddlewareChain(new MSGraphAuthenticationProvider(tokenProvider, MSGraphClientV3._graphBaseUrl, isInternal));
+        } else {
+            // a developer has provided middleware(s)
+            const authMiddleware = new AuthenticationHandler(new MSGraphAuthenticationProvider(tokenProvider, MSGraphClientV3._graphBaseUrl, isInternal));
+            middlewareChain = [
+                authMiddleware
+            ];
+            if (Array.isArray(clientOptions.middleware)) {
+                middlewareChain.push(...clientOptions.middleware);
+            } else {
+                middlewareChain.push(clientOptions.middleware);
+            }
+        }
+        if (!isPassSdkVersionKSActivated() && this._consumerComponentManifest) {
+            if (!clientOptions.fetchOptions) {
+                clientOptions.fetchOptions = {};
+            }
+            if (!clientOptions.fetchOptions.headers) {
+                clientOptions.fetchOptions.headers = {};
+            }
+            const sdkVersionValue = `SPFx/${this._consumerComponentManifest.alias}/${this._consumerComponentManifest.id}/Is3PRequest:${this._consumerComponentManifest.isInternal ? '0' : '1'}`;
+            const { headers } = clientOptions.fetchOptions;
+            if (Array.isArray(headers)) {
+                const sdkVersionHeaderIndex = headers.findIndex((header)=>header[0] === 'SdkVersion');
+                if (sdkVersionHeaderIndex === -1) {
+                    headers.push([
+                        'SdkVersion',
+                        sdkVersionValue
+                    ]);
+                } else {
+                    headers[sdkVersionHeaderIndex][1] += `, ${sdkVersionValue}`;
+                }
+            } else if (headers instanceof Headers) {
+                headers.has('SdkVersion') ? headers.set('SdkVersion', `${headers.get('SdkVersion')}, ${sdkVersionValue}`) : headers.set('SdkVersion', sdkVersionValue);
+            } else {
+                headers.SdkVersion = headers.SdkVersions ? `${headers.SdkVersion}, ${sdkVersionValue}` : sdkVersionValue;
+            }
+        }
+        // we can add more middleware to the end of the chain here
+        clientOptions.middleware = middlewareChain;
+        if (!isCustomHostsKSActivated()) {
+            try {
+                const url = new URL(MSGraphClientV3._graphBaseUrl);
+                clientOptions.customHosts = new Set([
+                    url.host
+                ]);
+            } catch (e) {
+                const qosMonitor = new _QosMonitor('MSGraphClientV3.CustomHostsAdditionsFailed');
+                qosMonitor.writeUnexpectedFailure(e.message, e);
+            }
+        }
+        return _InternalGraphClient.initWithMiddleware(clientOptions);
+    }
+    /**
+   * @param serviceScope - Provides services for the MSGraphClient to consume.
+   *
+   * @internal
+   */ constructor(serviceScope, options, clientOptions, internalClient){
+        this._isInternal = false;
+        serviceScope.whenFinished(()=>{
+            if (!MSGraphClientV3._graphBaseUrl) {
+                MSGraphClientV3._graphBaseUrl = serviceScope.consume(_GraphHttpClientContext.serviceKey).getGraphEndpointUrl();
+            }
+            if (!isPassSdkVersionKSActivated()) {
+                const clientManifestData = serviceScope.consume(_ClientManifestData.serviceKey);
+                this._consumerComponentManifest = clientManifestData.manifest;
+            }
+            if (!isRequestRateMonitorKSActivated()) {
+                this._requestRateMonitor = serviceScope.consume(_SPRequestRateMonitor.serviceKey);
+            }
+            if (internalClient) {
+                this._isInternal = true;
+                if (!MSGraphClientV3._internalInstance) {
+                    MSGraphClientV3._internalInstance = this._createInternalGraphClientInstance(_AadTokenProviders.configurable, options);
+                }
+            } else if (!MSGraphClientV3._instance) {
+                if (clientOptions !== undefined) {
+                    MSGraphClientV3._instance = this._createGraphClientInstanceWithMiddleware(_AadTokenProviders.configurable, clientOptions);
+                } else {
+                    MSGraphClientV3._instance = this._createGraphClientInstance(_AadTokenProviders.configurable, options);
+                }
+            }
+        });
+    }
+}
+/**
+ * MSGraphClient is used to perform REST calls against Microsoft Graph.
+ *
+ * @remarks The Microsoft Graph JavaScript client library is a lightweight wrapper around the
+ * Microsoft Graph API. This class allows developers to start making REST calls to MSGraph without
+ * needing to initialize the the MSGraph client library. If a custom configuration is desired,
+ * the MSGraphClient api function needs to be provided with that custom configuration for
+ * every request.
+ *
+ * For more information: {@link https://github.com/microsoftgraph/msgraph-sdk-javascript}
+ *
+ * @public
+ */ export { MSGraphClientV3 as default };
+
+//# sourceMappingURL=./MSGraphClientV3.js.map

package/{lib → lib-esm}/common/Killswitches.js

@@ -1,17 +1,12 @@
 import { _SPKillSwitch } from '@microsoft/sp-core-library';
 export function isPassSdkVersionKSActivated() {
-    return _SPKillSwitch.isActivated('cf20bd1c-8f94-466b-b394-382640c75c23'
-    /* '04/10/2023', 'aterentiev - Pass SdkVersion header to MS Graph requests'*/
-    );
+    return _SPKillSwitch.isActivated('cf20bd1c-8f94-466b-b394-382640c75c23');
 }
 export function isCustomHostsKSActivated() {
-    return _SPKillSwitch.isActivated('249a915b-2c26-4fe0-a2da-19f8a7b2b56e'
-    /* '09/06/2024', 'grahamc - Add currrent graph endpoint to custom hosts'*/
-    );
+    return _SPKillSwitch.isActivated('249a915b-2c26-4fe0-a2da-19f8a7b2b56e');
 }
 export function isRequestRateMonitorKSActivated() {
-    return _SPKillSwitch.isActivated('c76f25a9-9d5a-4860-8883-fcacc64a0b19'
-    /* '2/25/2026', 'tianbli - Disable request rate monitoring for web parts' */
-    );
+    return _SPKillSwitch.isActivated('c76f25a9-9d5a-4860-8883-fcacc64a0b19');
 }
-//# sourceMappingURL=Killswitches.js.map
+
+//# sourceMappingURL=./Killswitches.js.map

package/{lib → lib-esm}/index.js

@@ -6,7 +6,7 @@
  * the SharePoint Framework.
  *
  * @packagedocumentation
- */
-export { default as MSGraphClient } from './MSGraphClient';
+ */ export { default as MSGraphClient } from './MSGraphClient';
 export { default as MSGraphClientFactory } from './MSGraphClientFactory';
-//# sourceMappingURL=index.js.map
+
+//# sourceMappingURL=./index.js.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@microsoft/sp-http-msgraph",
-  "version": "1.23.2",
+  "version": "1.24.0-beta.3",
   "description": "Microsoft Graph communication layer for the SharePoint Framework",
   "homepage": "http://aka.ms/spfx",
   "license": "https://aka.ms/spfx/license",
@@ -8,32 +8,63 @@
     "tsdocFlavor": "AEDoc"
   },
   "main": "lib-commonjs/index.js",
-  "module": "lib/index.js",
+  "module": "lib-esm/index.js",
   "typings": "dist/index-internal.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index-internal.d.ts",
+      "import": "./lib-esm/index.js",
+      "require": "./lib-commonjs/index.js"
+    },
+    "./lib/*.resx": "./lib-esm/*.resx.json",
+    "./lib/*": {
+      "types": "./lib-dts/*.d.ts",
+      "import": "./lib-esm/*.js",
+      "require": "./lib-commonjs/*.js"
+    },
+    "./lib-commonjs/*.resx": "./lib-esm/*.resx.json",
+    "./lib-commonjs/*": {
+      "types": "./lib-dts/*.d.ts",
+      "import": "./lib-esm/*.js",
+      "require": "./lib-commonjs/*.js"
+    },
+    "./package.json": "./package.json"
+  },
+  "typesVersions": {
+    "*": {
+      "lib/*": [
+        "lib-dts/*"
+      ]
+    }
+  },
   "dependencies": {
     "@microsoft/microsoft-graph-client": "3.0.2",
     "@microsoft/microsoft-graph-clientv1": "npm:@microsoft/microsoft-graph-client@1.7.2-spfx",
     "@swc/helpers": "^0.5.12",
     "tslib": "2.3.1",
-    "@microsoft/sp-core-library": "1.23.2",
-    "@microsoft/sp-diagnostics": "1.23.2",
-    "@microsoft/sp-loader": "1.23.2",
-    "@microsoft/sp-http-base": "1.23.2"
+    "@microsoft/sp-core-library": "1.24.0-beta.3",
+    "@microsoft/sp-http-base": "1.24.0-beta.3",
+    "@microsoft/sp-diagnostics": "1.24.0-beta.3",
+    "@microsoft/sp-loader": "1.24.0-beta.3"
   },
   "devDependencies": {
-    "@rushstack/heft": "1.2.17",
+    "@rushstack/heft": "1.2.22",
     "eslint": "9.37.0",
-    "@microsoft/sp-module-interfaces": "1.23.2",
+    "@msinternal/ms-graph-v3-bundle": "3.0.2",
     "@msinternal/spfx-internal-web-build-rig": "0.1.0",
-    "@msinternal/ms-graph-v3-bundle": "3.0.2"
+    "@microsoft/sp-module-interfaces": "1.24.0-beta.3"
   },
   "scripts": {
     "build": "heft build --clean",
     "clean": "heft clean",
     "deploy": "heft dev-deploy",
     "start": "heft build-watch --serve",
+    "test": "heft test",
+    "test-watch": "heft test-watch",
     "_phase:build": "heft run --only build -- --clean",
     "_phase:build:incremental": "heft run --only build --",
-    "_phase:depscan": "heft depscan"
+    "_phase:depscan": "heft depscan",
+    "_phase:test": "heft run --only test -- --clean",
+    "_phase:test:incremental": "heft run --only test --"
   }
 }