@microsoft/sp-http-msgraph 1.22.0-beta.1 → 1.22.0-beta.3

package/lib/MSGraphClient.d.ts

@@ -0,0 +1,124 @@
+import type { GraphRequestCallback, Options, URLComponents } from '@microsoft/microsoft-graph-clientv1';
+import { type ServiceScope } from '@microsoft/sp-core-library';
+/**
+ * Represents the global singleton object on the window after loading the MS Graph SDK
+ * @internal
+ */
+export interface IMSGraphClientModule {
+    init(options: Options): IMSGraphClient;
+}
+/**
+ * Interface for the MSGraphClient.
+ * @privateRemarks
+ * The original typings cause a build error with webpack.
+ *
+ * @internal
+ */
+export interface IMSGraphClient {
+    config: Options;
+    api(path: string): IGraphRequest;
+}
+/**
+ * Interface for working with MSGraphClient
+ * @internal
+ */
+export interface IWindowWithMSGraphSDK extends Window {
+    MicrosoftGraph: {
+        Client: IMSGraphClientModule;
+    } | undefined;
+}
+/**
+ * Typings for the GraphRequest Object
+ * For more information: {@link https://github.com/microsoftgraph/msgraph-sdk-javascript}
+ *
+ * @privateRemarks
+ * The original typings include references to polyfills.
+ * Exporting the microsoft-graph-client defined class may add unnecessary code to the build.
+ * Thefore, we export this interface as `GraphRequest` with the desired API described.
+ *
+ * @public
+ */
+export interface IGraphRequest {
+    config: Options;
+    urlComponents: URLComponents;
+    _headers: {
+        [key: string]: string | number;
+    };
+    _responseType: string;
+    constructor(config: Options, path: string): IGraphRequest;
+    header(headerKey: string, headerValue: string): this;
+    headers(headers: {
+        [key: string]: string | number;
+    }): this;
+    parsePath(rawPath: string): void;
+    buildFullUrl(): string;
+    version(v: string): IGraphRequest;
+    select(properties: string | string[]): IGraphRequest;
+    expand(properties: string | string[]): IGraphRequest;
+    orderby(properties: string | string[]): IGraphRequest;
+    filter(filterStr: string): IGraphRequest;
+    top(n: number): IGraphRequest;
+    skip(n: number): IGraphRequest;
+    skipToken(token: string): IGraphRequest;
+    count(count: boolean): IGraphRequest;
+    responseType(responseType: string): IGraphRequest;
+    delete(callback?: GraphRequestCallback): Promise<any>;
+    patch(content: any, callback?: GraphRequestCallback): Promise<any>;
+    post(content: any, callback?: GraphRequestCallback): Promise<any>;
+    put(content: any, callback?: GraphRequestCallback): Promise<any>;
+    create(content: any, callback?: GraphRequestCallback): Promise<any>;
+    update(content: any, callback?: GraphRequestCallback): Promise<any>;
+    del(callback?: GraphRequestCallback): Promise<any>;
+    get(callback?: GraphRequestCallback): Promise<any>;
+    getStream(callback: GraphRequestCallback): void;
+    putStream(stream: any, callback: GraphRequestCallback): void;
+    query(queryDictionaryOrString: string | {
+        [key: string]: string | number;
+    }): IGraphRequest;
+}
+/**
+ * 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 default class MSGraphClient {
+    private static _instance;
+    private static _window;
+    private static _originalConfig;
+    private static _graphBaseUrl;
+    /**
+     * @param serviceScope - Provides services for the MSGraphClient to consume.
+     *
+     * @internal
+     */
+    constructor(serviceScope: ServiceScope);
+    /**
+     * 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.
+     * @param config - Sets the configuration for this request.
+     */
+    api(path: string, config?: Options): IGraphRequest;
+    private _createGraphClientInstance;
+    private _getOAuthToken;
+}
+//# sourceMappingURL=MSGraphClient.d.ts.map

package/lib/MSGraphClient.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"MSGraphClient.d.ts","sourceRoot":"","sources":["../src/MSGraphClient.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,oBAAoB,EAAE,OAAO,EAAE,aAAa,EAAE,MAAM,qCAAqC,CAAC;AACxG,OAAO,EAAE,KAAK,YAAY,EAAY,MAAM,4BAA4B,CAAC;AAKzE;;;GAGG;AACH,MAAM,WAAW,oBAAoB;IACnC,IAAI,CAAC,OAAO,EAAE,OAAO,GAAG,cAAc,CAAC;CACxC;AAED;;;;;;GAMG;AACH,MAAM,WAAW,cAAc;IAC7B,MAAM,EAAE,OAAO,CAAC;IAChB,GAAG,CAAC,IAAI,EAAE,MAAM,GAAG,aAAa,CAAC;CAClC;AAED;;;GAGG;AACH,MAAM,WAAW,qBAAsB,SAAQ,MAAM;IACnD,cAAc,EAAE;QAAE,MAAM,EAAE,oBAAoB,CAAA;KAAE,GAAG,SAAS,CAAC;CAC9D;AAED;;;;;;;;;;GAUG;AACH,MAAM,WAAW,aAAa;IAE5B,MAAM,EAAE,OAAO,CAAC;IAChB,aAAa,EAAE,aAAa,CAAC;IAC7B,QAAQ,EAAE;QACR,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,CAAC;KAChC,CAAC;IACF,aAAa,EAAE,MAAM,CAAC;IAEtB,WAAW,CAAC,MAAM,EAAE,OAAO,EAAE,IAAI,EAAE,MAAM,GAAG,aAAa,CAAC;IAC1D,MAAM,CAAC,SAAS,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IACrD,OAAO,CAAC,OAAO,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,CAAA;KAAE,GAAG,IAAI,CAAC;IAC3D,SAAS,CAAC,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;IACjC,YAAY,IAAI,MAAM,CAAC;IACvB,OAAO,CAAC,CAAC,EAAE,MAAM,GAAG,aAAa,CAAC;IAClC,MAAM,CAAC,UAAU,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,aAAa,CAAC;IACrD,MAAM,CAAC,UAAU,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,aAAa,CAAC;IACrD,OAAO,CAAC,UAAU,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,aAAa,CAAC;IACtD,MAAM,CAAC,SAAS,EAAE,MAAM,GAAG,aAAa,CAAC;IACzC,GAAG,CAAC,CAAC,EAAE,MAAM,GAAG,aAAa,CAAC;IAC9B,IAAI,CAAC,CAAC,EAAE,MAAM,GAAG,aAAa,CAAC;IAC/B,SAAS,CAAC,KAAK,EAAE,MAAM,GAAG,aAAa,CAAC;IACxC,KAAK,CAAC,KAAK,EAAE,OAAO,GAAG,aAAa,CAAC;IACrC,YAAY,CAAC,YAAY,EAAE,MAAM,GAAG,aAAa,CAAC;IAClD,MAAM,CAAC,QAAQ,CAAC,EAAE,oBAAoB,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC;IACtD,KAAK,CAAC,OAAO,EAAE,GAAG,EAAE,QAAQ,CAAC,EAAE,oBAAoB,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC;IACnE,IAAI,CAAC,OAAO,EAAE,GAAG,EAAE,QAAQ,CAAC,EAAE,oBAAoB,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC;IAClE,GAAG,CAAC,OAAO,EAAE,GAAG,EAAE,QAAQ,CAAC,EAAE,oBAAoB,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC;IACjE,MAAM,CAAC,OAAO,EAAE,GAAG,EAAE,QAAQ,CAAC,EAAE,oBAAoB,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC;IACpE,MAAM,CAAC,OAAO,EAAE,GAAG,EAAE,QAAQ,CAAC,EAAE,oBAAoB,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC;IACpE,GAAG,CAAC,QAAQ,CAAC,EAAE,oBAAoB,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC;IACnD,GAAG,CAAC,QAAQ,CAAC,EAAE,oBAAoB,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC;IACnD,SAAS,CAAC,QAAQ,EAAE,oBAAoB,GAAG,IAAI,CAAC;IAChD,SAAS,CAAC,MAAM,EAAE,GAAG,EAAE,QAAQ,EAAE,oBAAoB,GAAG,IAAI,CAAC;IAC7D,KAAK,CACH,uBAAuB,EACnB,MAAM,GACN;QACE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,CAAC;KAChC,GACJ,aAAa,CAAC;CAElB;AAED;;;;;;;;;;;;GAYG;AACH,MAAM,CAAC,OAAO,OAAO,aAAa;IAChC,OAAO,CAAC,MAAM,CAAC,SAAS,CAAiB;IACzC,OAAO,CAAC,MAAM,CAAC,OAAO,CAA8E;IACpG,OAAO,CAAC,MAAM,CAAC,eAAe,CAAU;IACxC,OAAO,CAAC,MAAM,CAAC,aAAa,CAAS;IAErC;;;;OAIG;gBACgB,YAAY,EAAE,YAAY;IAW7C;;;;;;;;;;;;;;;;OAgBG;IACI,GAAG,CAAC,IAAI,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,OAAO,GAAG,aAAa;IAOzD,OAAO,CAAC,0BAA0B;IA8BlC,OAAO,CAAC,cAAc;CAavB"}

package/lib/MSGraphClient.js

@@ -0,0 +1,104 @@
+import { __assign } from "tslib";
+import { Validate } from '@microsoft/sp-core-library';
+import { _QosMonitor } from '@microsoft/sp-diagnostics';
+import { _GraphHttpClientContext, _AadTokenProviders } from '@microsoft/sp-http-base';
+import strings from './SPHttpMsGraphStrings.resx';
+/**
+ * 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
+ */
+var MSGraphClient = /** @class */ (function () {
+    /**
+     * @param serviceScope - Provides services for the MSGraphClient to consume.
+     *
+     * @internal
+     */
+    function MSGraphClient(serviceScope) {
+        var _this = this;
+        serviceScope.whenFinished(function () {
+            MSGraphClient._graphBaseUrl = serviceScope
+                .consume(_GraphHttpClientContext.serviceKey)
+                .getGraphEndpointUrl();
+            if (!MSGraphClient._instance) {
+                MSGraphClient._instance = _this._createGraphClientInstance(_AadTokenProviders.configurable);
+            }
+        });
+    }
+    /**
+     * 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.
+     * @param config - Sets the configuration for this request.
+     */
+    MSGraphClient.prototype.api = function (path, config) {
+        Validate.isNonemptyString(path, 'path');
+        MSGraphClient._instance.config = __assign(__assign({}, MSGraphClient._originalConfig), (config || {}));
+        return MSGraphClient._instance.api(path);
+    };
+    MSGraphClient.prototype._createGraphClientInstance = function (tokenProvider) {
+        var _this = this;
+        var graphClientModule;
+        if (!(MSGraphClient._window.MicrosoftGraph && MSGraphClient._window.MicrosoftGraph.Client)) {
+            throw new Error(strings.graphClientInitializationError);
+        }
+        else {
+            // Workaround needed to interact with the Client object.
+            // See https://github.com/microsoftgraph/msgraph-sdk-javascript/issues/47 for more details
+            graphClientModule = MSGraphClient._window.MicrosoftGraph.Client;
+            // Removing window variable reference to MSGraphJsSdk object
+            MSGraphClient._window.MicrosoftGraph = undefined;
+        }
+        var graphClient = graphClientModule.init({
+            authProvider: function (done) {
+                _this._getOAuthToken(tokenProvider)
+                    .then(function (token) {
+                    done(undefined /** error object */, token);
+                })
+                    .catch(function (e) {
+                    // The IGraphRequest functions will return a rejected promise if it fails to get an OAuth2Token.
+                    done(e, '');
+                });
+            },
+            baseUrl: MSGraphClient._graphBaseUrl
+        });
+        MSGraphClient._originalConfig = graphClient.config;
+        return graphClient;
+    };
+    MSGraphClient.prototype._getOAuthToken = function (tokenProvider) {
+        var qosMonitor = new _QosMonitor('MSGraphClient.FetchGraphToken');
+        return tokenProvider
+            .getToken(MSGraphClient._graphBaseUrl)
+            .then(function (response) {
+            qosMonitor.writeSuccess();
+            return response;
+        })
+            .catch(function (error) {
+            qosMonitor.writeUnexpectedFailure(error.message, error);
+            throw error;
+        });
+    };
+    MSGraphClient._window = window;
+    return MSGraphClient;
+}());
+export default MSGraphClient;
+//# sourceMappingURL=MSGraphClient.js.map

package/lib/MSGraphClientFactory.d.ts

@@ -0,0 +1,55 @@
+import type { ClientOptions, Options } from '@microsoft/microsoft-graph-client';
+import { ServiceKey, type ServiceScope } from '@microsoft/sp-core-library';
+import MSGraphClient from './MSGraphClient';
+import type MSGraphClientV3 from './MSGraphClientV3';
+/**
+ * Returns a preinitialized version of the MSGraphClient.
+ * For more information: {@link https://docs.microsoft.com/en-us/sharepoint/dev/spfx/use-msgraph}
+ *
+ * @public
+ */
+export default class MSGraphClientFactory {
+    /**
+     * The service key for MSGraphClientFactory.
+     */
+    static readonly serviceKey: ServiceKey<MSGraphClientFactory>;
+    private _serviceScope;
+    /**
+     * @param serviceScope - Provides services for the MSGraphClient to consume.
+     *
+     * @internal
+     */
+    constructor(serviceScope: ServiceScope);
+    /**
+     * Returns an instance of the MSGraphClient that communicates with the current tenant's configurable
+     * Service Principal. Returns version 1 by default.
+     *
+     * @internal
+     *
+     * @remarks
+     * This method is deprecated marked as internal for backward compatibility
+     */
+    getClient(): Promise<MSGraphClient>;
+    /**
+     * Returns an instance of version 3 the MSGraphClient V3 that communicates with the current tenant's configurable
+     * Service Principal.
+     *
+     */
+    getClient(version: '3'): Promise<MSGraphClientV3>;
+    /**
+     * 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: '3', options: ClientOptions): Promise<MSGraphClientV3>;
+    /**
+     * Returns a v3 version of MSGraphClient with the 1P App Principal
+     *
+     * @internal
+     *
+     */
+    getClientInternal(version: '3', options?: Options): Promise<MSGraphClientV3>;
+}
+//# sourceMappingURL=MSGraphClientFactory.d.ts.map

package/lib/MSGraphClientFactory.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"MSGraphClientFactory.d.ts","sourceRoot":"","sources":["../src/MSGraphClientFactory.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,aAAa,EAAE,OAAO,EAAE,MAAM,mCAAmC,CAAC;AAChF,OAAO,EAAE,UAAU,EAAE,KAAK,YAAY,EAAiB,MAAM,4BAA4B,CAAC;AAE1F,OAAO,aAAa,MAAM,iBAAiB,CAAC;AAC5C,OAAO,KAAK,eAAe,MAAM,mBAAmB,CAAC;AAIrD;;;;;GAKG;AACH,MAAM,CAAC,OAAO,OAAO,oBAAoB;IACvC;;OAEG;IACH,gBAAuB,UAAU,EAAE,UAAU,CAAC,oBAAoB,CAAC,CAC6B;IAEhG,OAAO,CAAC,aAAa,CAAe;IAEpC;;;;OAIG;gBACgB,YAAY,EAAE,YAAY;IAI7C;;;;;;;;OAQG;IACI,SAAS,IAAI,OAAO,CAAC,aAAa,CAAC;IAE1C;;;;OAIG;IACI,SAAS,CAAC,OAAO,EAAE,GAAG,GAAG,OAAO,CAAC,eAAe,CAAC;IAwCxD;;;;;;OAMG;IACI,uBAAuB,CAAC,OAAO,EAAE,GAAG,EAAE,OAAO,EAAE,aAAa,GAAG,OAAO,CAAC,eAAe,CAAC;IAgB9F;;;;;OAKG;IACI,iBAAiB,CAAC,OAAO,EAAE,GAAG,EAAE,OAAO,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,eAAe,CAAC;CAcpF"}

package/lib/MSGraphClientFactory.js

@@ -0,0 +1,106 @@
+import { ServiceKey, _SPKillSwitch } from '@microsoft/sp-core-library';
+import { _QosMonitor } from '@microsoft/sp-diagnostics';
+import MSGraphClient from './MSGraphClient';
+/**
+ * Returns a preinitialized version of the MSGraphClient.
+ * For more information: {@link https://docs.microsoft.com/en-us/sharepoint/dev/spfx/use-msgraph}
+ *
+ * @public
+ */
+var MSGraphClientFactory = /** @class */ (function () {
+    /**
+     * @param serviceScope - Provides services for the MSGraphClient to consume.
+     *
+     * @internal
+     */
+    function MSGraphClientFactory(serviceScope) {
+        this._serviceScope = serviceScope;
+    }
+    MSGraphClientFactory.prototype.getClient = function (version, options) {
+        var _this = this;
+        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(function () {
+                    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' */)) {
+            var qosMonitor_1 = 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(function (msGraphClientV3) {
+                // We create a new object every time rather than referencing an existing object in case the service scope changes
+                qosMonitor_1.writeSuccess({ version: 3, options: !!options });
+                return new msGraphClientV3.default(_this._serviceScope, options, undefined);
+            })
+                .catch(function (error) {
+                qosMonitor_1.writeUnexpectedFailure('ImportMSGraphV3ChunkFailed', error);
+                throw error;
+            });
+        }
+        else {
+            var 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.
+     */
+    MSGraphClientFactory.prototype.getClientWithMiddleware = function (version, options) {
+        var _this = this;
+        var 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(function (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(function (error) {
+            qosMonitor.writeUnexpectedFailure('ImportMSGraphV3ChunkFailed', error);
+            throw error;
+        });
+    };
+    /**
+     * Returns a v3 version of MSGraphClient with the 1P App Principal
+     *
+     * @internal
+     *
+     */
+    MSGraphClientFactory.prototype.getClientInternal = function (version, options) {
+        var _this = this;
+        var 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(function (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(function (error) {
+            qosMonitor.writeUnexpectedFailure('ImportMSGraphV3ChunkFailed', error);
+            throw error;
+        });
+    };
+    /**
+     * The service key for MSGraphClientFactory.
+     */
+    MSGraphClientFactory.serviceKey = ServiceKey.create('sp-http:MSGraphClientFactory', MSGraphClientFactory);
+    return MSGraphClientFactory;
+}());
+export default MSGraphClientFactory;
+//# sourceMappingURL=MSGraphClientFactory.js.map

package/lib/MSGraphClientV3.d.ts

@@ -0,0 +1,54 @@
+import { type ServiceScope } from '@microsoft/sp-core-library';
+import type { ClientOptions, GraphRequest, Options, Client } from '@microsoft/microsoft-graph-client';
+/**
+ * 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 default class MSGraphClientV3 {
+    private static _instance;
+    private static _internalInstance;
+    private static _graphBaseUrl;
+    private _isInternal;
+    private _consumerComponentManifest;
+    /**
+     * @param serviceScope - Provides services for the MSGraphClient to consume.
+     *
+     * @internal
+     */
+    constructor(serviceScope: ServiceScope, options: Options | undefined, clientOptions: ClientOptions | undefined, internalClient?: boolean);
+    /**
+     * 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: string): GraphRequest;
+    /**
+     * Gets the instance of the instantiated Client object from Microsoft Graph SDK.
+     */
+    get client(): Client;
+    private _createGraphClientInstance;
+    private _createGraphClientInstanceWithMiddleware;
+    private _createInternalGraphClientInstance;
+    private _createClientInstance;
+}
+//# sourceMappingURL=MSGraphClientV3.d.ts.map

package/lib/MSGraphClientV3.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"MSGraphClientV3.d.ts","sourceRoot":"","sources":["../src/MSGraphClientV3.ts"],"names":[],"mappings":"AAAA,OAAO,EAAuB,KAAK,YAAY,EAAY,MAAM,4BAA4B,CAAC;AAE9F,OAAO,KAAK,EACV,aAAa,EACb,YAAY,EACZ,OAAO,EACP,MAAM,EAEP,MAAM,mCAAmC,CAAC;AAgB3C;;;;;;;;;;;;GAYG;AACH,MAAM,CAAC,OAAO,OAAO,eAAe;IAClC,OAAO,CAAC,MAAM,CAAC,SAAS,CAAS;IACjC,OAAO,CAAC,MAAM,CAAC,iBAAiB,CAAS;IACzC,OAAO,CAAC,MAAM,CAAC,aAAa,CAAS;IAErC,OAAO,CAAC,WAAW,CAAkB;IACrC,OAAO,CAAC,0BAA0B,CAA2C;IAE7E;;;;OAIG;gBAED,YAAY,EAAE,YAAY,EAC1B,OAAO,EAAE,OAAO,GAAG,SAAS,EAC5B,aAAa,EAAE,aAAa,GAAG,SAAS,EACxC,cAAc,CAAC,EAAE,OAAO;IAsC1B;;;;;;;;;;;;;;;OAeG;IACI,GAAG,CAAC,IAAI,EAAE,MAAM,GAAG,YAAY;IAQtC;;OAEG;IACH,IAAW,MAAM,IAAI,MAAM,CAK1B;IAED,OAAO,CAAC,0BAA0B;IAqBlC,OAAO,CAAC,wCAAwC;IAmBhD,OAAO,CAAC,kCAAkC;IAoB1C,OAAO,CAAC,qBAAqB;CAyE9B"}

package/lib/MSGraphClientV3.js

@@ -0,0 +1,194 @@
+import { __assign } from "tslib";
+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 } from '@microsoft/sp-http-base';
+import { isCustomHostsKSActivated, isPassSdkVersionKSActivated } from './common/Killswitches';
+import { MSGraphAuthenticationProvider } from './MSGraphAuthenticationProvider';
+/**
+ * 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
+ */
+var MSGraphClientV3 = /** @class */ (function () {
+    /**
+     * @param serviceScope - Provides services for the MSGraphClient to consume.
+     *
+     * @internal
+     */
+    function MSGraphClientV3(serviceScope, options, clientOptions, internalClient) {
+        var _this = this;
+        this._isInternal = false;
+        serviceScope.whenFinished(function () {
+            if (!MSGraphClientV3._graphBaseUrl) {
+                MSGraphClientV3._graphBaseUrl = serviceScope
+                    .consume(_GraphHttpClientContext.serviceKey)
+                    .getGraphEndpointUrl();
+            }
+            if (!isPassSdkVersionKSActivated()) {
+                var clientManifestData = serviceScope.consume(_ClientManifestData.serviceKey);
+                _this._consumerComponentManifest = clientManifestData.manifest;
+            }
+            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);
+                }
+            }
+        });
+    }
+    /**
+     * 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.
+     */
+    MSGraphClientV3.prototype.api = function (path) {
+        Validate.isNonemptyString(path, 'path');
+        if (this._isInternal) {
+            return MSGraphClientV3._internalInstance.api(path);
+        }
+        return MSGraphClientV3._instance.api(path);
+    };
+    Object.defineProperty(MSGraphClientV3.prototype, "client", {
+        /**
+         * Gets the instance of the instantiated Client object from Microsoft Graph SDK.
+         */
+        get: function () {
+            if (this._isInternal) {
+                return MSGraphClientV3._internalInstance;
+            }
+            return MSGraphClientV3._instance;
+        },
+        enumerable: false,
+        configurable: true
+    });
+    MSGraphClientV3.prototype._createGraphClientInstance = function (tokenProvider, options) {
+        var qosMonitor = new _QosMonitor('MSGraphClientV3.CreateGraphClientInstance');
+        var graphClient;
+        try {
+            graphClient = this._createClientInstance(__assign(__assign({}, options), { authProvider: undefined }), tokenProvider, false);
+        }
+        catch (e) {
+            qosMonitor.writeUnexpectedFailure(e.message, e);
+            throw e;
+        }
+        return graphClient;
+    };
+    MSGraphClientV3.prototype._createGraphClientInstanceWithMiddleware = function (tokenProvider, options) {
+        var qosMonitor = new _QosMonitor('MSGraphClientV3.CreateGraphClientInstanceWithMiddleware');
+        var graphClient;
+        try {
+            graphClient = this._createClientInstance(options, tokenProvider, false);
+            qosMonitor.writeSuccess();
+            return graphClient;
+        }
+        catch (e) {
+            qosMonitor.writeUnexpectedFailure(e.message, e);
+            throw e;
+        }
+    };
+    MSGraphClientV3.prototype._createInternalGraphClientInstance = function (tokenProvider, options) {
+        var qosMonitor = new _QosMonitor('MSGraphClientV3.CreateInternalGraphClientInstance');
+        var graphClient;
+        try {
+            graphClient = this._createClientInstance(__assign(__assign({}, options), { authProvider: undefined }), tokenProvider, true);
+        }
+        catch (e) {
+            qosMonitor.writeUnexpectedFailure(e.message, e);
+            throw e;
+        }
+        return graphClient;
+    };
+    MSGraphClientV3.prototype._createClientInstance = function (options, tokenProvider, isInternal) {
+        var clientOptions = options || {};
+        clientOptions.baseUrl = MSGraphClientV3._graphBaseUrl;
+        var middlewareChain;
+        if (!clientOptions.middleware) {
+            // creating default chain
+            middlewareChain = MiddlewareFactory.getDefaultMiddlewareChain(new MSGraphAuthenticationProvider(tokenProvider, MSGraphClientV3._graphBaseUrl, isInternal));
+        }
+        else {
+            // a developer has provided middleware(s)
+            var authMiddleware = new AuthenticationHandler(new MSGraphAuthenticationProvider(tokenProvider, MSGraphClientV3._graphBaseUrl, isInternal));
+            middlewareChain = [authMiddleware];
+            if (Array.isArray(clientOptions.middleware)) {
+                middlewareChain.push.apply(middlewareChain, clientOptions.middleware);
+            }
+            else {
+                middlewareChain.push(clientOptions.middleware);
+            }
+        }
+        if (!isPassSdkVersionKSActivated() && this._consumerComponentManifest) {
+            if (!clientOptions.fetchOptions) {
+                clientOptions.fetchOptions = {};
+            }
+            if (!clientOptions.fetchOptions.headers) {
+                clientOptions.fetchOptions.headers = {};
+            }
+            var sdkVersionValue = "SPFx/".concat(this._consumerComponentManifest.alias, "/").concat(this._consumerComponentManifest.id, "/Is3PRequest:").concat(this._consumerComponentManifest.isInternal ? '0' : '1');
+            var headers = clientOptions.fetchOptions.headers;
+            if (Array.isArray(headers)) {
+                var sdkVersionHeaderIndex = headers.findIndex(function (header) { return header[0] === 'SdkVersion'; });
+                if (sdkVersionHeaderIndex === -1) {
+                    headers.push(['SdkVersion', sdkVersionValue]);
+                }
+                else {
+                    headers[sdkVersionHeaderIndex][1] += ", ".concat(sdkVersionValue);
+                }
+            }
+            else if (headers instanceof Headers) {
+                headers.has('SdkVersion')
+                    ? headers.set('SdkVersion', "".concat(headers.get('SdkVersion'), ", ").concat(sdkVersionValue))
+                    : headers.set('SdkVersion', sdkVersionValue);
+            }
+            else {
+                headers.SdkVersion = headers.SdkVersions
+                    ? "".concat(headers.SdkVersion, ", ").concat(sdkVersionValue)
+                    : sdkVersionValue;
+            }
+        }
+        // we can add more middleware to the end of the chain here
+        clientOptions.middleware = middlewareChain;
+        if (!isCustomHostsKSActivated()) {
+            try {
+                var url = new URL(MSGraphClientV3._graphBaseUrl);
+                clientOptions.customHosts = new Set([url.host]);
+            }
+            catch (e) {
+                var qosMonitor = new _QosMonitor('MSGraphClientV3.CustomHostsAdditionsFailed');
+                qosMonitor.writeUnexpectedFailure(e.message, e);
+            }
+        }
+        return _InternalGraphClient.initWithMiddleware(clientOptions);
+    };
+    return MSGraphClientV3;
+}());
+export default MSGraphClientV3;
+//# sourceMappingURL=MSGraphClientV3.js.map

package/lib/SPHttpMsGraphStrings.resx.d.ts

@@ -0,0 +1,19 @@
+// This file was generated by a tool. Modifying it will produce unexpected behavior
+
+/**
+ * @public
+ */
+export interface ISPHttpMsGraphStrings {
+  /**
+   * [Tag:ODSP-SPPPLAT-SPHttp] Message to show when the MSGraphClient cannot be constructed. MSGraphClient is a javascript SDK for interacting with Microsoft Graph's REST APIs. 
+   */
+  'graphClientInitializationError': string;
+
+}
+
+/**
+ * @public
+ */
+declare const strings: ISPHttpMsGraphStrings;
+
+export default strings;