Merge pull request #310 from gunjandatta/gdatta

Updated API to Sept 2024

.github/workflows/build.yml

@@ -7,7 +7,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        node-version: [14.x]
+        node-version: [18.x]
     steps:
     - uses: actions/checkout@v2
 
@@ -23,7 +23,7 @@ jobs:
         npm run test --if-present
 
     - name: Build Artifacts
-      uses: actions/upload-artifact@v1
+      uses: actions/upload-artifact@v4
       with:
         name: dist
         path: dist

@types/helper/listForm.d.ts

@@ -34,6 +34,9 @@ export interface IListForm {
      */
     refreshItem(info: IListFormResult): PromiseLike<IListFormResult>;
 
+    /** Method to refresh the request digest value. */
+    refreshRequestDigest(info: IListFormResult): PromiseLike<void>;
+
     /**
      * Method to remove attachment from an item.
      */

@types/helper/methods/loadSPCore.d.ts

@@ -4,5 +4,5 @@
  */
 export const loadSPCore: IloadSPCore;
 export interface IloadSPCore {
-    (): PromiseLike<void>;
+    (additionalLibs?: string[]): PromiseLike<void>;
 }

@types/helper/spCfg.d.ts

@@ -60,6 +60,9 @@ export interface IFieldInfo {
     /** True for hidden fields. */
     hidden?: boolean;
 
+    /** The guid of the field. */
+    id?: string;
+
     /** True to index the field. */
     indexed?: boolean;
 
@@ -285,6 +288,11 @@ export interface IFieldInfoUser extends IFieldInfo {
  * SharePoint Configuration - Content Type Information
  */
 export interface ISPCfgContentTypeInfo extends ContentTypeCreationInformation {
+    /**
+     * The client form custom formatter.
+     */
+    ClientFormCustomFormatter?: string;
+
     /**
      * The content type. (This value is set internally.)
      */
@@ -408,15 +416,30 @@ export interface ISPCfgListInfo {
  * SharePoint Configuration - View Information
  */
 export interface ISPCfgViewInfo {
+    /** Custom formatter */
+    CustomFormatter?: string;
+
     /** Flag to set the view as the default view. */
     Default?: boolean;
 
     /** The JSLink property. */
     JSLink?: string;
 
+    /** Flag to set the view as hidden. */
+    Hidden?: boolean;
+
+    /** Flag to set the default mobile view. */
+    MobileDefaultView?: boolean;
+
+    /** Flag to set the view for mobile. */
+    MobileView?: boolean;
+
     /** The row limit property. */
     RowLimit?: number;
 
+    /** Flag to enable the tabular view option. */
+    Tabular?: boolean;
+
     /** The view fields. */
     ViewFields?: Array<string>;
 
@@ -504,6 +527,9 @@ export interface ISPConfigProps {
     /** The list configuration. */
     ListCfg?: Array<ISPCfgListInfo>;
 
+    /** Event for the logging of the configuration. */
+    onLogMessage?: (msg: string, isError?: boolean) => void;
+
     /** The web part configuration. */
     WebPartCfg?: Array<ISPCfgWebPartInfo>;
 }

@types/lib/search.d.ts

@@ -54,5 +54,5 @@ export interface ISearch {
      * Method to execute a post query
      * @param 
      */
-    postQuery(props: ISearchPostQuery): PromiseLike<SearchResult>;
+    postQuery<T = any>(props: ISearchPostQuery): PromiseLike<SearchResult<T>>;
 }

@types/utils/helper.d.ts

@@ -44,4 +44,7 @@ export interface IBaseHelper {
 
     /** Updates the metdata uri. */
     updateMetadataUri(base: IBase, metadata, targetInfo: ITargetInfoProps);
+
+    /** Updates the search results. */
+    updateSearchResults(base: IBase);
 }

dist/gd-sprest.d.ts

@@ -1654,7 +1654,7 @@ declare module 'gd-sprest/lib/search' {
                 * Method to execute a post query
                 * @param 
                 */
-            postQuery(props: ISearchPostQuery): PromiseLike<SearchResult>;
+            postQuery<T = any>(props: ISearchPostQuery): PromiseLike<SearchResult<T>>;
     }
 }
 
@@ -2401,6 +2401,9 @@ declare module 'gd-sprest/helper/listForm' {
                 */
             refreshItem(info: IListFormResult): PromiseLike<IListFormResult>;
 
+            /** Method to refresh the request digest value. */
+            refreshRequestDigest(info: IListFormResult): PromiseLike<void>;
+
             /**
                 * Method to remove attachment from an item.
                 */
@@ -3537,6 +3540,9 @@ declare module 'gd-sprest/helper/spCfg' {
             /** True for hidden fields. */
             hidden?: boolean;
 
+            /** The guid of the field. */
+            id?: string;
+
             /** True to index the field. */
             indexed?: boolean;
 
@@ -3762,6 +3768,11 @@ declare module 'gd-sprest/helper/spCfg' {
         * SharePoint Configuration - Content Type Information
         */
     export interface ISPCfgContentTypeInfo extends ContentTypeCreationInformation {
+            /**
+                * The client form custom formatter.
+                */
+            ClientFormCustomFormatter?: string;
+
             /**
                 * The content type. (This value is set internally.)
                 */
@@ -3885,15 +3896,30 @@ declare module 'gd-sprest/helper/spCfg' {
         * SharePoint Configuration - View Information
         */
     export interface ISPCfgViewInfo {
+            /** Custom formatter */
+            CustomFormatter?: string;
+
             /** Flag to set the view as the default view. */
             Default?: boolean;
 
             /** The JSLink property. */
             JSLink?: string;
 
+            /** Flag to set the view as hidden. */
+            Hidden?: boolean;
+
+            /** Flag to set the default mobile view. */
+            MobileDefaultView?: boolean;
+
+            /** Flag to set the view for mobile. */
+            MobileView?: boolean;
+
             /** The row limit property. */
             RowLimit?: number;
 
+            /** Flag to enable the tabular view option. */
+            Tabular?: boolean;
+
             /** The view fields. */
             ViewFields?: Array<string>;
 
@@ -3981,6 +4007,9 @@ declare module 'gd-sprest/helper/spCfg' {
             /** The list configuration. */
             ListCfg?: Array<ISPCfgListInfo>;
 
+            /** Event for the logging of the configuration. */
+            onLogMessage?: (msg: string, isError?: boolean) => void;
+
             /** The web part configuration. */
             WebPartCfg?: Array<ISPCfgWebPartInfo>;
     }
@@ -6888,7 +6917,7 @@ declare module 'gd-sprest/helper/methods/loadSPCore' {
       */
     export const loadSPCore: IloadSPCore;
     export interface IloadSPCore {
-        (): PromiseLike<void>;
+        (additionalLibs?: string[]): PromiseLike<void>;
     }
 }
 
@@ -7103,6 +7132,9 @@ declare module 'gd-sprest/utils/helper' {
 
         /** Updates the metdata uri. */
         updateMetadataUri(base: IBase, metadata, targetInfo: ITargetInfoProps);
+
+        /** Updates the search results. */
+        updateSearchResults(base: IBase);
     }
 }
 

package.json

@@ -1,6 +1,6 @@
 {
     "name": "gd-sprest",
-    "version": "7.8.9",
+    "version": "8.2.4",
     "description": "An easy way to develop against the SharePoint REST API.",
     "author": "Gunjan Datta <[email protected]> (https://gunjandatta.github.io)",
     "license": "MIT",
@@ -24,7 +24,7 @@
     },
     "homepage": "https://dattabase.com",
     "dependencies": {
-        "gd-sprest-def": "^1.4.6"
+        "gd-sprest-def": "^1.4.9"
     },
     "devDependencies": {
         "@babel/core": "^7.18.10",

src/helper/fieldSchemaXML.ts

@@ -13,6 +13,7 @@ import { SPCfgFieldType } from "./spCfg";
  */
 export const FieldSchemaXML = (fieldInfo: IFieldInfo, targetWebUrl?: string): PromiseLike<string> => {
     let _resolve = null;
+    let _reject = null;
 
     // Returns the schema xml for a boolean field.
     let createBoolean = (fieldInfo: IFieldInfo, props: object) => {
@@ -249,6 +250,9 @@ export const FieldSchemaXML = (fieldInfo: IFieldInfo, targetWebUrl?: string): Pr
 
                     // Resolve the request
                     _resolve("<Field " + toString(props) + " />");
+                }, () => {
+                    // Error getting the lookup list
+                    _reject("Error getting the lookup list.");
                 });
         } else {
             // Set the list id
@@ -417,8 +421,9 @@ export const FieldSchemaXML = (fieldInfo: IFieldInfo, targetWebUrl?: string): Pr
 
     // Return a promise
     return new Promise((resolve, reject) => {
-        // Set the resolve method
+        // Set the resolve/reject methods
         _resolve = resolve;
+        _reject = reject;
 
         // See if the schema xml has been defined
         if (fieldInfo.schemaXml) {
@@ -427,7 +432,7 @@ export const FieldSchemaXML = (fieldInfo: IFieldInfo, targetWebUrl?: string): Pr
         } else {
             // Set the base properties
             let props = {};
-            props["ID"] = "{" + ContextInfo.generateGUID() + "}";
+            props["ID"] = fieldInfo.id || "{" + ContextInfo.generateGUID() + "}";
             props["Name"] = fieldInfo.name;
             props["StaticName"] = fieldInfo.name;
             props["DisplayName"] = fieldInfo.title || fieldInfo.name;

src/helper/listForm.ts

@@ -3,7 +3,7 @@ import {
     IListFormResult, IListFormProps
 } from "../../@types/helper";
 import { IODataQuery, SP } from "gd-sprest-def";
-import { SPTypes, Web } from "..";
+import { ContextInfo, SPTypes, Web } from "..";
 import { Types } from "../../@types";
 
 /**
@@ -496,6 +496,22 @@ export const ListForm: IListForm = {
         });
     },
 
+    // Method to refresh the request digest value
+    refreshRequestDigest: (info: IListFormResult): PromiseLike<void> => {
+        // Return a promise
+        return new Promise((resolve, reject) => {
+            // Get the context info
+            ContextInfo.getWeb(info.webUrl).execute(context => {
+                // Update the request digest value
+                info.item.updateRequestDigest(context.GetContextWebInformation.FormDigestValue);
+                info.list.updateRequestDigest(context.GetContextWebInformation.FormDigestValue);
+
+                // Resolve the request
+                resolve();
+            }, reject);
+        });
+    },
+
     // Method to remove attachments from an item
     removeAttachment: (info: IListFormResult, fileName: string): PromiseLike<IListFormResult> => {
         // Return a promise
@@ -581,7 +597,7 @@ export const ListForm: IListForm = {
                         // Resolve the promise
                         resolve(info);
                     }, reject);
-                });
+                }, reject);
             } else {
                 // Set the metadata type
                 formValues["__metadata"] = { type: info.list.ListItemEntityTypeFullName };
@@ -597,7 +613,7 @@ export const ListForm: IListForm = {
                         ListForm.refreshItem(info).then(info => {
                             // Resolve the promise
                             resolve(info);
-                        });
+                        }, reject);
                     }, reject);
             }
         });

src/helper/methods/createContentType.ts

@@ -37,7 +37,7 @@ export const createContentType: IcreateContentType = (ctInfo: ContentTypeCreatio
             // Success
             () => {
                 // Set the content type collection
-                let cts = (listName ? Web().Lists(listName) : Web()).ContentTypes();
+                let cts = (listName ? Web(webUrl).Lists(listName) : Web(webUrl)).ContentTypes();
 
                 // Find the content type
                 cts.query({ Filter: "Name eq '" + ctInfo.Name + "'" }).execute(cts => {