Merge pull request #163 from SharePoint/dev

Prepare v1.14.1

Author: estruyf

CHANGELOG.json

@@ -1,5 +1,17 @@
 {
   "versions": [
+    {
+      "version": "1.14.1",
+      "changes": {
+        "new": [],
+        "enhancements": [],
+        "fixes": [
+          "`TaxonomyPicker`: Terms are sorted incorrectly under the wrong parent [#153](https://github.com/SharePoint/sp-dev-fx-property-controls/issues/153)",
+          "`EnterpriseTermPicker`: Terms are sorted incorrectly under the wrong parent [#156](https://github.com/SharePoint/sp-dev-fx-property-controls/issues/156)"
+        ]
+      },
+      "contributions": []
+    },
     {
       "version": "1.14.0",
       "changes": {

CHANGELOG.md

@@ -1,5 +1,12 @@
 # Releases
 
+## 1.14.1
+
+### Fixes
+
+- `TaxonomyPicker`: Terms are sorted incorrectly under the wrong parent [#153](https://github.com/SharePoint/sp-dev-fx-property-controls/issues/153)
+- `EnterpriseTermPicker`: Terms are sorted incorrectly under the wrong parent [#156](https://github.com/SharePoint/sp-dev-fx-property-controls/issues/156)
+
 ## 1.14.0
 
 ### New control(s)

docs/documentation/docs/about/release-notes.md

@@ -1,5 +1,12 @@
 # Releases
 
+## 1.14.1
+
+### Fixes
+
+- `TaxonomyPicker`: Terms are sorted incorrectly under the wrong parent [#153](https://github.com/SharePoint/sp-dev-fx-property-controls/issues/153)
+- `EnterpriseTermPicker`: Terms are sorted incorrectly under the wrong parent [#156](https://github.com/SharePoint/sp-dev-fx-property-controls/issues/156)
+
 ## 1.14.0
 
 ### New control(s)

docs/documentation/docs/controls/PropertyPaneWebPartInformation.md

@@ -13,7 +13,7 @@ This control allows you to specify a description, a 'read more' link, and an opt
 2. Import the following modules to your component: 
 
 ```TypeScript
-import { PropertyWebPartInformation } from '@pnp/spfx-property-controls/lib/PropertyPaneWebPartInformation';
+import { PropertyPaneWebPartInformation } from '@pnp/spfx-property-controls/lib/PropertyPaneWebPartInformation';
 ```
 
 3. Create a new property for your web part, for example:

docs/documentation/mkdocs.yml

@@ -6,6 +6,7 @@ nav:
     - PropertyFieldCollectionData: 'controls/PropertyFieldCollectionData.md'
     - PropertyFieldColorPicker: 'controls/PropertyFieldColorPicker.md'
     - PropertyFieldDateTimePicker: 'controls/PropertyFieldDateTimePicker.md'
+    - PropertyFieldEnterpriseTermPicker: 'controls/PropertyFieldEnterpriseTermPicker.md'
     - PropertyFieldListPicker: 'controls/PropertyFieldListPicker.md'
     - PropertyFieldMultiSelect: 'controls/PropertyFieldMultiSelect.md'
     - PropertyFieldNumber: 'controls/PropertyFieldNumber.md'

package.json

@@ -1,7 +1,7 @@
 {
   "name": "@pnp/spfx-property-controls",
   "description": "Reusable property pane controls for SharePoint Framework solutions",
-  "version": "1.14.0",
+  "version": "1.14.1",
   "engines": {
     "node": ">=0.10.0"
   },

src/common/telemetry/version.ts

@@ -1 +1 @@
-export const version: string = "1.14.0";
+export const version: string = "1.14.1";

src/services/ISPTermStorePickerService.ts

@@ -1,4 +1,5 @@
 import { IPickerTerm } from './../propertyFields/termPicker/IPropertyFieldTermPicker';
+import { findIndex } from '@microsoft/sp-lodash-subset';
 
 /**
  * Interfaces for Term store, groups and term sets
@@ -159,12 +160,56 @@ export class TermStorePickerServiceHelper {
     return /^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/.test(strGuid);
   }
 
-    /**
+  /**
+   * Sorting terms based on their path and depth
+   *
+   * @param terms
+   */
+  public static sortTerms(terms: ITerm[]) {
+    // Start sorting by depth
+    let newTermsOrder: ITerm[] = [];
+    let itemsToSort = true;
+    let pathLevel = 1;
+    while (itemsToSort) {
+      // Get terms for the current level
+      let crntTerms = terms.filter(term => term.PathDepth === pathLevel);
+      if (crntTerms && crntTerms.length > 0) {
+        crntTerms = crntTerms.sort(this.sortTermByPath);
+
+        if (pathLevel !== 1) {
+          crntTerms = crntTerms.reverse();
+          for (const crntTerm of crntTerms) {
+            const pathElms = crntTerm.PathOfTerm.split(";");
+            // Last item is not needed for parent path
+            pathElms.pop();
+            // Find the parent item and add the new item
+            const idx = findIndex(newTermsOrder, term => term.PathOfTerm === pathElms.join(";"));
+            if (idx !== -1) {
+              newTermsOrder.splice(idx + 1, 0, crntTerm);
+            } else {
+              // Push the item at the end if the parent couldn't be found
+              newTermsOrder.push(crntTerm);
+            }
+          }
+        } else {
+          newTermsOrder = crntTerms;
+        }
+
+        ++pathLevel;
+      } else {
+        itemsToSort = false;
+      }
+    }
+    return newTermsOrder;
+  }
+
+  /**
    * Sort the terms by their path
+   *
    * @param a term 2
    * @param b term 2
    */
-  public static sortTerms(a: ITerm, b: ITerm) {
+  private static sortTermByPath(a: ITerm, b: ITerm) {
     if (a.PathOfTerm < b.PathOfTerm) {
       return -1;
     }

src/services/PnPTermStorePickerService.ts

@@ -194,8 +194,7 @@ export default class PnPTermStorePickerService implements ISPTermStorePickerServ
         }
         await this._ensureTermStores();
         const pnpTermStores = this._pnpTermStores;
-        for (let i = 0, len = pnpTermStores.length; i < len; i++) {
-            const pnpTermStore = pnpTermStores[i];
+        for (const pnpTermStore of pnpTermStores) {
             const termsResult: any = await this._tryGetAllTerms(pnpTermStore, termSet).catch((error) => { }); // .catch part is needed to proceed if there was a rejected promise
             if (!termsResult) { // terms variable will be undefined if the Promise has been rejected. Otherwise it will contain an array
                 continue;
@@ -226,7 +225,7 @@ export default class PnPTermStorePickerService implements ISPTermStorePickerServ
                 await labelsBatch.execute();
             }
 
-            return resultTerms;
+            return TermStorePickerServiceHelper.sortTerms(resultTerms);
         }
 
     }
@@ -397,12 +396,12 @@ export default class PnPTermStorePickerService implements ISPTermStorePickerServ
                 pnpTerm.termSet.group.inBatch(batch).usingCaching().get().then(pnpTermGroup => {
                      pickerTerm.termGroup = TermStorePickerServiceHelper.cleanGuid(pnpTermGroup.Id);
                  });
- 
+
                  pnpTerm.termSet.inBatch(batch).usingCaching().get().then(pnpTermSet => {
                      pickerTerm.termSet = TermStorePickerServiceHelper.cleanGuid(pnpTermSet.Id);
                      pickerTerm.termSetName = pnpTermSet.Name;
                  });
- 
+
                  if (this.props.includeLabels) {
                      pnpTerm.labels.inBatch(batch).usingCaching().get().then(labels => {
                          pickerTerm.labels = labels.map(label => label.Value);
@@ -635,4 +634,4 @@ export default class PnPTermStorePickerService implements ISPTermStorePickerServ
 
         return null;
     }
-}
+}

src/services/SPTermStorePickerService.ts

@@ -172,8 +172,8 @@ export default class SPTermStorePickerService implements ISPTermStorePickerServi
             });
             // Check if the term set was not empty
             if (terms.length > 0) {
-              // Sort the terms by PathOfTerm
-              return terms.sort(TermStorePickerServiceHelper.sortTerms);
+              // Sort the terms by PathOfTerm and their depth
+              return TermStorePickerServiceHelper.sortTerms(terms);
             }
           }
           return null;