@pnp/sp 2.10.0 → 2.11.0

package/user-custom-actions/web.js

@@ -1,5 +1,5 @@
-import { addProp } from "@pnp/odata";
-import { _Web } from "../webs/types.js";
-import { UserCustomActions } from "./types.js";
-addProp(_Web, "userCustomActions", UserCustomActions);
+import { addProp } from "@pnp/odata";
+import { _Web } from "../webs/types.js";
+import { UserCustomActions } from "./types.js";
+addProp(_Web, "userCustomActions", UserCustomActions);
 //# sourceMappingURL=web.js.map

package/utils/escapeQueryStrValue.d.ts

@@ -1,2 +1,2 @@
-export declare function escapeQueryStrValue(value: string): string;
+export declare function escapeQueryStrValue(value: string): string;
 //# sourceMappingURL=escapeQueryStrValue.d.ts.map

package/utils/escapeQueryStrValue.js

@@ -1,20 +1,20 @@
-import { stringIsNullOrEmpty } from "@pnp/common";
-import { Logger } from "@pnp/logging";
-export function escapeQueryStrValue(value) {
-    if (stringIsNullOrEmpty(value)) {
-        return "";
-    }
-    // replace all instance of ' with ''
-    if (/!(@.*?)::(.*?)/ig.test(value)) {
-        // to ensure our param aliasing still works we need to treat these special or we'll hear about it
-        // so we encode JUST the part that will end up in the url
-        return value.replace(/!(@.*?)::(.*)$/ig, function (match, labelName, v) {
-            Logger.write("Rewriting aliased parameter from match " + match + " to label: " + labelName + " value: " + v, 0 /* Verbose */);
-            return "!" + labelName + "::" + encodeURIComponent(v.replace(/'/ig, "''"));
-        });
-    }
-    else {
-        return encodeURIComponent(value.replace(/'/ig, "''"));
-    }
-}
+import { stringIsNullOrEmpty } from "@pnp/common";
+import { Logger } from "@pnp/logging";
+export function escapeQueryStrValue(value) {
+    if (stringIsNullOrEmpty(value)) {
+        return "";
+    }
+    // replace all instance of ' with ''
+    if (/!(@.*?)::(.*?)/ig.test(value)) {
+        // to ensure our param aliasing still works we need to treat these special or we'll hear about it
+        // so we encode JUST the part that will end up in the url
+        return value.replace(/!(@.*?)::(.*)$/ig, function (match, labelName, v) {
+            Logger.write("Rewriting aliased parameter from match " + match + " to label: " + labelName + " value: " + v, 0 /* Verbose */);
+            return "!" + labelName + "::" + encodeURIComponent(v.replace(/'/ig, "''"));
+        });
+    }
+    else {
+        return encodeURIComponent(value.replace(/'/ig, "''"));
+    }
+}
 //# sourceMappingURL=escapeQueryStrValue.js.map

package/utils/extractweburl.d.ts

@@ -1,2 +1,2 @@
-export declare function extractWebUrl(candidateUrl: string): string;
+export declare function extractWebUrl(candidateUrl: string): string;
 //# sourceMappingURL=extractweburl.d.ts.map

package/utils/extractweburl.js

@@ -1,16 +1,16 @@
-import { stringIsNullOrEmpty } from "@pnp/common";
-export function extractWebUrl(candidateUrl) {
-    if (stringIsNullOrEmpty(candidateUrl)) {
-        return "";
-    }
-    var index = candidateUrl.indexOf("_api/");
-    if (index < 0) {
-        index = candidateUrl.indexOf("_vti_bin/");
-    }
-    if (index > -1) {
-        return candidateUrl.substr(0, index);
-    }
-    // if all else fails just give them what they gave us back
-    return candidateUrl;
-}
+import { stringIsNullOrEmpty } from "@pnp/common";
+export function extractWebUrl(candidateUrl) {
+    if (stringIsNullOrEmpty(candidateUrl)) {
+        return "";
+    }
+    var index = candidateUrl.indexOf("_api/");
+    if (index < 0) {
+        index = candidateUrl.indexOf("_vti_bin/");
+    }
+    if (index > -1) {
+        return candidateUrl.substr(0, index);
+    }
+    // if all else fails just give them what they gave us back
+    return candidateUrl;
+}
 //# sourceMappingURL=extractweburl.js.map

package/utils/file-names.d.ts

@@ -1,18 +1,18 @@
-/**
- * Checks if file or folder name contains invalid characters
- *
- * @param input File or folder name to check
- * @param onPremise Set to true for SharePoint On-Premise
- * @returns True if contains invalid chars, false otherwise
- */
-export declare function containsInvalidFileFolderChars(input: string, onPremise?: boolean): boolean;
-/**
- * Removes invalid characters from file or folder name
- *
- * @param input File or folder name
- * @param replacer Value that will replace invalid characters
- * @param onPremise Set to true for SharePoint On-Premise
- * @returns File or folder name with replaced invalid characters
- */
-export declare function stripInvalidFileFolderChars(input: string, replacer?: string, onPremise?: boolean): string;
+/**
+ * Checks if file or folder name contains invalid characters
+ *
+ * @param input File or folder name to check
+ * @param onPremise Set to true for SharePoint On-Premise
+ * @returns True if contains invalid chars, false otherwise
+ */
+export declare function containsInvalidFileFolderChars(input: string, onPremise?: boolean): boolean;
+/**
+ * Removes invalid characters from file or folder name
+ *
+ * @param input File or folder name
+ * @param replacer Value that will replace invalid characters
+ * @param onPremise Set to true for SharePoint On-Premise
+ * @returns File or folder name with replaced invalid characters
+ */
+export declare function stripInvalidFileFolderChars(input: string, replacer?: string, onPremise?: boolean): string;
 //# sourceMappingURL=file-names.d.ts.map

package/utils/file-names.js

@@ -1,39 +1,39 @@
-// eslint-disable-next-line no-control-regex
-var InvalidFileFolderNameCharsOnlineRegex = /["*:<>?/\\|\x00-\x1f\x7f-\x9f]/g;
-// eslint-disable-next-line no-control-regex
-var InvalidFileFolderNameCharsOnPremiseRegex = /["#%*:<>?/\\|\x00-\x1f\x7f-\x9f]/g;
-/**
- * Checks if file or folder name contains invalid characters
- *
- * @param input File or folder name to check
- * @param onPremise Set to true for SharePoint On-Premise
- * @returns True if contains invalid chars, false otherwise
- */
-export function containsInvalidFileFolderChars(input, onPremise) {
-    if (onPremise === void 0) { onPremise = false; }
-    if (onPremise) {
-        return InvalidFileFolderNameCharsOnPremiseRegex.test(input);
-    }
-    else {
-        return InvalidFileFolderNameCharsOnlineRegex.test(input);
-    }
-}
-/**
- * Removes invalid characters from file or folder name
- *
- * @param input File or folder name
- * @param replacer Value that will replace invalid characters
- * @param onPremise Set to true for SharePoint On-Premise
- * @returns File or folder name with replaced invalid characters
- */
-export function stripInvalidFileFolderChars(input, replacer, onPremise) {
-    if (replacer === void 0) { replacer = ""; }
-    if (onPremise === void 0) { onPremise = false; }
-    if (onPremise) {
-        return input.replace(InvalidFileFolderNameCharsOnPremiseRegex, replacer);
-    }
-    else {
-        return input.replace(InvalidFileFolderNameCharsOnlineRegex, replacer);
-    }
-}
+// eslint-disable-next-line no-control-regex
+var InvalidFileFolderNameCharsOnlineRegex = /["*:<>?/\\|\x00-\x1f\x7f-\x9f]/g;
+// eslint-disable-next-line no-control-regex
+var InvalidFileFolderNameCharsOnPremiseRegex = /["#%*:<>?/\\|\x00-\x1f\x7f-\x9f]/g;
+/**
+ * Checks if file or folder name contains invalid characters
+ *
+ * @param input File or folder name to check
+ * @param onPremise Set to true for SharePoint On-Premise
+ * @returns True if contains invalid chars, false otherwise
+ */
+export function containsInvalidFileFolderChars(input, onPremise) {
+    if (onPremise === void 0) { onPremise = false; }
+    if (onPremise) {
+        return InvalidFileFolderNameCharsOnPremiseRegex.test(input);
+    }
+    else {
+        return InvalidFileFolderNameCharsOnlineRegex.test(input);
+    }
+}
+/**
+ * Removes invalid characters from file or folder name
+ *
+ * @param input File or folder name
+ * @param replacer Value that will replace invalid characters
+ * @param onPremise Set to true for SharePoint On-Premise
+ * @returns File or folder name with replaced invalid characters
+ */
+export function stripInvalidFileFolderChars(input, replacer, onPremise) {
+    if (replacer === void 0) { replacer = ""; }
+    if (onPremise === void 0) { onPremise = false; }
+    if (onPremise) {
+        return input.replace(InvalidFileFolderNameCharsOnPremiseRegex, replacer);
+    }
+    else {
+        return input.replace(InvalidFileFolderNameCharsOnlineRegex, replacer);
+    }
+}
 //# sourceMappingURL=file-names.js.map

package/utils/metadata.d.ts

@@ -1,6 +1,6 @@
-export declare function metadata(type: string): {
-    __metadata: {
-        type: string;
-    };
-};
+export declare function metadata(type: string): {
+    __metadata: {
+        type: string;
+    };
+};
 //# sourceMappingURL=metadata.d.ts.map

package/utils/metadata.js

@@ -1,6 +1,6 @@
-export function metadata(type) {
-    return {
-        "__metadata": { "type": type },
-    };
-}
+export function metadata(type) {
+    return {
+        "__metadata": { "type": type },
+    };
+}
 //# sourceMappingURL=metadata.js.map

package/utils/objectToSPKeyValueCollection.d.ts

@@ -1,21 +1,21 @@
-import { ITypedHash } from "@pnp/common";
-export interface ISPKeyValueCollection {
-    __metadata: {
-        type: "Collection(SP.KeyValue)";
-    };
-    results: {
-        __metadata: {
-            type: "SP.KeyValue";
-        };
-        Key: string;
-        Value: string;
-        ValueType: "Edm.String";
-    }[];
-}
-/**
- * Creates an object representing a SharePoint Collection(SP.KeyValue)
- *
- * @param obj The plain object defining the properties
- */
-export declare function objectToSPKeyValueCollection(obj: ITypedHash<string | number | boolean>): ISPKeyValueCollection;
+import { ITypedHash } from "@pnp/common";
+export interface ISPKeyValueCollection {
+    __metadata: {
+        type: "Collection(SP.KeyValue)";
+    };
+    results: {
+        __metadata: {
+            type: "SP.KeyValue";
+        };
+        Key: string;
+        Value: string;
+        ValueType: "Edm.String";
+    }[];
+}
+/**
+ * Creates an object representing a SharePoint Collection(SP.KeyValue)
+ *
+ * @param obj The plain object defining the properties
+ */
+export declare function objectToSPKeyValueCollection(obj: ITypedHash<string | number | boolean>): ISPKeyValueCollection;
 //# sourceMappingURL=objectToSPKeyValueCollection.d.ts.map

package/utils/objectToSPKeyValueCollection.js

@@ -1,17 +1,17 @@
-import { metadata } from "./metadata.js";
-import { assign } from "@pnp/common";
-/**
- * Creates an object representing a SharePoint Collection(SP.KeyValue)
- *
- * @param obj The plain object defining the properties
- */
-export function objectToSPKeyValueCollection(obj) {
-    return assign(metadata("Collection(SP.KeyValue)"), {
-        results: Object.keys(obj).map(function (key) { return assign(metadata("SP.KeyValue"), {
-            Key: key,
-            Value: Reflect.get(obj, key),
-            ValueType: "Edm.String",
-        }); }),
-    });
-}
+import { metadata } from "./metadata.js";
+import { assign } from "@pnp/common";
+/**
+ * Creates an object representing a SharePoint Collection(SP.KeyValue)
+ *
+ * @param obj The plain object defining the properties
+ */
+export function objectToSPKeyValueCollection(obj) {
+    return assign(metadata("Collection(SP.KeyValue)"), {
+        results: Object.keys(obj).map(function (key) { return assign(metadata("SP.KeyValue"), {
+            Key: key,
+            Value: Reflect.get(obj, key),
+            ValueType: "Edm.String",
+        }); }),
+    });
+}
 //# sourceMappingURL=objectToSPKeyValueCollection.js.map

package/utils/toResourcePath.d.ts

@@ -1,8 +1,8 @@
-export interface IResourcePath {
-    DecodedUrl: string;
-    __metadata: {
-        type: "SP.ResourcePath";
-    };
-}
-export declare function toResourcePath(url: string): IResourcePath;
+export interface IResourcePath {
+    DecodedUrl: string;
+    __metadata: {
+        type: "SP.ResourcePath";
+    };
+}
+export declare function toResourcePath(url: string): IResourcePath;
 //# sourceMappingURL=toResourcePath.d.ts.map

package/utils/toResourcePath.js

@@ -1,7 +1,7 @@
-export function toResourcePath(url) {
-    return {
-        DecodedUrl: url,
-        __metadata: { type: "SP.ResourcePath" },
-    };
-}
+export function toResourcePath(url) {
+    return {
+        DecodedUrl: url,
+        __metadata: { type: "SP.ResourcePath" },
+    };
+}
 //# sourceMappingURL=toResourcePath.js.map

package/utils/toabsoluteurl.d.ts

@@ -1,8 +1,8 @@
-/**
- * Ensures that a given url is absolute for the current web based on context
- *
- * @param candidateUrl The url to make absolute
- *
- */
-export declare function toAbsoluteUrl(candidateUrl: string, runtime?: import("@pnp/common").Runtime): Promise<string>;
+/**
+ * Ensures that a given url is absolute for the current web based on context
+ *
+ * @param candidateUrl The url to make absolute
+ *
+ */
+export declare function toAbsoluteUrl(candidateUrl: string, runtime?: import("@pnp/common").Runtime): Promise<string>;
 //# sourceMappingURL=toabsoluteurl.d.ts.map

package/utils/toabsoluteurl.js

@@ -1,62 +1,62 @@
-import { __awaiter, __generator } from "tslib";
-import { combine, isUrlAbsolute, DefaultRuntime, stringIsNullOrEmpty, hOP, safeGlobal } from "@pnp/common";
-/**
- * Ensures that a given url is absolute for the current web based on context
- *
- * @param candidateUrl The url to make absolute
- *
- */
-export function toAbsoluteUrl(candidateUrl, runtime) {
-    var _a, _b;
-    if (runtime === void 0) { runtime = DefaultRuntime; }
-    return __awaiter(this, void 0, void 0, function () {
-        var baseUrl, fetchClientFactory, context, tempClient, location_1;
-        return __generator(this, function (_c) {
-            if (isUrlAbsolute(candidateUrl)) {
-                // if we are already absolute, then just return the url
-                return [2 /*return*/, candidateUrl];
-            }
-            baseUrl = (_a = runtime.get("sp")) === null || _a === void 0 ? void 0 : _a.baseUrl;
-            fetchClientFactory = (_b = runtime.get("sp")) === null || _b === void 0 ? void 0 : _b.fetchClientFactory;
-            if (!stringIsNullOrEmpty(baseUrl)) {
-                // base url specified either with baseUrl of spfxContext config property
-                return [2 /*return*/, combine(baseUrl, candidateUrl)];
-            }
-            context = runtime.get("spfxContext");
-            if (context) {
-                return [2 /*return*/, combine(context.pageContext.web.absoluteUrl, candidateUrl)];
-            }
-            // to make the existing node client work in a backwards compatible way we do the following (hacky thing)
-            // get the client
-            // see if it has a siteUrl property
-            // use that to absolute the url
-            if (fetchClientFactory) {
-                tempClient = fetchClientFactory();
-                if (hOP(tempClient, "siteUrl")) {
-                    return [2 /*return*/, combine(tempClient.siteUrl, candidateUrl)];
-                }
-            }
-            if (safeGlobal._spPageContextInfo !== undefined) {
-                // operating in classic pages
-                if (hOP(safeGlobal._spPageContextInfo, "webAbsoluteUrl")) {
-                    return [2 /*return*/, combine(safeGlobal._spPageContextInfo.webAbsoluteUrl, candidateUrl)];
-                }
-                else if (hOP(safeGlobal._spPageContextInfo, "webServerRelativeUrl")) {
-                    return [2 /*return*/, combine(safeGlobal._spPageContextInfo.webServerRelativeUrl, candidateUrl)];
-                }
-            }
-            // does window.location exist and have a certain path part in it?
-            if (safeGlobal.location !== undefined) {
-                location_1 = safeGlobal.location.toString().toLowerCase();
-                ["/_layouts/", "/siteassets/", "/sitepages/"].forEach(function (s) {
-                    var index = location_1.indexOf(s);
-                    if (index > 0) {
-                        return combine(location_1.substr(0, index), candidateUrl);
-                    }
-                });
-            }
-            return [2 /*return*/, candidateUrl];
-        });
-    });
-}
+import { __awaiter, __generator } from "tslib";
+import { combine, isUrlAbsolute, DefaultRuntime, stringIsNullOrEmpty, hOP, safeGlobal } from "@pnp/common";
+/**
+ * Ensures that a given url is absolute for the current web based on context
+ *
+ * @param candidateUrl The url to make absolute
+ *
+ */
+export function toAbsoluteUrl(candidateUrl, runtime) {
+    var _a, _b;
+    if (runtime === void 0) { runtime = DefaultRuntime; }
+    return __awaiter(this, void 0, void 0, function () {
+        var baseUrl, fetchClientFactory, context, tempClient, location_1;
+        return __generator(this, function (_c) {
+            if (isUrlAbsolute(candidateUrl)) {
+                // if we are already absolute, then just return the url
+                return [2 /*return*/, candidateUrl];
+            }
+            baseUrl = (_a = runtime.get("sp")) === null || _a === void 0 ? void 0 : _a.baseUrl;
+            fetchClientFactory = (_b = runtime.get("sp")) === null || _b === void 0 ? void 0 : _b.fetchClientFactory;
+            if (!stringIsNullOrEmpty(baseUrl)) {
+                // base url specified either with baseUrl of spfxContext config property
+                return [2 /*return*/, combine(baseUrl, candidateUrl)];
+            }
+            context = runtime.get("spfxContext");
+            if (context) {
+                return [2 /*return*/, combine(context.pageContext.web.absoluteUrl, candidateUrl)];
+            }
+            // to make the existing node client work in a backwards compatible way we do the following (hacky thing)
+            // get the client
+            // see if it has a siteUrl property
+            // use that to absolute the url
+            if (fetchClientFactory) {
+                tempClient = fetchClientFactory();
+                if (hOP(tempClient, "siteUrl")) {
+                    return [2 /*return*/, combine(tempClient.siteUrl, candidateUrl)];
+                }
+            }
+            if (safeGlobal._spPageContextInfo !== undefined) {
+                // operating in classic pages
+                if (hOP(safeGlobal._spPageContextInfo, "webAbsoluteUrl")) {
+                    return [2 /*return*/, combine(safeGlobal._spPageContextInfo.webAbsoluteUrl, candidateUrl)];
+                }
+                else if (hOP(safeGlobal._spPageContextInfo, "webServerRelativeUrl")) {
+                    return [2 /*return*/, combine(safeGlobal._spPageContextInfo.webServerRelativeUrl, candidateUrl)];
+                }
+            }
+            // does window.location exist and have a certain path part in it?
+            if (safeGlobal.location !== undefined) {
+                location_1 = safeGlobal.location.toString().toLowerCase();
+                ["/_layouts/", "/siteassets/", "/sitepages/"].forEach(function (s) {
+                    var index = location_1.indexOf(s);
+                    if (index > 0) {
+                        return combine(location_1.substr(0, index), candidateUrl);
+                    }
+                });
+            }
+            return [2 /*return*/, candidateUrl];
+        });
+    });
+}
 //# sourceMappingURL=toabsoluteurl.js.map

package/views/index.d.ts

@@ -1,3 +1,3 @@
-import "./list.js";
-export { IView, IViewFields, IViews, View, ViewFields, Views, IViewAddResult, IViewUpdateResult, IViewInfo, ViewScope, } from "./types.js";
+import "./list.js";
+export { IView, IViewFields, IViews, View, ViewFields, Views, IViewAddResult, IViewUpdateResult, IViewInfo, ViewScope, } from "./types.js";
 //# sourceMappingURL=index.d.ts.map

package/views/index.js

@@ -1,3 +1,3 @@
-import "./list.js";
-export { View, ViewFields, Views, ViewScope, } from "./types.js";
+import "./list.js";
+export { View, ViewFields, Views, ViewScope, } from "./types.js";
 //# sourceMappingURL=index.js.map

package/views/list.d.ts

@@ -1,24 +1,24 @@
-import { IViews, IView } from "./types.js";
-declare module "../lists/types" {
-    interface _List {
-        readonly views: IViews;
-        readonly defaultView: IView;
-        getView(id: string): IView;
-    }
-    interface IList {
-        /**
-         * Gets the views on this list
-         */
-        readonly views: IViews;
-        /**
-         * Gets the default view for this list
-         */
-        readonly defaultView: IView;
-        /**
-         * Gets a view by view guid id
-         *
-         */
-        getView(id: string): IView;
-    }
-}
+import { IViews, IView } from "./types.js";
+declare module "../lists/types" {
+    interface _List {
+        readonly views: IViews;
+        readonly defaultView: IView;
+        getView(id: string): IView;
+    }
+    interface IList {
+        /**
+         * Gets the views on this list
+         */
+        readonly views: IViews;
+        /**
+         * Gets the default view for this list
+         */
+        readonly defaultView: IView;
+        /**
+         * Gets a view by view guid id
+         *
+         */
+        getView(id: string): IView;
+    }
+}
 //# sourceMappingURL=list.d.ts.map

package/views/list.js

@@ -1,9 +1,9 @@
-import { addProp } from "@pnp/odata";
-import { _List } from "../lists/types.js";
-import { Views, View } from "./types.js";
-addProp(_List, "views", Views);
-addProp(_List, "defaultView", View, "DefaultView");
-_List.prototype.getView = function (viewId) {
-    return View(this, "getView('" + viewId + "')");
-};
+import { addProp } from "@pnp/odata";
+import { _List } from "../lists/types.js";
+import { Views, View } from "./types.js";
+addProp(_List, "views", Views);
+addProp(_List, "defaultView", View, "DefaultView");
+_List.prototype.getView = function (viewId) {
+    return View(this, "getView('" + viewId + "')");
+};
 //# sourceMappingURL=list.js.map