@pnp/sp 2.8.0 → 2.12.0

package/search/query.js

@@ -1,303 +1,303 @@
-import { __awaiter, __decorate, __extends, __generator, __values } from "tslib";
-import { _SharePointQueryableInstance } from "../sharepointqueryable.js";
-import { assign, hOP, getHashCode, objectDefinedNotNull, isArray, DefaultRuntime, stringIsNullOrEmpty } from "@pnp/common";
-import { metadata } from "../utils/metadata.js";
-import { CachingOptions, body } from "@pnp/odata";
-import { spPost } from "../operations.js";
-import { defaultPath } from "../decorators.js";
-import { tag } from "../telemetry.js";
-var funcs = new Map([
-    ["text", "Querytext"],
-    ["template", "QueryTemplate"],
-    ["sourceId", "SourceId"],
-    ["trimDuplicatesIncludeId", ""],
-    ["startRow", ""],
-    ["rowLimit", ""],
-    ["rankingModelId", ""],
-    ["rowsPerPage", ""],
-    ["selectProperties", ""],
-    ["culture", ""],
-    ["timeZoneId", ""],
-    ["refinementFilters", ""],
-    ["refiners", ""],
-    ["hiddenConstraints", ""],
-    ["sortList", ""],
-    ["timeout", ""],
-    ["hitHighlightedProperties", ""],
-    ["clientType", ""],
-    ["personalizationData", ""],
-    ["resultsURL", ""],
-    ["queryTag", ""],
-    ["properties", ""],
-    ["queryTemplatePropertiesUrl", ""],
-    ["reorderingRules", ""],
-    ["hitHighlightedMultivaluePropertyLimit", ""],
-    ["collapseSpecification", ""],
-    ["uiLanguage", ""],
-    ["desiredSnippetLength", ""],
-    ["maxSnippetLength", ""],
-    ["summaryLength", ""],
-]);
-var props = new Map([]);
-function toPropCase(str) {
-    return str.replace(/^(.)/, function ($1) { return $1.toUpperCase(); });
-}
-/**
- * Creates a new instance of the SearchQueryBuilder
- *
- * @param queryText Initial query text
- * @param _query Any initial query configuration
- */
-export function SearchQueryBuilder(queryText, _query) {
-    if (queryText === void 0) { queryText = ""; }
-    if (_query === void 0) { _query = {}; }
-    return new Proxy({
-        query: Object.assign({
-            Querytext: queryText,
-        }, _query),
-    }, {
-        get: function (self, propertyKey, proxy) {
-            var pk = propertyKey.toString();
-            if (pk === "toSearchQuery") {
-                return function () { return self.query; };
-            }
-            if (funcs.has(pk)) {
-                return function () {
-                    var value = [];
-                    for (var _i = 0; _i < arguments.length; _i++) {
-                        value[_i] = arguments[_i];
-                    }
-                    var mappedPk = funcs.get(pk);
-                    self.query[mappedPk.length > 0 ? mappedPk : toPropCase(pk)] = value.length > 1 ? value : value[0];
-                    return proxy;
-                };
-            }
-            var propKey = props.has(pk) ? props.get(pk) : toPropCase(pk);
-            self.query[propKey] = true;
-            return proxy;
-        },
-    });
-}
-var queryRegex = /_api\/search\/postquery$/i;
-/**
- * Describes the search API
- *
- */
-var _Search = /** @class */ (function (_super) {
-    __extends(_Search, _super);
-    function _Search() {
-        return _super !== null && _super.apply(this, arguments) || this;
-    }
-    /**
-     * @returns Promise
-     */
-    _Search.prototype.execute = function (queryInit) {
-        return __awaiter(this, void 0, void 0, function () {
-            var query, postBody, cacheKey, data;
-            return __generator(this, function (_a) {
-                switch (_a.label) {
-                    case 0:
-                        query = this.parseQuery(queryInit);
-                        postBody = body({
-                            request: assign(metadata("Microsoft.Office.Server.Search.REST.SearchRequest"), Object.assign({}, query, {
-                                HitHighlightedProperties: this.fixArrProp(query.HitHighlightedProperties),
-                                Properties: this.fixArrProp(query.Properties),
-                                RefinementFilters: this.fixArrProp(query.RefinementFilters),
-                                ReorderingRules: this.fixArrProp(query.ReorderingRules),
-                                SelectProperties: this.fixArrProp(query.SelectProperties),
-                                SortList: this.fixArrProp(query.SortList),
-                            })),
-                        });
-                        // if we are using caching with this search request, then we need to handle some work upfront to enable that
-                        if (this.data.useCaching) {
-                            // force use of the cache for this request if .usingCaching was called
-                            this._forceCaching = true;
-                            cacheKey = "PnPjs.SearchWithCaching(" + getHashCode(postBody.body) + ")";
-                            if (objectDefinedNotNull(this.data.cachingOptions)) {
-                                // if our key ends in the postquery url we overwrite it
-                                if (stringIsNullOrEmpty(this.data.cachingOptions.key) || queryRegex.test(this.data.cachingOptions.key)) {
-                                    this.data.cachingOptions.key = cacheKey;
-                                }
-                            }
-                            else {
-                                this.data.cachingOptions = new CachingOptions(cacheKey);
-                            }
-                        }
-                        return [4 /*yield*/, spPost(this, postBody)];
-                    case 1:
-                        data = _a.sent();
-                        return [2 /*return*/, new SearchResults(data, this.toUrl(), query)];
-                }
-            });
-        });
-    };
-    /**
-     * Fix array property
-     *
-     * @param prop property to fix for container struct
-     */
-    _Search.prototype.fixArrProp = function (prop) {
-        if (typeof prop === "undefined") {
-            return ({ results: [] });
-        }
-        return { results: isArray(prop) ? prop : [prop] };
-    };
-    /**
-     * Translates one of the query initializers into a SearchQuery instance
-     *
-     * @param query
-     */
-    _Search.prototype.parseQuery = function (query) {
-        var finalQuery;
-        if (typeof query === "string") {
-            finalQuery = { Querytext: query };
-        }
-        else if (query.toSearchQuery) {
-            finalQuery = query.toSearchQuery();
-        }
-        else {
-            finalQuery = query;
-        }
-        return finalQuery;
-    };
-    __decorate([
-        tag("se.execute")
-    ], _Search.prototype, "execute", null);
-    _Search = __decorate([
-        defaultPath("_api/search/postquery")
-    ], _Search);
-    return _Search;
-}(_SharePointQueryableInstance));
-export { _Search };
-export var Search = function (baseUrl, options, runtime) {
-    if (options === void 0) { options = {}; }
-    if (runtime === void 0) { runtime = DefaultRuntime; }
-    return function (queryInit) {
-        return (new _Search(baseUrl)).configure(options).setRuntime(runtime).execute(queryInit);
-    };
-};
-var SearchResults = /** @class */ (function () {
-    function SearchResults(rawResponse, _url, _query, _raw, _primary) {
-        if (_raw === void 0) { _raw = null; }
-        if (_primary === void 0) { _primary = null; }
-        this._url = _url;
-        this._query = _query;
-        this._raw = _raw;
-        this._primary = _primary;
-        this._url = this._url.replace(queryRegex, "");
-        this._raw = rawResponse.postquery ? rawResponse.postquery : rawResponse;
-    }
-    Object.defineProperty(SearchResults.prototype, "ElapsedTime", {
-        get: function () {
-            var _a;
-            return ((_a = this === null || this === void 0 ? void 0 : this.RawSearchResults) === null || _a === void 0 ? void 0 : _a.ElapsedTime) || 0;
-        },
-        enumerable: false,
-        configurable: true
-    });
-    Object.defineProperty(SearchResults.prototype, "RowCount", {
-        get: function () {
-            var _a, _b, _c;
-            return ((_c = (_b = (_a = this === null || this === void 0 ? void 0 : this.RawSearchResults) === null || _a === void 0 ? void 0 : _a.PrimaryQueryResult) === null || _b === void 0 ? void 0 : _b.RelevantResults) === null || _c === void 0 ? void 0 : _c.RowCount) || 0;
-        },
-        enumerable: false,
-        configurable: true
-    });
-    Object.defineProperty(SearchResults.prototype, "TotalRows", {
-        get: function () {
-            var _a, _b, _c;
-            return ((_c = (_b = (_a = this === null || this === void 0 ? void 0 : this.RawSearchResults) === null || _a === void 0 ? void 0 : _a.PrimaryQueryResult) === null || _b === void 0 ? void 0 : _b.RelevantResults) === null || _c === void 0 ? void 0 : _c.TotalRows) || 0;
-        },
-        enumerable: false,
-        configurable: true
-    });
-    Object.defineProperty(SearchResults.prototype, "TotalRowsIncludingDuplicates", {
-        get: function () {
-            var _a, _b, _c;
-            return ((_c = (_b = (_a = this === null || this === void 0 ? void 0 : this.RawSearchResults) === null || _a === void 0 ? void 0 : _a.PrimaryQueryResult) === null || _b === void 0 ? void 0 : _b.RelevantResults) === null || _c === void 0 ? void 0 : _c.TotalRowsIncludingDuplicates) || 0;
-        },
-        enumerable: false,
-        configurable: true
-    });
-    Object.defineProperty(SearchResults.prototype, "RawSearchResults", {
-        get: function () {
-            return this._raw;
-        },
-        enumerable: false,
-        configurable: true
-    });
-    Object.defineProperty(SearchResults.prototype, "PrimarySearchResults", {
-        get: function () {
-            var _a, _b, _c, _d;
-            if (this._primary === null) {
-                this._primary = this.formatSearchResults(((_d = (_c = (_b = (_a = this._raw) === null || _a === void 0 ? void 0 : _a.PrimaryQueryResult) === null || _b === void 0 ? void 0 : _b.RelevantResults) === null || _c === void 0 ? void 0 : _c.Table) === null || _d === void 0 ? void 0 : _d.Rows) || null);
-            }
-            return this._primary;
-        },
-        enumerable: false,
-        configurable: true
-    });
-    /**
-     * Gets a page of results
-     *
-     * @param pageNumber Index of the page to return. Used to determine StartRow
-     * @param pageSize Optional, items per page (default = 10)
-     */
-    SearchResults.prototype.getPage = function (pageNumber, pageSize) {
-        // if we got all the available rows we don't have another page
-        if (this.TotalRows < this.RowCount) {
-            return Promise.resolve(null);
-        }
-        // if pageSize is supplied, then we use that regardless of any previous values
-        // otherwise get the previous RowLimit or default to 10
-        var rows = pageSize !== undefined ? pageSize : hOP(this._query, "RowLimit") ? this._query.RowLimit : 10;
-        var query = assign(this._query, {
-            RowLimit: rows,
-            StartRow: rows * (pageNumber - 1),
-        });
-        // we have reached the end
-        if (query.StartRow > this.TotalRows) {
-            return Promise.resolve(null);
-        }
-        return Search(this._url)(query);
-    };
-    /**
-     * Formats a search results array
-     *
-     * @param rawResults The array to process
-     */
-    SearchResults.prototype.formatSearchResults = function (rawResults) {
-        var e_1, _a;
-        var results = new Array();
-        if (typeof (rawResults) === "undefined" || rawResults == null) {
-            return [];
-        }
-        var tempResults = rawResults.results ? rawResults.results : rawResults;
-        try {
-            for (var tempResults_1 = __values(tempResults), tempResults_1_1 = tempResults_1.next(); !tempResults_1_1.done; tempResults_1_1 = tempResults_1.next()) {
-                var tempResult = tempResults_1_1.value;
-                var cells = tempResult.Cells.results ? tempResult.Cells.results : tempResult.Cells;
-                results.push(cells.reduce(function (res, cell) {
-                    Reflect.defineProperty(res, cell.Key, {
-                        configurable: false,
-                        enumerable: true,
-                        value: cell.Value,
-                        writable: false,
-                    });
-                    return res;
-                }, {}));
-            }
-        }
-        catch (e_1_1) { e_1 = { error: e_1_1 }; }
-        finally {
-            try {
-                if (tempResults_1_1 && !tempResults_1_1.done && (_a = tempResults_1.return)) _a.call(tempResults_1);
-            }
-            finally { if (e_1) throw e_1.error; }
-        }
-        return results;
-    };
-    return SearchResults;
-}());
-export { SearchResults };
+import { __awaiter, __decorate, __extends, __generator, __values } from "tslib";
+import { _SharePointQueryableInstance } from "../sharepointqueryable.js";
+import { assign, hOP, getHashCode, objectDefinedNotNull, isArray, DefaultRuntime, stringIsNullOrEmpty } from "@pnp/common";
+import { metadata } from "../utils/metadata.js";
+import { CachingOptions, body } from "@pnp/odata";
+import { spPost } from "../operations.js";
+import { defaultPath } from "../decorators.js";
+import { tag } from "../telemetry.js";
+var funcs = new Map([
+    ["text", "Querytext"],
+    ["template", "QueryTemplate"],
+    ["sourceId", "SourceId"],
+    ["trimDuplicatesIncludeId", ""],
+    ["startRow", ""],
+    ["rowLimit", ""],
+    ["rankingModelId", ""],
+    ["rowsPerPage", ""],
+    ["selectProperties", ""],
+    ["culture", ""],
+    ["timeZoneId", ""],
+    ["refinementFilters", ""],
+    ["refiners", ""],
+    ["hiddenConstraints", ""],
+    ["sortList", ""],
+    ["timeout", ""],
+    ["hitHighlightedProperties", ""],
+    ["clientType", ""],
+    ["personalizationData", ""],
+    ["resultsURL", ""],
+    ["queryTag", ""],
+    ["properties", ""],
+    ["queryTemplatePropertiesUrl", ""],
+    ["reorderingRules", ""],
+    ["hitHighlightedMultivaluePropertyLimit", ""],
+    ["collapseSpecification", ""],
+    ["uiLanguage", ""],
+    ["desiredSnippetLength", ""],
+    ["maxSnippetLength", ""],
+    ["summaryLength", ""],
+]);
+var props = new Map([]);
+function toPropCase(str) {
+    return str.replace(/^(.)/, function ($1) { return $1.toUpperCase(); });
+}
+/**
+ * Creates a new instance of the SearchQueryBuilder
+ *
+ * @param queryText Initial query text
+ * @param _query Any initial query configuration
+ */
+export function SearchQueryBuilder(queryText, _query) {
+    if (queryText === void 0) { queryText = ""; }
+    if (_query === void 0) { _query = {}; }
+    return new Proxy({
+        query: Object.assign({
+            Querytext: queryText,
+        }, _query),
+    }, {
+        get: function (self, propertyKey, proxy) {
+            var pk = propertyKey.toString();
+            if (pk === "toSearchQuery") {
+                return function () { return self.query; };
+            }
+            if (funcs.has(pk)) {
+                return function () {
+                    var value = [];
+                    for (var _i = 0; _i < arguments.length; _i++) {
+                        value[_i] = arguments[_i];
+                    }
+                    var mappedPk = funcs.get(pk);
+                    self.query[mappedPk.length > 0 ? mappedPk : toPropCase(pk)] = value.length > 1 ? value : value[0];
+                    return proxy;
+                };
+            }
+            var propKey = props.has(pk) ? props.get(pk) : toPropCase(pk);
+            self.query[propKey] = true;
+            return proxy;
+        },
+    });
+}
+var queryRegex = /_api\/search\/postquery$/i;
+/**
+ * Describes the search API
+ *
+ */
+var _Search = /** @class */ (function (_super) {
+    __extends(_Search, _super);
+    function _Search() {
+        return _super !== null && _super.apply(this, arguments) || this;
+    }
+    /**
+     * @returns Promise
+     */
+    _Search.prototype.execute = function (queryInit) {
+        return __awaiter(this, void 0, void 0, function () {
+            var query, postBody, cacheKey, data;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0:
+                        query = this.parseQuery(queryInit);
+                        postBody = body({
+                            request: assign(metadata("Microsoft.Office.Server.Search.REST.SearchRequest"), Object.assign({}, query, {
+                                HitHighlightedProperties: this.fixArrProp(query.HitHighlightedProperties),
+                                Properties: this.fixArrProp(query.Properties),
+                                RefinementFilters: this.fixArrProp(query.RefinementFilters),
+                                ReorderingRules: this.fixArrProp(query.ReorderingRules),
+                                SelectProperties: this.fixArrProp(query.SelectProperties),
+                                SortList: this.fixArrProp(query.SortList),
+                            })),
+                        });
+                        // if we are using caching with this search request, then we need to handle some work upfront to enable that
+                        if (this.data.useCaching) {
+                            // force use of the cache for this request if .usingCaching was called
+                            this._forceCaching = true;
+                            cacheKey = "PnPjs.SearchWithCaching(" + getHashCode(postBody.body) + ")";
+                            if (objectDefinedNotNull(this.data.cachingOptions)) {
+                                // if our key ends in the postquery url we overwrite it
+                                if (stringIsNullOrEmpty(this.data.cachingOptions.key) || queryRegex.test(this.data.cachingOptions.key)) {
+                                    this.data.cachingOptions.key = cacheKey;
+                                }
+                            }
+                            else {
+                                this.data.cachingOptions = new CachingOptions(cacheKey);
+                            }
+                        }
+                        return [4 /*yield*/, spPost(this, postBody)];
+                    case 1:
+                        data = _a.sent();
+                        return [2 /*return*/, new SearchResults(data, this.toUrl(), query)];
+                }
+            });
+        });
+    };
+    /**
+     * Fix array property
+     *
+     * @param prop property to fix for container struct
+     */
+    _Search.prototype.fixArrProp = function (prop) {
+        if (typeof prop === "undefined") {
+            return ({ results: [] });
+        }
+        return { results: isArray(prop) ? prop : [prop] };
+    };
+    /**
+     * Translates one of the query initializers into a SearchQuery instance
+     *
+     * @param query
+     */
+    _Search.prototype.parseQuery = function (query) {
+        var finalQuery;
+        if (typeof query === "string") {
+            finalQuery = { Querytext: query };
+        }
+        else if (query.toSearchQuery) {
+            finalQuery = query.toSearchQuery();
+        }
+        else {
+            finalQuery = query;
+        }
+        return finalQuery;
+    };
+    __decorate([
+        tag("se.execute")
+    ], _Search.prototype, "execute", null);
+    _Search = __decorate([
+        defaultPath("_api/search/postquery")
+    ], _Search);
+    return _Search;
+}(_SharePointQueryableInstance));
+export { _Search };
+export var Search = function (baseUrl, options, runtime) {
+    if (options === void 0) { options = {}; }
+    if (runtime === void 0) { runtime = DefaultRuntime; }
+    return function (queryInit) {
+        return (new _Search(baseUrl)).configure(options).setRuntime(runtime).execute(queryInit);
+    };
+};
+var SearchResults = /** @class */ (function () {
+    function SearchResults(rawResponse, _url, _query, _raw, _primary) {
+        if (_raw === void 0) { _raw = null; }
+        if (_primary === void 0) { _primary = null; }
+        this._url = _url;
+        this._query = _query;
+        this._raw = _raw;
+        this._primary = _primary;
+        this._url = this._url.replace(queryRegex, "");
+        this._raw = rawResponse.postquery ? rawResponse.postquery : rawResponse;
+    }
+    Object.defineProperty(SearchResults.prototype, "ElapsedTime", {
+        get: function () {
+            var _a;
+            return ((_a = this === null || this === void 0 ? void 0 : this.RawSearchResults) === null || _a === void 0 ? void 0 : _a.ElapsedTime) || 0;
+        },
+        enumerable: false,
+        configurable: true
+    });
+    Object.defineProperty(SearchResults.prototype, "RowCount", {
+        get: function () {
+            var _a, _b, _c;
+            return ((_c = (_b = (_a = this === null || this === void 0 ? void 0 : this.RawSearchResults) === null || _a === void 0 ? void 0 : _a.PrimaryQueryResult) === null || _b === void 0 ? void 0 : _b.RelevantResults) === null || _c === void 0 ? void 0 : _c.RowCount) || 0;
+        },
+        enumerable: false,
+        configurable: true
+    });
+    Object.defineProperty(SearchResults.prototype, "TotalRows", {
+        get: function () {
+            var _a, _b, _c;
+            return ((_c = (_b = (_a = this === null || this === void 0 ? void 0 : this.RawSearchResults) === null || _a === void 0 ? void 0 : _a.PrimaryQueryResult) === null || _b === void 0 ? void 0 : _b.RelevantResults) === null || _c === void 0 ? void 0 : _c.TotalRows) || 0;
+        },
+        enumerable: false,
+        configurable: true
+    });
+    Object.defineProperty(SearchResults.prototype, "TotalRowsIncludingDuplicates", {
+        get: function () {
+            var _a, _b, _c;
+            return ((_c = (_b = (_a = this === null || this === void 0 ? void 0 : this.RawSearchResults) === null || _a === void 0 ? void 0 : _a.PrimaryQueryResult) === null || _b === void 0 ? void 0 : _b.RelevantResults) === null || _c === void 0 ? void 0 : _c.TotalRowsIncludingDuplicates) || 0;
+        },
+        enumerable: false,
+        configurable: true
+    });
+    Object.defineProperty(SearchResults.prototype, "RawSearchResults", {
+        get: function () {
+            return this._raw;
+        },
+        enumerable: false,
+        configurable: true
+    });
+    Object.defineProperty(SearchResults.prototype, "PrimarySearchResults", {
+        get: function () {
+            var _a, _b, _c, _d;
+            if (this._primary === null) {
+                this._primary = this.formatSearchResults(((_d = (_c = (_b = (_a = this._raw) === null || _a === void 0 ? void 0 : _a.PrimaryQueryResult) === null || _b === void 0 ? void 0 : _b.RelevantResults) === null || _c === void 0 ? void 0 : _c.Table) === null || _d === void 0 ? void 0 : _d.Rows) || null);
+            }
+            return this._primary;
+        },
+        enumerable: false,
+        configurable: true
+    });
+    /**
+     * Gets a page of results
+     *
+     * @param pageNumber Index of the page to return. Used to determine StartRow
+     * @param pageSize Optional, items per page (default = 10)
+     */
+    SearchResults.prototype.getPage = function (pageNumber, pageSize) {
+        // if we got all the available rows we don't have another page
+        if (this.TotalRows < this.RowCount) {
+            return Promise.resolve(null);
+        }
+        // if pageSize is supplied, then we use that regardless of any previous values
+        // otherwise get the previous RowLimit or default to 10
+        var rows = pageSize !== undefined ? pageSize : hOP(this._query, "RowLimit") ? this._query.RowLimit : 10;
+        var query = assign(this._query, {
+            RowLimit: rows,
+            StartRow: rows * (pageNumber - 1),
+        });
+        // we have reached the end
+        if (query.StartRow > this.TotalRows) {
+            return Promise.resolve(null);
+        }
+        return Search(this._url)(query);
+    };
+    /**
+     * Formats a search results array
+     *
+     * @param rawResults The array to process
+     */
+    SearchResults.prototype.formatSearchResults = function (rawResults) {
+        var e_1, _a;
+        var results = new Array();
+        if (typeof (rawResults) === "undefined" || rawResults == null) {
+            return [];
+        }
+        var tempResults = rawResults.results ? rawResults.results : rawResults;
+        try {
+            for (var tempResults_1 = __values(tempResults), tempResults_1_1 = tempResults_1.next(); !tempResults_1_1.done; tempResults_1_1 = tempResults_1.next()) {
+                var tempResult = tempResults_1_1.value;
+                var cells = tempResult.Cells.results ? tempResult.Cells.results : tempResult.Cells;
+                results.push(cells.reduce(function (res, cell) {
+                    Reflect.defineProperty(res, cell.Key, {
+                        configurable: false,
+                        enumerable: true,
+                        value: cell.Value,
+                        writable: false,
+                    });
+                    return res;
+                }, {}));
+            }
+        }
+        catch (e_1_1) { e_1 = { error: e_1_1 }; }
+        finally {
+            try {
+                if (tempResults_1_1 && !tempResults_1_1.done && (_a = tempResults_1.return)) _a.call(tempResults_1);
+            }
+            finally { if (e_1) throw e_1.error; }
+        }
+        return results;
+    };
+    return SearchResults;
+}());
+export { SearchResults };
 //# sourceMappingURL=query.js.map