Fix of #1026: providing trimDuplicates and additionalQuery properties to site picker control

Author: AJIXuMuK

docs/documentation/docs/controls/SitePicker.md

@@ -52,12 +52,14 @@ The `SitePicker` control can be configured with the following properties:
 | isDesc | boolean | no | Specifies if the list is sorted in descending order. Default: `false`. |
 | label | string | no | Label to use for the control. |
 | limitToCurrentSiteCollection | boolean | no | Specifies if the options should be limited by the current site collections. Taken into consideration if selectionMode is set to `web`. |
-| mode | `'site' \| 'web' \| 'hub'` | no | Defines what entities are available for selection: site collections, sites, hub sites. Default: `web`. |
+| mode | `'site' | 'web' | 'hub'` | no | Defines what entities are available for selection: site collections, sites, hub sites. Default: `web`. |
 | multiSelect | boolean | no | Optional mode indicates if multi-choice selections is allowed. Default: `true`. |
 | onChange | `(selectedSites: ISite[]) => void` | yes | Selection change handler. | 
-| orderBy | `'title' \| 'url'` | no | Specifices if the list is sorted by title or url. Default: `title`. |
+| orderBy | `'title' | 'url'` | no | Specifices if the list is sorted by title or url. Default: `title`. |
 | placeholder | string | no | Placeholder label to show in the dropdown. |
 | searchPlaceholder | string | no | Search input placeholder text. Displayed until search text is entered. |
+| trimDuplicates | boolean | no | Specifies if the duplicates should be trimmed. false by default. Applicable if mode is set to site or web. |
+| additionalQuery | string | no | If provided will be added to the search query as AND part. Applicable if mode is set to site or web. |
 
 Interface `ISite`
 

src/controls/sitePicker/ISitePicker.ts

@@ -100,4 +100,16 @@ export interface ISitePickerProps {
    * If provided, additional class name to provide on the dropdown element.
    */
   className?: string;
+
+  /**
+   * Specifies if the duplicates should be trimmed. false by default.
+   * Applicable if mode is set to site or web.
+   */
+  trimDuplicates?: boolean;
+
+  /**
+   * If provided will be added to the search query as AND part.
+   * Applicable if mode is set to site or web.
+   */
+  additionalQuery?: string;
 }

src/controls/sitePicker/SitePicker.tsx

@@ -71,7 +71,9 @@ export const SitePicker: React.FunctionComponent<ISitePickerProps> = (props: Rea
     searchPlaceholder,
     deferredSearchTime,
     className,
-    selectedSites
+    selectedSites,
+    trimDuplicates,
+    additionalQuery
   } = props;
 
   const [isLoading, setIsLoading] = React.useState<boolean>();
@@ -235,7 +237,7 @@ export const SitePicker: React.FunctionComponent<ISitePickerProps> = (props: Rea
       promise = getHubSites(context);
     }
     else {
-      promise = getAllSites(context, mode !== 'site', limitToCurrentSiteCollection);
+      promise = getAllSites(context, mode !== 'site', limitToCurrentSiteCollection, trimDuplicates === true, additionalQuery);
     }
 
     promise.then(newSites => {

src/services/SPSitesService.ts

@@ -2,18 +2,36 @@ import { BaseComponentContext } from '@microsoft/sp-component-base';
 import { ISite } from '../controls/sitePicker/ISitePicker';
 import { SPHttpClient } from '@microsoft/sp-http';
 
-const getAllSitesInternal = async (ctx: BaseComponentContext, queryText: string): Promise<ISite[]> => {
+const getAllSitesInternal = async (ctx: BaseComponentContext, queryText: string, trimDuplicates: boolean): Promise<ISite[]> => {
   let startRow = 0;
   let rowLimit = 500;
   let totalRows = 0;
   const values: any[] = [];
 
+  const searchRequest = {
+    QueryTemplate: queryText,
+    RowLimit: rowLimit,
+    TrimDuplicates: trimDuplicates,
+    SelectProperties: ['SiteId', 'SiteID', 'WebId', 'DepartmentId', 'Title', 'Path'],
+    StartRow: 0
+  };
+
+  const requestUrl = `${ctx.pageContext.web.absoluteUrl}/_api/search/postquery`;
+
   //
   // getting all sites
   //
   do {
-    let userRequestUrl: string = `${ctx.pageContext.web.absoluteUrl}/_api/search/query?querytext='${queryText}'&selectproperties='SiteId,SiteID,WebId,DepartmentId,Title,Path'&rowlimit=${rowLimit}&startrow=${startRow}`;
-    let searchResponse = await ctx.spHttpClient.get(userRequestUrl, SPHttpClient.configurations.v1);
+    searchRequest.StartRow = startRow;
+
+    let searchResponse = await ctx.spHttpClient.post(requestUrl, SPHttpClient.configurations.v1, {
+      body: JSON.stringify({ request: searchRequest }),
+      headers: {
+        'Accept': 'application/json;odata=nometadata',
+        'Content-Type': 'application/json;charset=utf-8',
+        'odata-version': '3.0'
+      }
+    });
     let sitesResponse = await searchResponse.json();
     let relevantResults = sitesResponse.PrimaryQueryResult.RelevantResults;
 
@@ -61,16 +79,19 @@ const getAllSitesInternal = async (ctx: BaseComponentContext, queryText: string)
   return res;
 };
 
-export const getAllSites = async (ctx: BaseComponentContext, includeWebs: boolean, currentSiteCollectionOnly: boolean): Promise<ISite[]> => {
+export const getAllSites = async (ctx: BaseComponentContext, includeWebs: boolean, currentSiteCollectionOnly: boolean, trimDuplicates: boolean, additionaQuery?: string | undefined): Promise<ISite[]> => {
 
   let rootUrl: string = ctx.pageContext.web.absoluteUrl;
   if (ctx.pageContext.web.serverRelativeUrl !== '/' && (!includeWebs || !currentSiteCollectionOnly)) {
     rootUrl = ctx.pageContext.web.absoluteUrl.replace(ctx.pageContext.web.serverRelativeUrl, '');
   }
 
-  const queryText = `contentclass:STS_Site${includeWebs ? ' contentclass:STS_Web' : ''} Path:${rootUrl}*`;
+  let queryText = `(contentclass:STS_Site${includeWebs ? ' contentclass:STS_Web' : ''} Path:${rootUrl}*)`;
+  if (additionaQuery) {
+    queryText += ` AND (${additionaQuery})`;
+  }
 
-  return getAllSitesInternal(ctx, queryText);
+  return getAllSitesInternal(ctx, queryText, trimDuplicates);
 };
 
 export const getHubSites = async (ctx: BaseComponentContext): Promise<ISite[]> => {