gd-sprest 7.7.0 → 7.7.1

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

@@ -1,5 +1,5 @@
 import { IBaseExecution } from "gd-sprest-def/lib/base";
-import { SearchRequest } from "gd-sprest-def/lib/Microsoft/Office/Server/Search/REST/complextypes";
+import { SearchRequest, SearchResult } from "gd-sprest-def/lib/Microsoft/Office/Server/Search/REST";
 import { ISearchService } from "gd-sprest-def/lib/Microsoft/Office/Server/Search/REST/entitytypes";
 import { ITargetInfoProps } from "../utils";
 
@@ -9,6 +9,17 @@ import { ITargetInfoProps } from "../utils";
  */
 export const Search: ISearch;
 
+/**
+ * Search Post Query
+ */
+export interface ISearchPostQuery {
+    onQueryCompleted?: (results: SearchResult) => void;
+    query: SearchRequest
+    targetInfo?: ITargetInfoProps;
+    url?: string;
+    useBatch?: boolean;
+}
+
 /**
  * Search
  * @category Search
@@ -31,11 +42,17 @@ export interface ISearch {
      * Method to get the query from the search parameters.
      * @param parameters - The search parameters.
      */
-    getQuery: (parameters: SearchRequest /* | Microsoft.Office.Server.Search.REST.SearchSuggestion*/) => Array<string>;
+    getQuery(parameters: SearchRequest): Array<string>;
 
     /**
      * Method to get the url of a site, by its id.
      * @param id - The site id.
      */
     getUrlById(id: string): IBaseExecution<{ GetUrlById: string }>;
+
+    /**
+     * Method to execute a post query
+     * @param 
+     */
+    postQuery(props: ISearchPostQuery): PromiseLike<SearchResult>;
 }

package/build/lib/search.js

@@ -41,3 +41,95 @@ exports.Search.getQuery = function (parameters) {
     // Return the query
     return [query];
 };
+// Static post query method
+exports.Search.postQuery = function (props) {
+    // Return a promise
+    return new Promise(function (resolve, reject) {
+        var queryProps = props.query;
+        // Query the first batch
+        exports.Search(props.url, props.targetInfo).postquery(queryProps).execute(
+        // Success
+        function (request) {
+            // Updates the table
+            var updateRequest = function (searchResult) {
+                // Call the event
+                props.onQueryCompleted ? props.onQueryCompleted(searchResult) : null;
+                // Parse rows
+                for (var i = 0; i < searchResult.PrimaryQueryResult.RelevantResults.Table.Rows.results.length; i++) {
+                    var row = searchResult.PrimaryQueryResult.RelevantResults.Table.Rows.results[i];
+                    // Append the row
+                    request.postquery.PrimaryQueryResult.RelevantResults.Table.Rows.results.push(row);
+                }
+            };
+            // Call the event
+            props.onQueryCompleted ? props.onQueryCompleted(request.postquery) : null;
+            // See if more results exist
+            var results = request.postquery.PrimaryQueryResult.RelevantResults;
+            if (results.TotalRows > results.RowCount) {
+                var search = exports.Search(props.url, props.targetInfo);
+                var useBatch = typeof (props.useBatch) === "boolean" ? props.useBatch : true;
+                // Compute the row count
+                var rowCount = 500;
+                if (typeof (queryProps.RowLimit) === "number") {
+                    // Set the custom limit
+                    rowCount = queryProps.RowLimit;
+                }
+                else {
+                    // Default to the max size
+                    queryProps.RowLimit = rowCount;
+                }
+                // Compute the total # of requests that we need to make
+                var totalPages = Math.ceil(results.TotalRows / rowCount);
+                // Loop for the total # of requests
+                for (var i = 0; i < totalPages; i++) {
+                    // Set the start row
+                    queryProps.StartRow = i * rowCount;
+                    // See if we are making a batch request
+                    if (useBatch) {
+                        // Create a batch request
+                        search.postquery(queryProps).batch(
+                        // Success
+                        function (batchRequest) {
+                            // Update the request
+                            updateRequest(batchRequest.postquery);
+                        }, 
+                        // Limit to 100 per request
+                        i % 100 == 0);
+                    }
+                    else {
+                        // Create the request
+                        search.postquery(queryProps).execute(
+                        // Success
+                        function (batchRequest) {
+                            // Update the request
+                            updateRequest(batchRequest.postquery);
+                        }, 
+                        // Wait for the previous request to complete
+                        true);
+                    }
+                }
+                // See if we are making a batch request
+                if (useBatch) {
+                    // Execute the batch requests
+                    search.execute(function () {
+                        // Resolve the request
+                        resolve(request.postquery);
+                    }, reject);
+                }
+                else {
+                    // Wait for the requests to complete
+                    search.done(function () {
+                        // Resolve the request
+                        resolve(request.postquery);
+                    });
+                }
+            }
+            else {
+                // Resolve the request
+                resolve(request.postquery);
+            }
+        }, 
+        // Error
+        reject);
+    });
+};

package/build/rest.js

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

package/build/utils/request.js

@@ -464,7 +464,7 @@ exports.Request = {
             return xml.nodeValue;
         }
         // Return the collection if it exists, otherwise the object
-        return results ? results : objData;
+        return results ? { results: results } : objData;
     },
     // Method to convert the input arguments into an object
     updateDataObject: function (base, isBatchRequest, batchIdx) {

package/dist/gd-sprest.d.ts

@@ -9,7 +9,7 @@
 //   ../gd-sprest-def/lib/Microsoft/SharePoint/Portal/entitytypes
 //   ../gd-sprest-def/lib/Microsoft/SharePoint/Navigation/REST/entitytypes
 //   ../gd-sprest-def/lib/SP/UserProfiles/entitytypes
-//   ../gd-sprest-def/lib/Microsoft/Office/Server/Search/REST/complextypes
+//   ../gd-sprest-def/lib/Microsoft/Office/Server/Search/REST
 //   ../gd-sprest-def/lib/Microsoft/Office/Server/Search/REST/entitytypes
 //   ../gd-sprest-def/lib/SP/Publishing/entitytypes
 //   ../gd-sprest-def/lib/SP/Social/complextypes
@@ -1569,7 +1569,7 @@ declare module 'gd-sprest/lib/profileLoader' {
 
 declare module 'gd-sprest/lib/search' {
     import { IBaseExecution } from "gd-sprest-def/lib/base";
-    import { SearchRequest } from "gd-sprest-def/lib/Microsoft/Office/Server/Search/REST/complextypes";
+    import { SearchRequest, SearchResult } from "gd-sprest-def/lib/Microsoft/Office/Server/Search/REST";
     import { ISearchService } from "gd-sprest-def/lib/Microsoft/Office/Server/Search/REST/entitytypes";
     import { ITargetInfoProps } from "gd-sprest/utils";
     
@@ -1579,6 +1579,17 @@ declare module 'gd-sprest/lib/search' {
         */
     export const Search: ISearch;
     
+    /**
+        * Search Post Query
+        */
+    export interface ISearchPostQuery {
+            onQueryCompleted?: (results: SearchResult) => void;
+            query: SearchRequest
+            targetInfo?: ITargetInfoProps;
+            url?: string;
+            useBatch?: boolean;
+    }
+    
     /**
         * Search
         * @category Search
@@ -1601,13 +1612,19 @@ declare module 'gd-sprest/lib/search' {
                 * Method to get the query from the search parameters.
                 * @param parameters - The search parameters.
                 */
-            getQuery: (parameters: SearchRequest /* | Microsoft.Office.Server.Search.REST.SearchSuggestion*/) => Array<string>;
+            getQuery(parameters: SearchRequest): Array<string>;
     
             /**
                 * Method to get the url of a site, by its id.
                 * @param id - The site id.
                 */
             getUrlById(id: string): IBaseExecution<{ GetUrlById: string }>;
+    
+            /**
+                * Method to execute a post query
+                * @param 
+                */
+            postQuery(props: ISearchPostQuery): PromiseLike<SearchResult>;
     }
 }