gd-sprest 8.2.9 → 8.3.0

package/@types/helper/methods/index.d.ts

@@ -11,4 +11,5 @@ export * from "./parse";
 export * from "./request";
 export * from "./setContentTypeFields";
 export * from "./setGroupOwner";
+export * from "./setWebProperty";
 export * from "./stringify";

package/@types/helper/methods/setWebProperty.d.ts

@@ -0,0 +1,11 @@
+/**
+ * Adds or updates a key/value pair for a web's property bag
+ * This uses JSOM to set a web's property. The REST API doesn't support this at the moment.
+ * @param key The property key.
+ * @param value The property value.
+ * @param siteUrl The site url to apply the property to. If blank, it will default to the current web.
+ */
+export const setWebProperty: IsetWebProperty;
+export interface IsetWebProperty {
+    (key: string, value: string, siteUrl?: string): PromiseLike<void>;
+}

package/build/helper/methods/index.js

@@ -23,4 +23,5 @@ __exportStar(require("./parse"), exports);
 __exportStar(require("./request"), exports);
 __exportStar(require("./setContentTypeFields"), exports);
 __exportStar(require("./setGroupOwner"), exports);
+__exportStar(require("./setWebProperty"), exports);
 __exportStar(require("./stringify"), exports);

package/build/helper/methods/setWebProperty.js

@@ -0,0 +1,23 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.setWebProperty = void 0;
+/**
+ * Adds or updates a key/value pair for a web's property bag
+ * This uses JSOM to set a web's property. The REST API doesn't support this at the moment.
+ */
+exports.setWebProperty = function (key, value, siteUrl) {
+    // Return a promise
+    return new Promise(function (resolve, reject) {
+        // Get the site groups
+        var context = siteUrl ? new SP.ClientContext(siteUrl) : SP.ClientContext.get_current();
+        var web = context.get_web();
+        var allProps = web.get_allProperties();
+        // Set the property
+        allProps.set_item(key, value);
+        // Save the changes
+        context.load(web);
+        web.update();
+        // Execute the request
+        context.executeQueryAsync(resolve, reject);
+    });
+};

package/build/rest.js

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

package/dist/gd-sprest.d.ts

@@ -4425,6 +4425,7 @@ declare module 'gd-sprest/helper/methods' {
     export * from "gd-sprest/helper/methods/request";
     export * from "gd-sprest/helper/methods/setContentTypeFields";
     export * from "gd-sprest/helper/methods/setGroupOwner";
+    export * from "gd-sprest/helper/methods/setWebProperty";
     export * from "gd-sprest/helper/methods/stringify";
 }
 
@@ -6989,6 +6990,20 @@ declare module 'gd-sprest/helper/methods/setGroupOwner' {
     }
 }
 
+declare module 'gd-sprest/helper/methods/setWebProperty' {
+    /**
+      * Adds or updates a key/value pair for a web's property bag
+      * This uses JSOM to set a web's property. The REST API doesn't support this at the moment.
+      * @param key The property key.
+      * @param value The property value.
+      * @param siteUrl The site url to apply the property to. If blank, it will default to the current web.
+      */
+    export const setWebProperty: IsetWebProperty;
+    export interface IsetWebProperty {
+        (key: string, value: string, siteUrl?: string): PromiseLike<void>;
+    }
+}
+
 declare module 'gd-sprest/helper/methods/stringify' {
     /**
       * Convert an object to a string