gd-sprest 9.6.8 → 9.7.0

package/@types/utils/targetInfo.d.ts

@@ -86,6 +86,9 @@ export interface ITargetInfoProps {
     /** The request type. */
     requestType?: number;
 
+    /** The property that contains the request response. */
+    returnProp?: string;
+
     /** The url of the site/web to execute the request against. */
     url?: string;
 }

package/@types/v2/drive.d.ts

@@ -28,7 +28,9 @@ export interface Idrive {
      * Get the default library for a site.
      * @param driveId - (Optional) Sets the drive to get, otherwise gets the default drive for the site.
      * @param siteId - (Optional) The site id to target, current by default.
+     * @param siteUrl - (Optional) The site url to target, current by default.
      * @param targetInfo - (Optional) The target information.
+     * @param webId - (Optional) The web id to target.
      */
-    (props?: { driveId?: string, siteId?: string, siteUrl?: string, targetInfo?: ITargetInfoProps }): IBaseQuery<drive> & driveMethods;
+    (props?: { driveId?: string, siteId?: string, siteUrl?: string, targetInfo?: ITargetInfoProps, webId?: string }): IBaseQuery<drive> & driveMethods;
 }

package/@types/v2/drives.d.ts

@@ -26,10 +26,10 @@ export const drives: Idrives;
 export interface Idrives {
     /**
      * Get the libraries for a site.
-     * @param id - (Optional) The drive id to target.
      * @param siteId - (Optional) The site id to target, current by default.
      * @param siteUrl - (Optional) The site url to target, current by default.
      * @param targetInfo - (Optional) The target information.
+     * @param webId - (Optional) The web id to target.
      */
-    (props?: { siteId?: string, siteUrl?: string, targetInfo?: ITargetInfoProps }): driveCollection;
+    (props?: { siteId?: string, siteUrl?: string, targetInfo?: ITargetInfoProps, webId?: string }): driveCollection;
 }

package/build/mapper/def.js

@@ -3796,6 +3796,7 @@ exports.Mapper = {
         },
         validateGroupName: {
             argNames: ["displayName", "alias"],
+            returnProp: "ValidateGroupName"
         },
     },
     "SP.Directory.Group": {
@@ -5315,6 +5316,7 @@ exports.Mapper = {
         getUserEffectivePermissions: {
             argNames: ["userName"],
             name: "getUserEffectivePermissions(@user)?@user='[[userName]]'",
+            returnProp: "GetUserEffectivePermissions",
             requestType: utils_1.RequestType.GetReplace
         },
         getView: {
@@ -5552,6 +5554,7 @@ exports.Mapper = {
         getUserEffectivePermissions: {
             argNames: ["userName"],
             name: "getUserEffectivePermissions(@user)?@user='[[userName]]'",
+            returnProp: "GetUserEffectivePermissions",
             requestType: utils_1.RequestType.GetReplace
         },
         getVersionById: {
@@ -8521,6 +8524,7 @@ exports.Mapper = {
         getUserEffectivePermissions: {
             argNames: ["userName"],
             name: "getUserEffectivePermissions(@user)?@user='[[userName]]'",
+            returnProp: "GetUserEffectivePermissions",
             requestType: utils_1.RequestType.GetReplace
         },
         getViewFromPath: {
@@ -9012,6 +9016,7 @@ exports.Mapper = {
         getUserEffectivePermissions: {
             argNames: ["userName"],
             name: "getUserEffectivePermissions(@user)?@user='[[userName]]'",
+            returnProp: "GetUserEffectivePermissions",
             requestType: utils_1.RequestType.GetReplace
         },
         getVersionById: {

package/build/rest.js

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

package/build/utils/helper.js

@@ -91,6 +91,7 @@ exports.Helper = {
         targetInfo.method = methodInfo.requestMethod;
         targetInfo.requestDigest = typeof (targetInfo.requestDigest) === "undefined" && base.base && base.base.targetInfo.requestDigest ? base.base.targetInfo.requestDigest : targetInfo.requestDigest;
         targetInfo.requestType = methodConfig.requestType;
+        targetInfo.returnProp = methodConfig.returnProp;
         // See if we are appending the endpoint
         if (methodInfo.appendEndpointFl) {
             // Append to the endpoint

package/build/utils/request.js

@@ -217,6 +217,13 @@ exports.Request = {
                 }
             }
         }
+        // See if a return property was set and value exists
+        if (base.targetInfo.returnProp && data[base.targetInfo.returnProp]) {
+            // Parse the data properties
+            for (var key in data[base.targetInfo.returnProp]) {
+                base[key] = data[base.targetInfo.returnProp][key];
+            }
+        }
     },
     // Method to execute the request
     execute: function (base, args) {

package/build/v2/drive.js

@@ -20,11 +20,11 @@ exports.drive = (function (props) {
     if (drive.targetInfo.endpoint == undefined) {
         if (props.driveId) {
             // Set the endpoint
-            drive.targetInfo.endpoint = "_api/v2.0/".concat(props.siteId ? "sites/" + props.siteId.replace(/[{}]/g, '') + "/" : "", "drives/").concat(props.driveId);
+            drive.targetInfo.endpoint = "_api/v2.0/".concat(props.siteId ? "sites/" + props.siteId.replace(/[{}]/g, '') + (props.webId ? "," + props.webId.replace(/^\{|\}$/g, '') : "") + "/" : "", "drives/").concat(props.driveId);
         }
         else {
             // Default the endpoint
-            drive.targetInfo.endpoint = "_api/v2.0/".concat(props.siteId ? "sites/" + props.siteId.replace(/[{}]/g, '') + "/" : "", "drive");
+            drive.targetInfo.endpoint = "_api/v2.0/".concat(props.siteId ? "sites/" + props.siteId.replace(/[{}]/g, '') + (props.webId ? "," + props.webId.replace(/^\{|\}$/g, '') : "") + "/" : "", "drive");
         }
         // Add the methods
         utils_1.Request.addMethods(drive, { __metadata: { type: "@odata.context/_api/v2.0/$metadata#drive" } });

package/build/v2/drives.js

@@ -19,7 +19,7 @@ exports.drives = (function (props) {
     // See if an endpoint is not defined
     if (drives.targetInfo.endpoint == undefined) {
         // Default the endpoint
-        drives.targetInfo.endpoint = "_api/v2.0/".concat(props.siteId ? "sites/" + props.siteId.replace(/[{}]/g, '') + "/" : "", "drives");
+        drives.targetInfo.endpoint = "_api/v2.0/".concat(props.siteId ? "sites/" + props.siteId.replace(/[{}]/g, '') + (props.webId ? "," + props.webId.replace(/^\{|\}$/g, '') : "") + "/" : "", "drives");
         // Add the methods
         utils_1.Request.addMethods(drives, { __metadata: { type: "@odata.context/_api/v2.0/$metadata#drives" } });
     }

package/dist/gd-sprest.d.ts

@@ -4710,9 +4710,11 @@ declare module 'gd-sprest/v2/drive' {
                 * Get the default library for a site.
                 * @param driveId - (Optional) Sets the drive to get, otherwise gets the default drive for the site.
                 * @param siteId - (Optional) The site id to target, current by default.
+                * @param siteUrl - (Optional) The site url to target, current by default.
                 * @param targetInfo - (Optional) The target information.
+                * @param webId - (Optional) The web id to target.
                 */
-            (props?: { driveId?: string, siteId?: string, siteUrl?: string, targetInfo?: ITargetInfoProps }): IBaseQuery<drive> & driveMethods;
+            (props?: { driveId?: string, siteId?: string, siteUrl?: string, targetInfo?: ITargetInfoProps, webId?: string }): IBaseQuery<drive> & driveMethods;
     }
 }
 
@@ -4745,12 +4747,12 @@ declare module 'gd-sprest/v2/drives' {
     export interface Idrives {
             /**
                 * Get the libraries for a site.
-                * @param id - (Optional) The drive id to target.
                 * @param siteId - (Optional) The site id to target, current by default.
                 * @param siteUrl - (Optional) The site url to target, current by default.
                 * @param targetInfo - (Optional) The target information.
+                * @param webId - (Optional) The web id to target.
                 */
-            (props?: { siteId?: string, siteUrl?: string, targetInfo?: ITargetInfoProps }): driveCollection;
+            (props?: { siteId?: string, siteUrl?: string, targetInfo?: ITargetInfoProps, webId?: string }): driveCollection;
     }
 }
 
@@ -7705,6 +7707,9 @@ declare module 'gd-sprest/utils/targetInfo' {
             /** The request type. */
             requestType?: number;
     
+            /** The property that contains the request response. */
+            returnProp?: string;
+    
             /** The url of the site/web to execute the request against. */
             url?: string;
     }