gd-sprest 7.6.7 → 7.6.9

package/@types/lib/list.d.ts

@@ -57,6 +57,11 @@ export interface IList {
      * @param parameters - The optional list data parameters.
      */
     getDataAsStream(listFullUrl: string, parameters?: RenderListDataParameters): IBaseExecution<IListDataStream>;
+
+    /**
+     * Runs a flow against a list item.
+     */
+    runFlow(props: IRunFlow): PromiseLike<IRunFlowResult>;
 }
 
 /**
@@ -91,4 +96,26 @@ export interface IListEntityProps {
 
     /** The relative url of the web containing the list. */
     url?: string;
+}
+
+/**
+ * Properties for running a flow
+ */
+export interface IRunFlow {
+    cloudEnv?: string;
+    data: object;
+    id?: string;
+    list: string;
+    token?: string;
+    webUrl?: string;
+}
+
+/**
+ * Flow execution result
+ */
+export interface IRunFlowResult {
+    errorDetails?: object;
+    errorMessage?: string;
+    executed: boolean;
+    flowToken?: string;
 }

package/build/lib/list.js

@@ -1,7 +1,9 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.List = void 0;
+var sptypes_1 = require("../sptypes");
 var utils_1 = require("../utils");
+var graph_1 = require("./graph");
 var web_1 = require("./web");
 /**
  * List
@@ -55,3 +57,122 @@ exports.List.getDataAsStream = (function (listFullUrl, parameters) {
         endpoint: "SP.List.getListDataAsStream" + params
     });
 });
+// Static method for executing a flow against a list item
+exports.List.runFlow = function (props) {
+    // Return a promise
+    return new Promise(function (resolve) {
+        // Gets the graph token
+        var getGraphToken = function () {
+            // Return a promise
+            return new Promise(function (resolveAuth) {
+                // Get the graph token
+                graph_1.Graph.getAccessToken(sptypes_1.SPTypes.CloudEnvironment.Flow).execute(function (auth) {
+                    // Resolve the request
+                    resolveAuth(auth.access_token);
+                }, 
+                // Error
+                function (ex) {
+                    // Resolve the request
+                    resolve({
+                        executed: false,
+                        errorDetails: ex.response,
+                        errorMessage: "Auth Error: Unable to get the flow token."
+                    });
+                });
+            });
+        };
+        // Gets the flow token
+        var getFlowToken = function (flowInfo) {
+            // Return a promise
+            return new Promise(function (resolveAuth) {
+                // See if the flow token is provided
+                if (props.token) {
+                    // Resolve the request
+                    resolveAuth(props.token);
+                }
+                else {
+                    // Get the graph token
+                    getGraphToken().then(function (token) {
+                        // See if the cloud environment was provided
+                        if (props.cloudEnv) {
+                            // Set the url
+                            var authUrl = "" + props.cloudEnv + flowInfo.properties.environment.id + "/users/me/onBehalfOfTokenBundle?api-version=2016-11-01";
+                            // Execute the request
+                            new utils_1.Base({
+                                endpoint: authUrl,
+                                method: "POST",
+                                requestType: utils_1.RequestType.GraphPost,
+                                requestHeader: {
+                                    "authorization": "Bearer " + token
+                                }
+                            }).execute(function (tokenInfo) {
+                                // Resolve the request
+                                resolveAuth(tokenInfo.audienceToToken["https://" + flowInfo.properties.connectionReferences.shared_sharepointonline.swagger.host] || token);
+                            }, 
+                            // Error
+                            function (ex) {
+                                // Resolve the request
+                                resolve({
+                                    executed: false,
+                                    errorDetails: ex.response,
+                                    errorMessage: "Auth Error: Unable to get the flow token for cloud: " + props.cloudEnv
+                                });
+                            });
+                        }
+                        else {
+                            // Resolve the request
+                            resolveAuth(token);
+                        }
+                    });
+                }
+            });
+        };
+        // Get the flow information
+        web_1.Web(props.webUrl).Lists(props.list).syncFlowInstance(props.id).execute(
+        // Success
+        function (flow) {
+            // Get the flow information
+            var flowInfo = JSON.parse(flow.SynchronizationData);
+            // Get the flow token
+            getFlowToken(flowInfo).then(function (token) {
+                // Trigger the flow
+                new utils_1.Base({
+                    accessToken: token,
+                    requestType: utils_1.RequestType.GraphPost,
+                    endpoint: flowInfo.properties.flowTriggerUri,
+                    data: {
+                        rows: [{
+                                entity: props.data
+                            }]
+                    }
+                }).execute(
+                // Success
+                function () {
+                    // Resolve the request
+                    resolve({
+                        executed: true,
+                        flowToken: token
+                    });
+                }, 
+                // Error
+                function (ex) {
+                    // Resolve the request
+                    resolve({
+                        executed: false,
+                        errorDetails: ex.response,
+                        errorMessage: "Error triggering the flow."
+                    });
+                });
+            });
+        }, 
+        // Error
+        function (ex) {
+            // Resolve the request
+            resolve({
+                executed: false,
+                errorDetails: ex.response,
+                errorMessage: "Error getting the flow information."
+            });
+        });
+    });
+};

package/build/rest.js

@@ -8,7 +8,7 @@ var sptypes_1 = require("./sptypes");
  * SharePoint REST Library
  */
 exports.$REST = {
-    __ver: 7.67,
+    __ver: 7.69,
     AppContext: function (siteUrl) { return Lib.Site.getAppContext(siteUrl); },
     Apps: Lib.Apps,
     ContextInfo: Lib.ContextInfo,

package/dist/gd-sprest.d.ts

@@ -1410,6 +1410,11 @@ declare module 'gd-sprest/lib/list' {
                 * @param parameters - The optional list data parameters.
                 */
             getDataAsStream(listFullUrl: string, parameters?: RenderListDataParameters): IBaseExecution<IListDataStream>;
+    
+            /**
+                * Runs a flow against a list item.
+                */
+            runFlow(props: IRunFlow): PromiseLike<IRunFlowResult>;
     }
     
     /**
@@ -1445,6 +1450,28 @@ declare module 'gd-sprest/lib/list' {
             /** The relative url of the web containing the list. */
             url?: string;
     }
+    
+    /**
+        * Properties for running a flow
+        */
+    export interface IRunFlow {
+            cloudEnv?: string;
+            data: object;
+            id?: string;
+            list: string;
+            token?: string;
+            webUrl?: string;
+    }
+    
+    /**
+        * Flow execution result
+        */
+    export interface IRunFlowResult {
+            errorDetails?: object;
+            errorMessage?: string;
+            executed: boolean;
+            flowToken?: string;
+    }
 }
 
 declare module 'gd-sprest/lib/navigation' {