@microsoft/sp-http-msgraph 1.16.0-beta.2

package/lib-commonjs/MSGraphClientV3.js

@@ -0,0 +1,125 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+var tslib_1 = require("tslib");
+var sp_core_library_1 = require("@microsoft/sp-core-library");
+var sp_diagnostics_1 = require("@microsoft/sp-diagnostics");
+var ms_graph_v3_bundle_1 = require("@ms/ms-graph-v3-bundle");
+var sp_http_base_1 = require("@microsoft/sp-http-base");
+/**
+ * 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) {
+        var _this = this;
+        serviceScope.whenFinished(function () {
+            MSGraphClientV3._graphBaseUrl = serviceScope
+                .consume(sp_http_base_1._GraphHttpClientContext.serviceKey)
+                .getGraphEndpointUrl();
+            if (!MSGraphClientV3._instance) {
+                if (clientOptions !== undefined) {
+                    MSGraphClientV3._instance = _this._createGraphClientInstanceWithMiddleware(sp_http_base_1._AadTokenProviders.configurable, clientOptions);
+                }
+                else {
+                    MSGraphClientV3._instance = _this._createGraphClientInstance(sp_http_base_1._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) {
+        sp_core_library_1.Validate.isNonemptyString(path, '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 () {
+            return MSGraphClientV3._instance;
+        },
+        enumerable: false,
+        configurable: true
+    });
+    MSGraphClientV3.prototype._createGraphClientInstance = function (tokenProvider, options) {
+        var _this = this;
+        var qosMonitor = new sp_diagnostics_1._QosMonitor('MSGraphClientV3.CreateGraphClientInstance');
+        var graphClient = ms_graph_v3_bundle_1.Client.init(tslib_1.__assign({ authProvider: function (done) {
+                _this._getOAuthToken(tokenProvider)
+                    .then(function (token) {
+                    done(undefined /** error object */, token);
+                    qosMonitor.writeSuccess();
+                })
+                    .catch(function (e) {
+                    // The functions will return a rejected promise if it fails to get an OAuth2Token.
+                    done(e, '');
+                    qosMonitor.writeExpectedFailure(e.message);
+                });
+            }, baseUrl: MSGraphClientV3._graphBaseUrl }, options // with this, the user can override the baseUrl and authProvider too
+        ));
+        return graphClient;
+    };
+    MSGraphClientV3.prototype._createGraphClientInstanceWithMiddleware = function (tokenProvider, options) {
+        var _this = this;
+        var qosMonitor = new sp_diagnostics_1._QosMonitor('MSGraphClientV3.CreateGraphClientInstanceWithMiddleware');
+        try {
+            var graphClient = ms_graph_v3_bundle_1.Client.initWithMiddleware(tslib_1.__assign({ authProvider: {
+                    getAccessToken: function (authenticationProviderOptions) {
+                        return _this._getOAuthToken(tokenProvider);
+                    }
+                }, baseUrl: MSGraphClientV3._graphBaseUrl }, options // with this, the user can override the baseUrl and authProvider too
+            ));
+            qosMonitor.writeSuccess();
+            return graphClient;
+        }
+        catch (e) {
+            qosMonitor.writeUnexpectedFailure('CreateGraphClientInstanceWithMiddleware', e);
+            throw e;
+        }
+    };
+    MSGraphClientV3.prototype._getOAuthToken = function (tokenProvider) {
+        var qosMonitor = new sp_diagnostics_1._QosMonitor('MSGraphClient.FetchGraphToken');
+        return tokenProvider
+            .getToken(MSGraphClientV3._graphBaseUrl)
+            .then(function (response) {
+            qosMonitor.writeSuccess();
+            return response;
+        })
+            .catch(function (error) {
+            qosMonitor.writeUnexpectedFailure('FetchGraphToken', error);
+            throw error;
+        });
+    };
+    return MSGraphClientV3;
+}());
+exports.default = MSGraphClientV3;
+//# sourceMappingURL=MSGraphClientV3.js.map

package/lib-commonjs/SPHttpMsGraphStrings.resx

@@ -0,0 +1,11 @@
+<?xml version="1.0" encoding="utf-8"?>
+<root>
+    <data name="$FILE_ID" xml:space="preserve">
+        <value>d825b9d7-8b85-47f7-a88c-1d4c32dd9e99</value>
+        <comment>{locked} This is the file ID for this localization file. This string value should not be used or translated.</comment>
+    </data>
+    <data name="graphClientInitializationError" xml:space="preserve">
+        <value>Sorry, we couldn't make a connection to Microsoft Graph.</value>
+        <comment>[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. </comment>
+    </data>
+</root>

package/lib-commonjs/index.js

@@ -0,0 +1,20 @@
+"use strict";
+/**
+ * Microsoft Graph communication layer for the SharePoint Framework
+ *
+ * @remarks
+ * This package defines the base communication layer between Microsoft Graph and
+ * the SharePoint Framework.
+ *
+ * @packagedocumentation
+ */
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MSGraphClientFactory = exports.MSGraphClient = void 0;
+var MSGraphClient_1 = require("./MSGraphClient");
+Object.defineProperty(exports, "MSGraphClient", { enumerable: true, get: function () { return __importDefault(MSGraphClient_1).default; } });
+var MSGraphClientFactory_1 = require("./MSGraphClientFactory");
+Object.defineProperty(exports, "MSGraphClientFactory", { enumerable: true, get: function () { return __importDefault(MSGraphClientFactory_1).default; } });
+//# sourceMappingURL=index.js.map

package/lib-commonjs/sp-http-msgraph.manifest.json

@@ -0,0 +1,14 @@
+{
+  "$schema": "https://developer.microsoft.com/json-schemas/spfx/client-side-component-manifest.schema.json",
+
+  "manifestVersion": 2,
+
+  "id": "aec2bbfd-a968-4d5b-a279-12e570f378e6",
+  "alias": "@microsoft/sp-http-msgraph",
+  "componentType": "Library",
+
+  // The "*" instructs the tools take the version from package.json when generating the output manifest.
+  // For a first party web part that is deployed with sp-client, this version is not very meaningful.
+  // We recommend to put "1.0.0" in your package.json and not worry about incrementing it.
+  "version": "*"
+}

package/package.json

@@ -0,0 +1,22 @@
+{
+  "name": "@microsoft/sp-http-msgraph",
+  "version": "1.16.0-beta.2",
+  "description": "Microsoft Graph communication layer for the SharePoint Framework",
+  "license": "https://aka.ms/spfx/license",
+  "homepage": "http://aka.ms/spfx",
+  "main": "lib-commonjs/index.js",
+  "module": "lib/index.js",
+  "typings": "dist/index-internal.d.ts",
+  "tsdoc": {
+    "tsdocFlavor": "AEDoc"
+  },
+  "scripts": {},
+  "dependencies": {
+    "@microsoft/microsoft-graph-clientv1": "npm:@microsoft/microsoft-graph-client@1.7.2-spfx",
+    "@microsoft/sp-core-library": "1.16.0-beta.2",
+    "@microsoft/sp-diagnostics": "1.16.0-beta.2",
+    "@microsoft/sp-http-base": "1.16.0-beta.2",
+    "@microsoft/sp-loader": "1.16.0-beta.2",
+    "tslib": "2.3.1"
+  }
+}