@pnp/sp 2.8.0 → 2.12.0

package/sharepointqueryable.js

@@ -1,266 +1,266 @@
-import { __extends } from "tslib";
-import { combine, isUrlAbsolute, assign, jsS } from "@pnp/common";
-import { Queryable, invokableFactory } from "@pnp/odata";
-import { Logger } from "@pnp/logging";
-import { metadata } from "./utils/metadata.js";
-import { spGet, spPost, spPostDelete, spPostDeleteETag } from "./operations.js";
-import { tag } from "./telemetry.js";
-export var spInvokableFactory = function (f) {
-    return invokableFactory(f);
-};
-/**
- * SharePointQueryable Base Class
- *
- */
-var _SharePointQueryable = /** @class */ (function (_super) {
-    __extends(_SharePointQueryable, _super);
-    /**
-     * Creates a new instance of the SharePointQueryable class
-     *
-     * @constructor
-     * @param baseUrl A string or SharePointQueryable that should form the base part of the url
-     *
-     */
-    function _SharePointQueryable(baseUrl, path) {
-        var _this = this;
-        var url = "";
-        var parentUrl = "";
-        var query = new Map();
-        if (typeof baseUrl === "string") {
-            // we need to do some extra parsing to get the parent url correct if we are
-            // being created from just a string.
-            if (isUrlAbsolute(baseUrl) || baseUrl.lastIndexOf("/") < 0) {
-                parentUrl = baseUrl;
-                url = combine(baseUrl, path);
-            }
-            else if (baseUrl.lastIndexOf("/") > baseUrl.lastIndexOf("(")) {
-                // .../items(19)/fields
-                var index = baseUrl.lastIndexOf("/");
-                parentUrl = baseUrl.slice(0, index);
-                path = combine(baseUrl.slice(index), path);
-                url = combine(parentUrl, path);
-            }
-            else {
-                // .../items(19)
-                var index = baseUrl.lastIndexOf("(");
-                parentUrl = baseUrl.slice(0, index);
-                url = combine(baseUrl, path);
-            }
-        }
-        else {
-            parentUrl = baseUrl.toUrl();
-            url = combine(parentUrl, path || "");
-            var target = baseUrl.query.get("@target");
-            if (target !== undefined) {
-                query.set("@target", target);
-            }
-        }
-        // init base with correct values for data seed
-        _this = _super.call(this, {
-            parentUrl: parentUrl,
-            query: query,
-            url: url,
-        }) || this;
-        // post init actions
-        if (typeof baseUrl !== "string") {
-            _this.configureFrom(baseUrl);
-        }
-        _this._forceCaching = false;
-        return _this;
-    }
-    /**
-     * Gets the full url with query information
-     */
-    _SharePointQueryable.prototype.toUrlAndQuery = function () {
-        var aliasedParams = new Map(this.query);
-        var url = this.toUrl().replace(/'!(@.*?)::(.*?)'/ig, function (match, labelName, value) {
-            Logger.write("Rewriting aliased parameter from match " + match + " to label: " + labelName + " value: " + value, 0 /* Verbose */);
-            aliasedParams.set(labelName, "'" + value + "'");
-            return labelName;
-        });
-        if (aliasedParams.size > 0) {
-            var char = url.indexOf("?") > -1 ? "&" : "?";
-            url += "" + char + Array.from(aliasedParams).map(function (v) { return v[0] + "=" + v[1]; }).join("&");
-        }
-        return url;
-    };
-    /**
-     * Choose which fields to return
-     *
-     * @param selects One or more fields to return
-     */
-    _SharePointQueryable.prototype.select = function () {
-        var selects = [];
-        for (var _i = 0; _i < arguments.length; _i++) {
-            selects[_i] = arguments[_i];
-        }
-        if (selects.length > 0) {
-            this.query.set("$select", selects.map(encodeURIComponent).join(","));
-        }
-        return this;
-    };
-    _SharePointQueryable.prototype.get = function (options) {
-        return spGet(this, options);
-    };
-    /**
-     * Expands fields such as lookups to get additional data
-     *
-     * @param expands The Fields for which to expand the values
-     */
-    _SharePointQueryable.prototype.expand = function () {
-        var expands = [];
-        for (var _i = 0; _i < arguments.length; _i++) {
-            expands[_i] = arguments[_i];
-        }
-        if (expands.length > 0) {
-            this.query.set("$expand", expands.map(encodeURIComponent).join(","));
-        }
-        return this;
-    };
-    /**
-     * Clones this SharePointQueryable into a new SharePointQueryable instance of T
-     * @param factory Constructor used to create the new instance
-     * @param additionalPath Any additional path to include in the clone
-     * @param includeBatch If true this instance's batch will be added to the cloned instance
-     * @param includeQuery If true all of the query values will be copied to the cloned instance
-     */
-    _SharePointQueryable.prototype.clone = function (factory, additionalPath, includeBatch, includeQuery) {
-        if (includeBatch === void 0) { includeBatch = true; }
-        if (includeQuery === void 0) { includeQuery = false; }
-        var clone = _super.prototype.cloneTo.call(this, factory(this, additionalPath), { includeBatch: includeBatch, includeQuery: includeQuery });
-        // handle sp specific clone actions
-        if (!includeQuery) {
-            // we would have already copied this over if we got the entire query
-            var t = "@target";
-            if (this.query.has(t)) {
-                clone.query.set(t, this.query.get(t));
-            }
-        }
-        return clone;
-    };
-    /**
-     * The default action for this object (unless overridden spGet)
-     *
-     * @param options optional request options
-     */
-    _SharePointQueryable.prototype.defaultAction = function (options) {
-        return spGet(this, options);
-    };
-    /**
-     * Gets a parent for this instance as specified
-     *
-     * @param factory The contructor for the class to create
-     */
-    _SharePointQueryable.prototype.getParent = function (factory, baseUrl, path, batch) {
-        if (baseUrl === void 0) { baseUrl = this.parentUrl; }
-        var parent = factory(baseUrl, path).configureFrom(this);
-        var t = "@target";
-        if (this.query.has(t)) {
-            parent.query.set(t, this.query.get(t));
-        }
-        if (batch !== undefined) {
-            parent = parent.inBatch(batch);
-        }
-        return parent;
-    };
-    return _SharePointQueryable;
-}(Queryable));
-export { _SharePointQueryable };
-export var SharePointQueryable = spInvokableFactory(_SharePointQueryable);
-/**
- * Represents a REST collection which can be filtered, paged, and selected
- *
- */
-var _SharePointQueryableCollection = /** @class */ (function (_super) {
-    __extends(_SharePointQueryableCollection, _super);
-    function _SharePointQueryableCollection() {
-        return _super !== null && _super.apply(this, arguments) || this;
-    }
-    /**
-     * Filters the returned collection (https://msdn.microsoft.com/en-us/library/office/fp142385.aspx#bk_supported)
-     *
-     * @param filter The string representing the filter query
-     */
-    _SharePointQueryableCollection.prototype.filter = function (filter) {
-        this.query.set("$filter", encodeURIComponent(filter));
-        return this;
-    };
-    /**
-     * Orders based on the supplied fields
-     *
-     * @param orderby The name of the field on which to sort
-     * @param ascending If false DESC is appended, otherwise ASC (default)
-     */
-    _SharePointQueryableCollection.prototype.orderBy = function (orderBy, ascending) {
-        if (ascending === void 0) { ascending = true; }
-        var o = "$orderby";
-        var query = this.query.has(o) ? this.query.get(o).split(",") : [];
-        query.push(encodeURIComponent(orderBy) + " " + (ascending ? "asc" : "desc"));
-        this.query.set(o, query.join(","));
-        return this;
-    };
-    /**
-     * Skips the specified number of items
-     *
-     * @param skip The number of items to skip
-     */
-    _SharePointQueryableCollection.prototype.skip = function (skip) {
-        this.query.set("$skip", skip.toString());
-        return this;
-    };
-    /**
-     * Limits the query to only return the specified number of items
-     *
-     * @param top The query row limit
-     */
-    _SharePointQueryableCollection.prototype.top = function (top) {
-        this.query.set("$top", top.toString());
-        return this;
-    };
-    return _SharePointQueryableCollection;
-}(_SharePointQueryable));
-export { _SharePointQueryableCollection };
-export var SharePointQueryableCollection = spInvokableFactory(_SharePointQueryableCollection);
-/**
- * Represents an instance that can be selected
- *
- */
-var _SharePointQueryableInstance = /** @class */ (function (_super) {
-    __extends(_SharePointQueryableInstance, _super);
-    function _SharePointQueryableInstance() {
-        return _super !== null && _super.apply(this, arguments) || this;
-    }
-    /**
-     * Curries the update function into the common pieces
-     *
-     * @param type
-     * @param mapper
-     */
-    _SharePointQueryableInstance.prototype._update = function (type, mapper) {
-        var _this = this;
-        return function (props) { return spPost(tag.configure(_this, type + ".Update"), {
-            body: jsS(assign(metadata(type), props)),
-            headers: {
-                "X-HTTP-Method": "MERGE",
-            },
-        }).then(function (d) { return mapper(d, props); }); };
-    };
-    return _SharePointQueryableInstance;
-}(_SharePointQueryable));
-export { _SharePointQueryableInstance };
-export var SharePointQueryableInstance = spInvokableFactory(_SharePointQueryableInstance);
-/**
- * Adds the a delete method to the tagged class taking no parameters and calling spPostDelete
- */
-export function deleteable(t) {
-    return function () {
-        return spPostDelete(tag.configure(this, t + ".delete"));
-    };
-}
-export function deleteableWithETag(t) {
-    return function (eTag) {
-        if (eTag === void 0) { eTag = "*"; }
-        return spPostDeleteETag(tag.configure(this, t + ".delete"), {}, eTag);
-    };
-}
+import { __extends } from "tslib";
+import { combine, isUrlAbsolute, assign, jsS } from "@pnp/common";
+import { Queryable, invokableFactory } from "@pnp/odata";
+import { Logger } from "@pnp/logging";
+import { metadata } from "./utils/metadata.js";
+import { spGet, spPost, spPostDelete, spPostDeleteETag } from "./operations.js";
+import { tag } from "./telemetry.js";
+export var spInvokableFactory = function (f) {
+    return invokableFactory(f);
+};
+/**
+ * SharePointQueryable Base Class
+ *
+ */
+var _SharePointQueryable = /** @class */ (function (_super) {
+    __extends(_SharePointQueryable, _super);
+    /**
+     * Creates a new instance of the SharePointQueryable class
+     *
+     * @constructor
+     * @param baseUrl A string or SharePointQueryable that should form the base part of the url
+     *
+     */
+    function _SharePointQueryable(baseUrl, path) {
+        var _this = this;
+        var url = "";
+        var parentUrl = "";
+        var query = new Map();
+        if (typeof baseUrl === "string") {
+            // we need to do some extra parsing to get the parent url correct if we are
+            // being created from just a string.
+            if (isUrlAbsolute(baseUrl) || baseUrl.lastIndexOf("/") < 0) {
+                parentUrl = baseUrl;
+                url = combine(baseUrl, path);
+            }
+            else if (baseUrl.lastIndexOf("/") > baseUrl.lastIndexOf("(")) {
+                // .../items(19)/fields
+                var index = baseUrl.lastIndexOf("/");
+                parentUrl = baseUrl.slice(0, index);
+                path = combine(baseUrl.slice(index), path);
+                url = combine(parentUrl, path);
+            }
+            else {
+                // .../items(19)
+                var index = baseUrl.lastIndexOf("(");
+                parentUrl = baseUrl.slice(0, index);
+                url = combine(baseUrl, path);
+            }
+        }
+        else {
+            parentUrl = baseUrl.toUrl();
+            url = combine(parentUrl, path || "");
+            var target = baseUrl.query.get("@target");
+            if (target !== undefined) {
+                query.set("@target", target);
+            }
+        }
+        // init base with correct values for data seed
+        _this = _super.call(this, {
+            parentUrl: parentUrl,
+            query: query,
+            url: url,
+        }) || this;
+        // post init actions
+        if (typeof baseUrl !== "string") {
+            _this.configureFrom(baseUrl);
+        }
+        _this._forceCaching = false;
+        return _this;
+    }
+    /**
+     * Gets the full url with query information
+     */
+    _SharePointQueryable.prototype.toUrlAndQuery = function () {
+        var aliasedParams = new Map(this.query);
+        var url = this.toUrl().replace(/'!(@.*?)::(.*?)'/ig, function (match, labelName, value) {
+            Logger.write("Rewriting aliased parameter from match " + match + " to label: " + labelName + " value: " + value, 0 /* Verbose */);
+            aliasedParams.set(labelName, "'" + value + "'");
+            return labelName;
+        });
+        if (aliasedParams.size > 0) {
+            var char = url.indexOf("?") > -1 ? "&" : "?";
+            url += "" + char + Array.from(aliasedParams).map(function (v) { return v[0] + "=" + v[1]; }).join("&");
+        }
+        return url;
+    };
+    /**
+     * Choose which fields to return
+     *
+     * @param selects One or more fields to return
+     */
+    _SharePointQueryable.prototype.select = function () {
+        var selects = [];
+        for (var _i = 0; _i < arguments.length; _i++) {
+            selects[_i] = arguments[_i];
+        }
+        if (selects.length > 0) {
+            this.query.set("$select", selects.map(encodeURIComponent).join(","));
+        }
+        return this;
+    };
+    _SharePointQueryable.prototype.get = function (options) {
+        return spGet(this, options);
+    };
+    /**
+     * Expands fields such as lookups to get additional data
+     *
+     * @param expands The Fields for which to expand the values
+     */
+    _SharePointQueryable.prototype.expand = function () {
+        var expands = [];
+        for (var _i = 0; _i < arguments.length; _i++) {
+            expands[_i] = arguments[_i];
+        }
+        if (expands.length > 0) {
+            this.query.set("$expand", expands.map(encodeURIComponent).join(","));
+        }
+        return this;
+    };
+    /**
+     * Clones this SharePointQueryable into a new SharePointQueryable instance of T
+     * @param factory Constructor used to create the new instance
+     * @param additionalPath Any additional path to include in the clone
+     * @param includeBatch If true this instance's batch will be added to the cloned instance
+     * @param includeQuery If true all of the query values will be copied to the cloned instance
+     */
+    _SharePointQueryable.prototype.clone = function (factory, additionalPath, includeBatch, includeQuery) {
+        if (includeBatch === void 0) { includeBatch = true; }
+        if (includeQuery === void 0) { includeQuery = false; }
+        var clone = _super.prototype.cloneTo.call(this, factory(this, additionalPath), { includeBatch: includeBatch, includeQuery: includeQuery });
+        // handle sp specific clone actions
+        if (!includeQuery) {
+            // we would have already copied this over if we got the entire query
+            var t = "@target";
+            if (this.query.has(t)) {
+                clone.query.set(t, this.query.get(t));
+            }
+        }
+        return clone;
+    };
+    /**
+     * The default action for this object (unless overridden spGet)
+     *
+     * @param options optional request options
+     */
+    _SharePointQueryable.prototype.defaultAction = function (options) {
+        return spGet(this, options);
+    };
+    /**
+     * Gets a parent for this instance as specified
+     *
+     * @param factory The contructor for the class to create
+     */
+    _SharePointQueryable.prototype.getParent = function (factory, baseUrl, path, batch) {
+        if (baseUrl === void 0) { baseUrl = this.parentUrl; }
+        var parent = factory(baseUrl, path).configureFrom(this);
+        var t = "@target";
+        if (this.query.has(t)) {
+            parent.query.set(t, this.query.get(t));
+        }
+        if (batch !== undefined) {
+            parent = parent.inBatch(batch);
+        }
+        return parent;
+    };
+    return _SharePointQueryable;
+}(Queryable));
+export { _SharePointQueryable };
+export var SharePointQueryable = spInvokableFactory(_SharePointQueryable);
+/**
+ * Represents a REST collection which can be filtered, paged, and selected
+ *
+ */
+var _SharePointQueryableCollection = /** @class */ (function (_super) {
+    __extends(_SharePointQueryableCollection, _super);
+    function _SharePointQueryableCollection() {
+        return _super !== null && _super.apply(this, arguments) || this;
+    }
+    /**
+     * Filters the returned collection (https://msdn.microsoft.com/en-us/library/office/fp142385.aspx#bk_supported)
+     *
+     * @param filter The string representing the filter query
+     */
+    _SharePointQueryableCollection.prototype.filter = function (filter) {
+        this.query.set("$filter", encodeURIComponent(filter));
+        return this;
+    };
+    /**
+     * Orders based on the supplied fields
+     *
+     * @param orderby The name of the field on which to sort
+     * @param ascending If false DESC is appended, otherwise ASC (default)
+     */
+    _SharePointQueryableCollection.prototype.orderBy = function (orderBy, ascending) {
+        if (ascending === void 0) { ascending = true; }
+        var o = "$orderby";
+        var query = this.query.has(o) ? this.query.get(o).split(",") : [];
+        query.push(encodeURIComponent(orderBy) + " " + (ascending ? "asc" : "desc"));
+        this.query.set(o, query.join(","));
+        return this;
+    };
+    /**
+     * Skips the specified number of items
+     *
+     * @param skip The number of items to skip
+     */
+    _SharePointQueryableCollection.prototype.skip = function (skip) {
+        this.query.set("$skip", skip.toString());
+        return this;
+    };
+    /**
+     * Limits the query to only return the specified number of items
+     *
+     * @param top The query row limit
+     */
+    _SharePointQueryableCollection.prototype.top = function (top) {
+        this.query.set("$top", top.toString());
+        return this;
+    };
+    return _SharePointQueryableCollection;
+}(_SharePointQueryable));
+export { _SharePointQueryableCollection };
+export var SharePointQueryableCollection = spInvokableFactory(_SharePointQueryableCollection);
+/**
+ * Represents an instance that can be selected
+ *
+ */
+var _SharePointQueryableInstance = /** @class */ (function (_super) {
+    __extends(_SharePointQueryableInstance, _super);
+    function _SharePointQueryableInstance() {
+        return _super !== null && _super.apply(this, arguments) || this;
+    }
+    /**
+     * Curries the update function into the common pieces
+     *
+     * @param type
+     * @param mapper
+     */
+    _SharePointQueryableInstance.prototype._update = function (type, mapper) {
+        var _this = this;
+        return function (props) { return spPost(tag.configure(_this, type + ".Update"), {
+            body: jsS(assign(metadata(type), props)),
+            headers: {
+                "X-HTTP-Method": "MERGE",
+            },
+        }).then(function (d) { return mapper(d, props); }); };
+    };
+    return _SharePointQueryableInstance;
+}(_SharePointQueryable));
+export { _SharePointQueryableInstance };
+export var SharePointQueryableInstance = spInvokableFactory(_SharePointQueryableInstance);
+/**
+ * Adds the a delete method to the tagged class taking no parameters and calling spPostDelete
+ */
+export function deleteable(t) {
+    return function () {
+        return spPostDelete(tag.configure(this, t + ".delete"));
+    };
+}
+export function deleteableWithETag(t) {
+    return function (eTag) {
+        if (eTag === void 0) { eTag = "*"; }
+        return spPostDeleteETag(tag.configure(this, t + ".delete"), {}, eTag);
+    };
+}
 //# sourceMappingURL=sharepointqueryable.js.map

package/sharing/file.d.ts

@@ -1,19 +1,19 @@
-import { ISharingEmailData, ISharingResult, SharingRole, ISharedFuncs } from "./types.js";
-declare module "../files/types" {
-    interface _File extends ISharedFuncs {
-        shareWith(loginNames: string | string[], role?: SharingRole, requireSignin?: boolean, emailData?: ISharingEmailData): Promise<ISharingResult>;
-    }
-    interface IFile extends ISharedFuncs {
-        /**
-         * Shares this item with one or more users
-         *
-         * @param loginNames string or string[] of resolved login names to which this item will be shared
-         * @param role The role (View | Edit) applied to the share
-         * @param shareEverything Share everything in this folder, even items with unique permissions.
-         * @param requireSignin If true the user must signin to view link, otherwise anyone with the link can access the resource
-         * @param emailData Optional, if inlucded an email will be sent. Note subject currently has no effect.
-         */
-        shareWith(loginNames: string | string[], role?: SharingRole, requireSignin?: boolean, emailData?: ISharingEmailData): Promise<ISharingResult>;
-    }
-}
+import { ISharingEmailData, ISharingResult, SharingRole, ISharedFuncs } from "./types.js";
+declare module "../files/types" {
+    interface _File extends ISharedFuncs {
+        shareWith(loginNames: string | string[], role?: SharingRole, requireSignin?: boolean, emailData?: ISharingEmailData): Promise<ISharingResult>;
+    }
+    interface IFile extends ISharedFuncs {
+        /**
+         * Shares this item with one or more users
+         *
+         * @param loginNames string or string[] of resolved login names to which this item will be shared
+         * @param role The role (View | Edit) applied to the share
+         * @param shareEverything Share everything in this folder, even items with unique permissions.
+         * @param requireSignin If true the user must signin to view link, otherwise anyone with the link can access the resource
+         * @param emailData Optional, if inlucded an email will be sent. Note subject currently has no effect.
+         */
+        shareWith(loginNames: string | string[], role?: SharingRole, requireSignin?: boolean, emailData?: ISharingEmailData): Promise<ISharingResult>;
+    }
+}
 //# sourceMappingURL=file.d.ts.map