gd-sprest 6.9.7 → 7.0.0

package/@types/index.d.ts

@@ -1,10 +1,10 @@
 /**
  * Library
  */
-import { Apps, ContextInfo, GroupService, GroupSiteManager, HubSites, HubSitesUtility, List, Navigation, PeopleManager, PeoplePicker, ProfileLoader, Search, Site, SiteManager, SocialFeed, UserProfile, Utility, Web, ThemeManager, WorkflowInstanceService, WorkflowSubscriptionService } from "./lib";
+import { Apps, ContextInfo, GroupService, GroupSiteManager, HubSites, HubSitesUtility, List, Navigation, PeopleManager, PeoplePicker, ProfileLoader, Search, Site, SiteManager, SitePages, SocialFeed, UserProfile, Utility, Web, ThemeManager, WorkflowInstanceService, WorkflowSubscriptionService } from "./lib";
 export {
     Apps, ContextInfo, GroupService, GroupSiteManager, HubSites, HubSitesUtility,
-    List, Navigation, PeopleManager, PeoplePicker, ProfileLoader, Search, Site, SiteManager,
+    List, Navigation, PeopleManager, PeoplePicker, ProfileLoader, Search, Site, SiteManager, SitePages,
     SocialFeed, ThemeManager, UserProfile, Utility, Web, WorkflowInstanceService, WorkflowSubscriptionService
 }
 

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

@@ -13,6 +13,7 @@ export * from "./profileLoader";
 export * from "./search";
 export * from "./site";
 export * from "./siteManager";
+export * from "./sitePages";
 export * from "./socialFeed";
 export * from "./themeManager";
 export * from "./userProfile";

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

@@ -0,0 +1,43 @@
+import { SitePage, ISitePageService } from "gd-sprest-def/lib/SP/Publishing/entitytypes";
+import { ITargetInfoProps } from "../utils";
+
+/**
+ * #### REST API
+ * _api/sitePages
+ *
+ * #### Get site pages
+ *
+ * ```typescript
+ * import { Site } from "gd-sprest";
+ * 
+ * SitePages().execute(sitePages => {
+ *   // TODO
+ * });
+ * ```
+ */
+export const SitePages: ISitePages;
+
+/**
+ * Site Pages
+ * @category Site Pages
+ */
+export interface ISitePages {
+    /**
+     * Creates an instance of the site library.
+     * @param url - (Optional) The site url.
+     * @param targetInfo - (Optional) The target information.
+     */
+    (url?: string, targetInfo?: ITargetInfoProps): ISitePageService;
+
+    /**
+     * Creates a modern page.
+     * @param url - The url of the file to create.
+     * @param title - The title of the page.
+     * @param template - The type of page to create.
+     */
+    createPage(url: string, title: string, template: string): PromiseLike<{
+        file: SP.File;
+        item: SP.ListItem;
+        page: SP.Publishing.SitePage;
+    }>;
+}

package/@types/rest.d.ts

@@ -132,6 +132,11 @@ export interface IREST {
      * Use this api to create/delete site collections.
      */
     SiteManager: LibTypes.ISiteManager;
+    
+    /**
+     * Use this api to create/edit modern pages.
+     */
+    SitePages: LibTypes.ISitePages;
 
     /**
      * Use this api to see if a site collection exists.

package/@types/sptypes/index.d.ts

@@ -11,6 +11,7 @@ export interface ISPTypes {
     CheckInType: Types.ICheckInType;
     CheckOutType: Types.ICheckOutType;
     ChoiceFormatType: Types.IChoiceFormatType;
+    ClientSidePageLayout: Types.IClientSidePageLayout;
     ClientTemplateUtility: Types.IClientTemplateUtility;
     ControlMode: Types.IControlMode;
     DateFormat: Types.IDateFormat;

package/@types/sptypes/sptypes.d.ts

@@ -140,6 +140,16 @@ export type IClientTemplateUtility = {
     UserMultiValueDelimitString: string
 }
 
+/**
+ * Client Side Page Layouts
+ */
+export type IClientSidePageLayout = {
+    Article: string;
+    Home: string;
+    SingleWebPartAppPage: string;
+    RepostPage: string;
+}
+
 /**
  * Control Modes
  */

package/build/helper/fieldSchemaXML.js

@@ -8,7 +8,7 @@ var spCfg_1 = require("./spCfg");
  * Field Schema XML
  * Helper class for generating the field schema xml
  */
-exports.FieldSchemaXML = function (fieldInfo) {
+exports.FieldSchemaXML = function (fieldInfo, targetWebUrl) {
     var _resolve = null;
     // Returns the schema xml for a boolean field.
     var createBoolean = function (fieldInfo, props) {
@@ -215,7 +215,7 @@ exports.FieldSchemaXML = function (fieldInfo) {
         // See if the lookup name exists
         if (fieldInfo.listName) {
             // Get the web containing the list
-            lib_1.Web(fieldInfo.webUrl, { disableCache: true })
+            lib_1.Web(fieldInfo.webUrl || targetWebUrl, { disableCache: true })
                 // Get the list
                 .Lists(fieldInfo.listName)
                 // Set the query

package/build/helper/spCfg.js

@@ -276,7 +276,7 @@ exports.SPConfig = function (cfg, webUrl) {
                             }
                         }
                         // Compute the schema xml
-                        _1.FieldSchemaXML(cfg).then(function (response) {
+                        _1.FieldSchemaXML(cfg, webUrl).then(function (response) {
                             var schemas = typeof (response) === "string" ? [response] : response;
                             // Parse the fields to add
                             for (var i = 0; i < schemas.length; i++) {

package/build/lib/index.js

@@ -25,6 +25,7 @@ __exportStar(require("./profileLoader"), exports);
 __exportStar(require("./search"), exports);
 __exportStar(require("./site"), exports);
 __exportStar(require("./siteManager"), exports);
+__exportStar(require("./sitePages"), exports);
 __exportStar(require("./socialFeed"), exports);
 __exportStar(require("./themeManager"), exports);
 __exportStar(require("./userProfile"), exports);

package/build/lib/sitePages.js

@@ -0,0 +1,74 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SitePages = void 0;
+var web_1 = require("./web");
+var utils_1 = require("../utils");
+/**
+ * Site Pages
+ */
+exports.SitePages = (function (url, targetInfo) {
+    var sitePages = new utils_1.Base(targetInfo);
+    // Default the properties
+    sitePages.targetInfo.defaultToWebFl = true;
+    sitePages.targetInfo.endpoint = "SitePages";
+    // See if the web url exists
+    if (url) {
+        // Set the settings
+        sitePages.targetInfo.url = url;
+    }
+    // Add the methods
+    utils_1.Request.addMethods(sitePages, { __metadata: { type: "SP.Publishing.SitePageService" } });
+    // Return the site pages
+    return sitePages;
+});
+// Static method to create a modern page
+exports.SitePages.createPage = (function (pageName, pageTitle, pageTemplate, url, targetInfo) {
+    // Return a promise
+    return new Promise(function (resolve, reject) {
+        // Method called after the updates have completed
+        var onComplete = function (itemId, fileUrl) {
+            var web = web_1.Web(url, targetInfo);
+            var results = { file: null, item: null, page: null };
+            // Get the file
+            web.getFileByUrl(fileUrl).query({ Select: ["*", "ListId"] }).execute(function (file) {
+                // Set the file
+                results.file = file;
+                // Get the list
+                web.Lists().getById(file.ListId).Items(itemId).execute(function (item) {
+                    // Set the item
+                    results.item = item;
+                    // Get the page
+                    exports.SitePages(url, targetInfo).Pages(itemId).execute(function (page) {
+                        // Set the page
+                        results.page = page;
+                        // Resolve the request
+                        resolve(results);
+                    }, reject);
+                }, reject);
+            }, reject);
+        };
+        // Create the page
+        exports.SitePages(url, targetInfo).Pages().createAppPage({
+            Title: pageTitle,
+            PageLayoutType: pageTemplate
+        }).execute(function (page) {
+            // Update the file name
+            web_1.Web(url, targetInfo).Lists("Site Pages").Items(page.Id).update({
+                FileLeafRef: pageName
+            }).execute(
+            // Updated the file name successfully
+            function () {
+                // Update the file url
+                var idx = page.Url.lastIndexOf('/');
+                var fileUrl = page.Url.substring(0, idx + 1) + pageName;
+                // Complete the request
+                onComplete(page.Id, fileUrl);
+            }, 
+            // Unable to update the file name, but still return the object
+            function () {
+                // Complete the request
+                onComplete(page.Id, page.Url);
+            });
+        }, reject);
+    });
+});

package/build/mapper/def.js

@@ -927,14 +927,17 @@ exports.Mapper = {
         },
         updateWebPartData: {
             argNames: ["webPartDataAsJson"],
+            requestType: utils_1.RequestType.PostWithArgsInBody
         },
     },
     "Microsoft.SharePoint.ClientSideComponent.HostedAppsManager": {
         add: {
             argNames: ["webPartDataAsJson", "hostType"],
+            requestType: utils_1.RequestType.PostWithArgsInBody
         },
         addEx: {
             argNames: ["webPartDataAsJson", "hostType"],
+            requestType: utils_1.RequestType.PostWithArgsInBody
         },
         getById: {
             argNames: ["id"],
@@ -4635,36 +4638,63 @@ exports.Mapper = {
         boostNews: {
             argNames: ["SitePageBoost"],
         },
-        checkOut: {},
-        checkoutPage: {},
-        copy: {},
+        checkOut: {
+            requestType: utils_1.RequestType.Post
+        },
+        checkoutPage: {
+            requestType: utils_1.RequestType.Post
+        },
+        copy: {
+            requestType: utils_1.RequestType.Post
+        },
         copyWithConfiguration: {
             argNames: ["sitePageFlags", "isNews"],
+            requestType: utils_1.RequestType.Post
+        },
+        createNewsCopy: {
+            requestType: utils_1.RequestType.Post
+        },
+        demoteFromNews: {
+            requestType: utils_1.RequestType.Post
+        },
+        discardPage: {
+            requestType: utils_1.RequestType.Post
         },
-        createNewsCopy: {},
-        demoteFromNews: {},
-        discardPage: {},
         getVersion: {
             argNames: ["versionId"],
         },
-        promoteToNews: {},
-        publish: {},
-        query: { argNames: ["oData"] },
+        promoteToNews: {
+            requestType: utils_1.RequestType.Post
+        },
+        publish: {
+            requestType: utils_1.RequestType.Post
+        },
+        query: {
+            argNames: ["oData"],
+            requestType: utils_1.RequestType.OData
+        },
         saveDraft: {
             argNames: ["sitePage"],
+            requestType: utils_1.RequestType.Post
         },
         savePage: {
             argNames: ["pageStream"],
+            requestType: utils_1.RequestType.Post
         },
         savePageAsDraft: {
             argNames: ["pageStream"],
+            requestType: utils_1.RequestType.Post
+        },
+        savePageAsTemplate: {
+            requestType: utils_1.RequestType.Post
         },
-        savePageAsTemplate: {},
         schedulePublish: {
             argNames: ["sitePage"],
+            requestType: utils_1.RequestType.Post
         },
         sharePagePreviewByEmail: {
             argNames: ["message", "recipientEmails"],
+            requestType: utils_1.RequestType.Post
         },
         update: {
             metadataType: "",
@@ -4675,7 +4705,10 @@ exports.Mapper = {
     },
     "SP.Publishing.SitePage.Collection": {
         createAppPage: {
-            argNames: ["webPartDataAsJson"]
+            argNames: ["webPartDataAsJson"],
+            metadataType: "SP.Publishing.SitePage",
+            name: "",
+            requestType: utils_1.RequestType.PostBodyNoArgs
         },
         ensureTitleResource: {},
         feed: {
@@ -4705,10 +4738,12 @@ exports.Mapper = {
         query: { argNames: ["oData"], requestType: utils_1.RequestType.OData },
         templates: {},
         updateAppPage: {
-            argNames: ["pageId", "webPartDataAsJson", "title", "includeInNavigation"]
+            argNames: ["pageId", "webPartDataAsJson", "title", "includeInNavigation"],
+            requestType: utils_1.RequestType.PostWithArgsInBody
         },
         updateFullPageApp: {
-            argNames: ["serverRelativeUrl", "webPartDataAsJson"]
+            argNames: ["serverRelativeUrl", "webPartDataAsJson"],
+            requestType: utils_1.RequestType.PostWithArgsInBody
         }
     },
     "SP.Publishing.SitePage3D": {
@@ -4758,11 +4793,17 @@ exports.Mapper = {
         query: { argNames: ["oData"], requestType: utils_1.RequestType.OData },
     },
     "SP.Publishing.SitePageService": {
+        properties: [
+            "CommunicationSite|SP.Publishing.CommunicationSite",
+            "Pages|SP.Publishing.SitePage.Collection|('[Name]')|SP.Publishing.SitePage"
+        ],
         addImage: {
             argNames: ["pageName", "imageFileName", "imageStream", "pageId"],
+            requestType: utils_1.RequestType.PostWithArgs
         },
         addImageFromExternalUrl: {
             argNames: ["pageName", "imageFileName", "externalUrl", "subFolderName", "pageId"],
+            requestType: utils_1.RequestType.PostWithArgs
         },
         canCreatePage: {},
         canCreatePromotedPage: {},

package/build/rest.js

@@ -8,7 +8,7 @@ var sptypes_1 = require("./sptypes");
  * SharePoint REST Library
  */
 exports.$REST = {
-    __ver: 6.97,
+    __ver: 7.00,
     AppContext: function (siteUrl) { return Lib.Site.getAppContext(siteUrl); },
     Apps: Lib.Apps,
     ContextInfo: Lib.ContextInfo,
@@ -30,6 +30,7 @@ exports.$REST = {
     Search: Lib.Search,
     Site: Lib.Site,
     SiteManager: Lib.SiteManager,
+    SitePages: Lib.SitePages,
     SiteExists: function (url) { return Lib.Site.exists(url); },
     SiteUrl: function (id) { return Lib.Site.getUrlById(id); },
     SPTypes: sptypes_1.SPTypes,

package/build/sptypes/sptypes.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.WebTemplateType = exports.ViewType = exports.UserCustomActionRegistrationType = exports.URLZones = exports.UrlFormatType = exports.StatusPriColor = exports.RoleType = exports.ReorderingRuleMatchType = exports.RenderListDataOptions = exports.RelationshipDeleteBehaviorType = exports.PrincipalTypes = exports.PrincipalSources = exports.PersonalSiteCapabilities = exports.PersonalizationScope = exports.PageType = exports.ModalDialogResult = exports.LocaleLCIDType = exports.ListTemplateType = exports.ListExperienceOptions = exports.FriendlyDateFormat = exports.FileTemplateType = exports.FileLevelType = exports.FieldUserSelectionType = exports.FieldType = exports.FieldResultType = exports.FieldNumberType = exports.FieldNoteType = exports.EventReceiverType = exports.EventReceiverSynchronizationType = exports.DraftVisibilityType = exports.DateFormat = exports.ControlMode = exports.ClientTemplatesUtility = exports.ChoiceFormatType = exports.CheckOutType = exports.CheckInType = exports.CalendarTypes = exports.BasePermissionTypes = void 0;
+exports.WebTemplateType = exports.ViewType = exports.UserCustomActionRegistrationType = exports.URLZones = exports.UrlFormatType = exports.StatusPriColor = exports.RoleType = exports.ReorderingRuleMatchType = exports.RenderListDataOptions = exports.RelationshipDeleteBehaviorType = exports.PrincipalTypes = exports.PrincipalSources = exports.PersonalSiteCapabilities = exports.PersonalizationScope = exports.PageType = exports.ModalDialogResult = exports.LocaleLCIDType = exports.ListTemplateType = exports.ListExperienceOptions = exports.FriendlyDateFormat = exports.FileTemplateType = exports.FileLevelType = exports.FieldUserSelectionType = exports.FieldType = exports.FieldResultType = exports.FieldNumberType = exports.FieldNoteType = exports.EventReceiverType = exports.EventReceiverSynchronizationType = exports.DraftVisibilityType = exports.DateFormat = exports.ControlMode = exports.ClientSidePageLayout = exports.ClientTemplatesUtility = exports.ChoiceFormatType = exports.CheckOutType = exports.CheckInType = exports.CalendarTypes = exports.BasePermissionTypes = void 0;
 /**
  * Base Permission Types
  */
@@ -81,6 +81,15 @@ exports.ClientTemplatesUtility = {
     UserLookupDelimitString: ";#",
     UserMultiValueDelimitString: ",#"
 };
+/**
+ * Client Side Templates
+ */
+exports.ClientSidePageLayout = {
+    Article: "Article",
+    Home: "Home",
+    RepostPage: "RepostPage",
+    SingleWebPartAppPage: "SingleWebPartAppPage"
+};
 /**
  * Control Modes
  */

package/build/utils/request.js

@@ -321,9 +321,16 @@ exports.Request = {
                             }
                             else {
                                 // Validate the data collection
-                                exports.Request.validateDataCollectionResults(base).then(function () {
+                                exports.Request.validateDataCollectionResults(base).then(
+                                // Success
+                                function () {
                                     // Execute the callback
                                     callback ? callback(base, errorFl) : null;
+                                }, 
+                                // Error
+                                function () {
+                                    // Execute the callback and set the error flag
+                                    callback ? callback(base, true) : null;
                                 });
                             }
                         }
@@ -541,8 +548,16 @@ exports.Request = {
             var request = function (xhr, resolve) {
                 // Validate the response
                 if (xhr && xhr.status < 400 && typeof (xhr.response) === "string" && xhr.response.length > 0) {
-                    // Convert the response and ensure the data property exists
-                    var data = JSON.parse(xhr.response);
+                    // Try to convert the response and ensure the data property exists
+                    var data = null;
+                    try {
+                        data = JSON.parse(xhr.response);
+                    }
+                    // Reject the request
+                    catch (_a) {
+                        reject();
+                        return;
+                    }
                     // Set the next item flag
                     base.nextFl = data.d && data.d.__next;
                     // See if there are more items to get

package/dist/gd-sprest.d.ts

@@ -10,6 +10,7 @@
 //   ../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/entitytypes
+//   ../gd-sprest-def/lib/SP/Publishing/entitytypes
 //   ../gd-sprest-def/lib/SP/Social/complextypes
 //   ../gd-sprest-def/lib/SP/Social/entitytypes
 //   ../gd-sprest-def/lib/SP/Utilities/entitytypes
@@ -24,10 +25,10 @@ declare module 'gd-sprest' {
     /**
         * Library
         */
-    import { Apps, ContextInfo, GroupService, GroupSiteManager, HubSites, HubSitesUtility, List, Navigation, PeopleManager, PeoplePicker, ProfileLoader, Search, Site, SiteManager, SocialFeed, UserProfile, Utility, Web, ThemeManager, WorkflowInstanceService, WorkflowSubscriptionService } from "gd-sprest/lib";
+    import { Apps, ContextInfo, GroupService, GroupSiteManager, HubSites, HubSitesUtility, List, Navigation, PeopleManager, PeoplePicker, ProfileLoader, Search, Site, SiteManager, SitePages, SocialFeed, UserProfile, Utility, Web, ThemeManager, WorkflowInstanceService, WorkflowSubscriptionService } from "gd-sprest/lib";
     export {
             Apps, ContextInfo, GroupService, GroupSiteManager, HubSites, HubSitesUtility,
-            List, Navigation, PeopleManager, PeoplePicker, ProfileLoader, Search, Site, SiteManager,
+            List, Navigation, PeopleManager, PeoplePicker, ProfileLoader, Search, Site, SiteManager, SitePages,
             SocialFeed, ThemeManager, UserProfile, Utility, Web, WorkflowInstanceService, WorkflowSubscriptionService
     }
     
@@ -77,6 +78,7 @@ declare module 'gd-sprest/lib' {
     export * from "gd-sprest/lib/search";
     export * from "gd-sprest/lib/site";
     export * from "gd-sprest/lib/siteManager";
+    export * from "gd-sprest/lib/sitePages";
     export * from "gd-sprest/lib/socialFeed";
     export * from "gd-sprest/lib/themeManager";
     export * from "gd-sprest/lib/userProfile";
@@ -297,6 +299,11 @@ declare module 'gd-sprest/rest' {
                 */
             SiteManager: LibTypes.ISiteManager;
     
+            /**
+                * Use this api to create/edit modern pages.
+                */
+            SitePages: LibTypes.ISitePages;
+    
             /**
                 * Use this api to see if a site collection exists.
                 * @param url - The absolute url of the site collection.
@@ -370,6 +377,7 @@ declare module 'gd-sprest/sptypes' {
         CheckInType: Types.ICheckInType;
         CheckOutType: Types.ICheckOutType;
         ChoiceFormatType: Types.IChoiceFormatType;
+        ClientSidePageLayout: Types.IClientSidePageLayout;
         ClientTemplateUtility: Types.IClientTemplateUtility;
         ControlMode: Types.IControlMode;
         DateFormat: Types.IDateFormat;
@@ -1407,6 +1415,52 @@ declare module 'gd-sprest/lib/siteManager' {
     }
 }
 
+declare module 'gd-sprest/lib/sitePages' {
+    import { SitePage, ISitePageService } from "gd-sprest-def/lib/SP/Publishing/entitytypes";
+    import { ITargetInfoProps } from "gd-sprest/utils";
+    
+    /**
+        * #### REST API
+        * _api/sitePages
+        *
+        * #### Get site pages
+        *
+        * ```typescript
+        * import { Site } from "gd-sprest";
+        * 
+        * SitePages().execute(sitePages => {
+        *   // TODO
+        * });
+        * ```
+        */
+    export const SitePages: ISitePages;
+    
+    /**
+        * Site Pages
+        * @category Site Pages
+        */
+    export interface ISitePages {
+            /**
+                * Creates an instance of the site library.
+                * @param url - (Optional) The site url.
+                * @param targetInfo - (Optional) The target information.
+                */
+            (url?: string, targetInfo?: ITargetInfoProps): ISitePageService;
+    
+            /**
+                * Creates a modern page.
+                * @param url - The url of the file to create.
+                * @param title - The title of the page.
+                * @param template - The type of page to create.
+                */
+            createPage(url: string, title: string, template: string): PromiseLike<{
+                    file: SP.File;
+                    item: SP.ListItem;
+                    page: SP.Publishing.SitePage;
+            }>;
+    }
+}
+
 declare module 'gd-sprest/lib/socialFeed' {
     import { IBaseExecution } from "gd-sprest-def/lib/base";
     import { SocialPostCreationData } from "gd-sprest-def/lib/SP/Social/complextypes";
@@ -3976,6 +4030,16 @@ declare module 'gd-sprest/sptypes/sptypes' {
             UserMultiValueDelimitString: string
     }
     
+    /**
+        * Client Side Page Layouts
+        */
+    export type IClientSidePageLayout = {
+            Article: string;
+            Home: string;
+            SingleWebPartAppPage: string;
+            RepostPage: string;
+    }
+    
     /**
         * Control Modes
         */