@pnp/sp 4.0.0-alpha0-v4nightly.20240108 → 4.0.0-alpha0-v4nightly.20240110

package/commonjs/related-items/web.js

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const types_js_1 = require("../webs/types.js");
+const types_js_2 = require("./types.js");
+Reflect.defineProperty(types_js_1._Web.prototype, "relatedItems", {
+    configurable: true,
+    enumerable: true,
+    get: function () {
+        return (0, types_js_2.RelatedItemManager)(this);
+    },
+});
+//# sourceMappingURL=web.js.map

package/commonjs/related-items/web.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"web.js","sourceRoot":"","sources":["../../../../../packages/sp/related-items/web.ts"],"names":[],"mappings":";;AAAA,+CAAwC;AACxC,yCAAqE;AAcrE,OAAO,CAAC,cAAc,CAAC,eAAI,CAAC,SAAS,EAAE,cAAc,EAAE;IACnD,YAAY,EAAE,IAAI;IAClB,UAAU,EAAE,IAAI;IAChB,GAAG,EAAE;QACD,OAAO,IAAA,6BAAkB,EAAC,IAAI,CAAC,CAAC;IACpC,CAAC;CACJ,CAAC,CAAC"}

package/commonjs/search/index.d.ts

@@ -0,0 +1,23 @@
+import { SearchQueryInit } from "./types.js";
+import { SearchResults } from "./query.js";
+import { ISuggestQuery, ISuggestResult } from "./suggest.js";
+export * from "./types.js";
+export { ISearch, SearchQueryBuilder, SearchResults, Search, } from "./query.js";
+export { ISuggest, IPersonalResultSuggestion, ISuggestQuery, ISuggestResult, Suggest, } from "./suggest.js";
+declare module "../fi" {
+    interface SPFI {
+        /**
+         * Conduct a search
+         *
+         * @param query Parameters for the search
+         */
+        search(query: SearchQueryInit): Promise<SearchResults>;
+        /**
+         * Conduct a suggest search query
+         *
+         * @param query Parameters for the search
+         */
+        searchSuggest(query: string | ISuggestQuery): Promise<ISuggestResult>;
+    }
+}
+//# sourceMappingURL=index.d.ts.map

package/commonjs/search/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../../packages/sp/search/index.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,eAAe,EAAE,MAAM,YAAY,CAAC;AAC7C,OAAO,EAAE,aAAa,EAAW,MAAM,YAAY,CAAC;AACpD,OAAO,EAAE,aAAa,EAAE,cAAc,EAAY,MAAM,cAAc,CAAC;AAEvE,cAAc,YAAY,CAAC;AAE3B,OAAO,EACH,OAAO,EACP,kBAAkB,EAClB,aAAa,EACb,MAAM,GACT,MAAM,YAAY,CAAC;AAEpB,OAAO,EACH,QAAQ,EACR,yBAAyB,EACzB,aAAa,EACb,cAAc,EACd,OAAO,GACV,MAAM,cAAc,CAAC;AAEtB,OAAO,QAAQ,OAAO,CAAC;IACnB,UAAU,IAAI;QACV;;;;WAIG;QACH,MAAM,CAAC,KAAK,EAAE,eAAe,GAAG,OAAO,CAAC,aAAa,CAAC,CAAC;QACvD;;;;WAIG;QACH,aAAa,CAAC,KAAK,EAAE,MAAM,GAAG,aAAa,GAAG,OAAO,CAAC,cAAc,CAAC,CAAC;KACzE;CACJ"}

package/commonjs/search/index.js

@@ -0,0 +1,21 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Suggest = exports.Search = exports.SearchResults = exports.SearchQueryBuilder = void 0;
+const tslib_1 = require("tslib");
+const fi_js_1 = require("../fi.js");
+const query_js_1 = require("./query.js");
+const suggest_js_1 = require("./suggest.js");
+(0, tslib_1.__exportStar)(require("./types.js"), exports);
+var query_js_2 = require("./query.js");
+Object.defineProperty(exports, "SearchQueryBuilder", { enumerable: true, get: function () { return query_js_2.SearchQueryBuilder; } });
+Object.defineProperty(exports, "SearchResults", { enumerable: true, get: function () { return query_js_2.SearchResults; } });
+Object.defineProperty(exports, "Search", { enumerable: true, get: function () { return query_js_2.Search; } });
+var suggest_js_2 = require("./suggest.js");
+Object.defineProperty(exports, "Suggest", { enumerable: true, get: function () { return suggest_js_2.Suggest; } });
+fi_js_1.SPFI.prototype.search = function (query) {
+    return (new query_js_1._Search(this._root)).run(query);
+};
+fi_js_1.SPFI.prototype.searchSuggest = function (query) {
+    return (new suggest_js_1._Suggest(this._root)).run(typeof query === "string" ? { querytext: query } : query);
+};
+//# sourceMappingURL=index.js.map

package/commonjs/search/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../packages/sp/search/index.ts"],"names":[],"mappings":";;;;AAAA,oCAAgC;AAEhC,yCAAoD;AACpD,6CAAuE;AAEvE,0DAA2B;AAE3B,uCAKoB;AAHhB,8GAAA,kBAAkB,OAAA;AAClB,yGAAA,aAAa,OAAA;AACb,kGAAA,MAAM,OAAA;AAGV,2CAMsB;AADlB,qGAAA,OAAO,OAAA;AAoBX,YAAI,CAAC,SAAS,CAAC,MAAM,GAAG,UAAsB,KAAsB;IAEhE,OAAO,CAAC,IAAI,kBAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;AAChD,CAAC,CAAC;AAEF,YAAI,CAAC,SAAS,CAAC,aAAa,GAAG,UAAsB,KAA6B;IAE9E,OAAO,CAAC,IAAI,qBAAQ,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,GAAG,CAAC,OAAO,KAAK,KAAK,QAAQ,CAAC,CAAC,CAAC,EAAE,SAAS,EAAE,KAAK,EAAE,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC;AACpG,CAAC,CAAC"}

package/commonjs/search/query.d.ts

@@ -0,0 +1,62 @@
+import { _SPInstance, SPInit } from "../spqueryable.js";
+import { ISearchQuery, ISearchResponse, ISearchResult, ISearchBuilder, SearchQueryInit } from "./types.js";
+/**
+ * Creates a new instance of the SearchQueryBuilder
+ *
+ * @param queryText Initial query text
+ * @param _query Any initial query configuration
+ */
+export declare function SearchQueryBuilder(queryText?: string, _query?: {}): ISearchBuilder;
+/**
+ * Describes the search API
+ *
+ */
+export declare class _Search extends _SPInstance {
+    /**
+     * @returns Promise
+     */
+    run(queryInit: SearchQueryInit): Promise<SearchResults>;
+    /**
+     * Fix array property
+     *
+     * @param prop property to fix for container struct
+     */
+    private fixArrProp;
+    /**
+     * Translates one of the query initializers into a SearchQuery instance
+     *
+     * @param query
+     */
+    private parseQuery;
+}
+export interface ISearch extends Pick<_Search, "run" | "using"> {
+    (init: SearchQueryInit): Promise<SearchResults>;
+}
+export declare const Search: (base: SPInit, path?: string) => ISearch;
+export declare class SearchResults {
+    private _search;
+    private _query;
+    private _raw;
+    private _primary;
+    constructor(rawResponse: any, _search: _Search, _query: ISearchQuery, _raw?: ISearchResponse, _primary?: ISearchResult[]);
+    get ElapsedTime(): number;
+    get RowCount(): number;
+    get TotalRows(): number;
+    get TotalRowsIncludingDuplicates(): number;
+    get RawSearchResults(): ISearchResponse;
+    get PrimarySearchResults(): ISearchResult[];
+    /**
+     * 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)
+     */
+    getPage(pageNumber: number, pageSize?: number): Promise<SearchResults>;
+    /**
+     * Formats a search results array
+     *
+     * @param rawResults The array to process
+     */
+    protected formatSearchResults(rawResults: any): ISearchResult[];
+}
+//# sourceMappingURL=query.d.ts.map

package/commonjs/search/query.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"query.d.ts","sourceRoot":"","sources":["../../../../../packages/sp/search/query.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAsB,MAAM,EAAU,MAAM,mBAAmB,CAAC;AAGpF,OAAO,EAAE,YAAY,EAAE,eAAe,EAAE,aAAa,EAAE,cAAc,EAAE,eAAe,EAAE,MAAM,YAAY,CAAC;AA0C3G;;;;;GAKG;AACH,wBAAgB,kBAAkB,CAAC,SAAS,SAAK,EAAE,MAAM,KAAK,GAAG,cAAc,CA2B9E;AAED;;;GAGG;AACH,qBAIa,OAAQ,SAAQ,WAAW;IAEpC;;OAEG;IACU,GAAG,CAAC,SAAS,EAAE,eAAe,GAAG,OAAO,CAAC,aAAa,CAAC;IAyBpE;;;;OAIG;IACH,OAAO,CAAC,UAAU;IAIlB;;;;OAIG;IACH,OAAO,CAAC,UAAU;CAcrB;AAED,MAAM,WAAW,OAAQ,SAAQ,IAAI,CAAC,OAAO,EAAE,KAAK,GAAG,OAAO,CAAC;IAC3D,CAAC,IAAI,EAAE,eAAe,GAAG,OAAO,CAAC,aAAa,CAAC,CAAC;CACnD;AACD,eAAO,MAAM,MAAM,EAAE,CAAC,IAAI,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,MAAM,KAAK,OAA0C,CAAC;AAEjG,qBAAa,aAAa;IAGlB,OAAO,CAAC,OAAO;IACf,OAAO,CAAC,MAAM;IACd,OAAO,CAAC,IAAI;IACZ,OAAO,CAAC,QAAQ;gBAJR,WAAW,EAAE,GAAG,EAChB,OAAO,EAAE,OAAO,EAChB,MAAM,EAAE,YAAY,EACpB,IAAI,GAAE,eAAsB,EAC5B,QAAQ,GAAE,aAAa,EAAS;IAK5C,IAAW,WAAW,IAAI,MAAM,CAE/B;IAED,IAAW,QAAQ,IAAI,MAAM,CAE5B;IAED,IAAW,SAAS,IAAI,MAAM,CAE7B;IAED,IAAW,4BAA4B,IAAI,MAAM,CAEhD;IAED,IAAW,gBAAgB,IAAI,eAAe,CAE7C;IAED,IAAW,oBAAoB,IAAI,aAAa,EAAE,CAKjD;IAED;;;;;OAKG;IACI,OAAO,CAAC,UAAU,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,aAAa,CAAC;IAyB7E;;;;OAIG;IACH,SAAS,CAAC,mBAAmB,CAAC,UAAU,EAAE,GAAG,GAAG,aAAa,EAAE;CAyBlE"}

package/commonjs/search/query.js

@@ -0,0 +1,220 @@
+"use strict";
+var _Search_1;
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SearchResults = exports.Search = exports._Search = exports.SearchQueryBuilder = void 0;
+const tslib_1 = require("tslib");
+const spqueryable_js_1 = require("../spqueryable.js");
+const core_1 = require("@pnp/core");
+const queryable_1 = require("@pnp/queryable");
+const decorators_js_1 = require("../decorators.js");
+const 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", ""],
+]);
+const props = new Map([]);
+function toPropCase(str) {
+    return str.replace(/^(.)/, ($1) => $1.toUpperCase());
+}
+/**
+ * Creates a new instance of the SearchQueryBuilder
+ *
+ * @param queryText Initial query text
+ * @param _query Any initial query configuration
+ */
+function SearchQueryBuilder(queryText = "", _query = {}) {
+    return new Proxy({
+        query: Object.assign({
+            Querytext: queryText,
+        }, _query),
+    }, {
+        get(self, propertyKey, proxy) {
+            const pk = propertyKey.toString();
+            if (pk === "toSearchQuery") {
+                return () => self.query;
+            }
+            if (funcs.has(pk)) {
+                return (...value) => {
+                    const mappedPk = funcs.get(pk);
+                    self.query[mappedPk.length > 0 ? mappedPk : toPropCase(pk)] = value.length > 1 ? value : value[0];
+                    return proxy;
+                };
+            }
+            const propKey = props.has(pk) ? props.get(pk) : toPropCase(pk);
+            self.query[propKey] = true;
+            return proxy;
+        },
+    });
+}
+exports.SearchQueryBuilder = SearchQueryBuilder;
+/**
+ * Describes the search API
+ *
+ */
+let _Search = _Search_1 = class _Search extends spqueryable_js_1._SPInstance {
+    /**
+     * @returns Promise
+     */
+    async run(queryInit) {
+        const query = this.parseQuery(queryInit);
+        const postBody = (0, queryable_1.body)({
+            request: {
+                ...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),
+            },
+        });
+        const poster = new _Search_1([this, this.parentUrl]);
+        poster.using((0, queryable_1.CacheAlways)(), (0, queryable_1.CacheKey)((0, core_1.getHashCode)(JSON.stringify(postBody)).toString()));
+        const data = await (0, spqueryable_js_1.spPost)(poster, postBody);
+        // Create search instance copy for SearchResult's getPage request.
+        return new SearchResults(data, new _Search_1([this, this.parentUrl]), query);
+    }
+    /**
+     * Fix array property
+     *
+     * @param prop property to fix for container struct
+     */
+    fixArrProp(prop) {
+        return typeof prop === "undefined" ? [] : (0, core_1.isArray)(prop) ? prop : [prop];
+    }
+    /**
+     * Translates one of the query initializers into a SearchQuery instance
+     *
+     * @param query
+     */
+    parseQuery(query) {
+        let finalQuery;
+        if (typeof query === "string") {
+            finalQuery = { Querytext: query };
+        }
+        else if (query.toSearchQuery) {
+            finalQuery = query.toSearchQuery();
+        }
+        else {
+            finalQuery = query;
+        }
+        return finalQuery;
+    }
+};
+_Search = _Search_1 = (0, tslib_1.__decorate)([
+    (0, decorators_js_1.defaultPath)("_api/search/postquery"),
+    (0, queryable_1.invokable)(function (init) {
+        return this.run(init);
+    })
+], _Search);
+exports._Search = _Search;
+exports.Search = (0, spqueryable_js_1.spInvokableFactory)(_Search);
+class SearchResults {
+    constructor(rawResponse, _search, _query, _raw = null, _primary = null) {
+        this._search = _search;
+        this._query = _query;
+        this._raw = _raw;
+        this._primary = _primary;
+        this._raw = rawResponse.postquery ? rawResponse.postquery : rawResponse;
+    }
+    get ElapsedTime() {
+        var _a;
+        return ((_a = this === null || this === void 0 ? void 0 : this.RawSearchResults) === null || _a === void 0 ? void 0 : _a.ElapsedTime) || 0;
+    }
+    get RowCount() {
+        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;
+    }
+    get TotalRows() {
+        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;
+    }
+    get TotalRowsIncludingDuplicates() {
+        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;
+    }
+    get RawSearchResults() {
+        return this._raw;
+    }
+    get PrimarySearchResults() {
+        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;
+    }
+    /**
+     * 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)
+     */
+    getPage(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
+        const rows = pageSize !== undefined ? pageSize : (0, core_1.hOP)(this._query, "RowLimit") ? this._query.RowLimit : 10;
+        const query = {
+            ...this._query,
+            RowLimit: rows,
+            StartRow: rows * (pageNumber - 1),
+        };
+        // we have reached the end
+        if (query.StartRow > this.TotalRows) {
+            return Promise.resolve(null);
+        }
+        return this._search.run(query);
+    }
+    /**
+     * Formats a search results array
+     *
+     * @param rawResults The array to process
+     */
+    formatSearchResults(rawResults) {
+        const results = new Array();
+        if (typeof (rawResults) === "undefined" || rawResults == null) {
+            return [];
+        }
+        const tempResults = rawResults.results ? rawResults.results : rawResults;
+        for (const tempResult of tempResults) {
+            const cells = tempResult.Cells.results ? tempResult.Cells.results : tempResult.Cells;
+            results.push(cells.reduce((res, cell) => {
+                res[cell.Key] = cell.Value;
+                return res;
+            }, {}));
+        }
+        return results;
+    }
+}
+exports.SearchResults = SearchResults;
+//# sourceMappingURL=query.js.map

package/commonjs/search/query.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"query.js","sourceRoot":"","sources":["../../../../../packages/sp/search/query.ts"],"names":[],"mappings":";;;;;AAAA,sDAAoF;AACpF,oCAAsD;AACtD,8CAAwE;AAExE,oDAA+C;AAE/C,MAAM,KAAK,GAAG,IAAI,GAAG,CAAiB;IAClC,CAAC,MAAM,EAAE,WAAW,CAAC;IACrB,CAAC,UAAU,EAAE,eAAe,CAAC;IAC7B,CAAC,UAAU,EAAE,UAAU,CAAC;IACxB,CAAC,yBAAyB,EAAE,EAAE,CAAC;IAC/B,CAAC,UAAU,EAAE,EAAE,CAAC;IAChB,CAAC,UAAU,EAAE,EAAE,CAAC;IAChB,CAAC,gBAAgB,EAAE,EAAE,CAAC;IACtB,CAAC,aAAa,EAAE,EAAE,CAAC;IACnB,CAAC,kBAAkB,EAAE,EAAE,CAAC;IACxB,CAAC,SAAS,EAAE,EAAE,CAAC;IACf,CAAC,YAAY,EAAE,EAAE,CAAC;IAClB,CAAC,mBAAmB,EAAE,EAAE,CAAC;IACzB,CAAC,UAAU,EAAE,EAAE,CAAC;IAChB,CAAC,mBAAmB,EAAE,EAAE,CAAC;IACzB,CAAC,UAAU,EAAE,EAAE,CAAC;IAChB,CAAC,SAAS,EAAE,EAAE,CAAC;IACf,CAAC,0BAA0B,EAAE,EAAE,CAAC;IAChC,CAAC,YAAY,EAAE,EAAE,CAAC;IAClB,CAAC,qBAAqB,EAAE,EAAE,CAAC;IAC3B,CAAC,YAAY,EAAE,EAAE,CAAC;IAClB,CAAC,UAAU,EAAE,EAAE,CAAC;IAChB,CAAC,YAAY,EAAE,EAAE,CAAC;IAClB,CAAC,4BAA4B,EAAE,EAAE,CAAC;IAClC,CAAC,iBAAiB,EAAE,EAAE,CAAC;IACvB,CAAC,uCAAuC,EAAE,EAAE,CAAC;IAC7C,CAAC,uBAAuB,EAAE,EAAE,CAAC;IAC7B,CAAC,YAAY,EAAE,EAAE,CAAC;IAClB,CAAC,sBAAsB,EAAE,EAAE,CAAC;IAC5B,CAAC,kBAAkB,EAAE,EAAE,CAAC;IACxB,CAAC,eAAe,EAAE,EAAE,CAAC;CACxB,CAAC,CAAC;AAEH,MAAM,KAAK,GAAG,IAAI,GAAG,CAAiB,EAAE,CAAC,CAAC;AAE1C,SAAS,UAAU,CAAC,GAAW;IAC3B,OAAO,GAAG,CAAC,OAAO,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,CAAC,WAAW,EAAE,CAAC,CAAC;AACzD,CAAC;AAED;;;;;GAKG;AACH,SAAgB,kBAAkB,CAAC,SAAS,GAAG,EAAE,EAAE,MAAM,GAAG,EAAE;IAE1D,OAAO,IAAI,KAAK,CAAM;QAClB,KAAK,EAAE,MAAM,CAAC,MAAM,CAAC;YACjB,SAAS,EAAE,SAAS;SACvB,EAAE,MAAM,CAAC;KACb,EAAE;QACC,GAAG,CAAC,IAAI,EAAE,WAAW,EAAE,KAAK;YAExB,MAAM,EAAE,GAAG,WAAW,CAAC,QAAQ,EAAE,CAAC;YAElC,IAAI,EAAE,KAAK,eAAe,EAAE;gBACxB,OAAO,GAAG,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC;aAC3B;YAED,IAAI,KAAK,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE;gBACf,OAAO,CAAC,GAAG,KAAY,EAAE,EAAE;oBACvB,MAAM,QAAQ,GAAG,KAAK,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;oBAC/B,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,UAAU,CAAC,EAAE,CAAC,CAAC,GAAG,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;oBAClG,OAAO,KAAK,CAAC;gBACjB,CAAC,CAAC;aACL;YACD,MAAM,OAAO,GAAG,KAAK,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC,EAAE,CAAC,CAAC;YAC/D,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,GAAG,IAAI,CAAC;YAC3B,OAAO,KAAK,CAAC;QACjB,CAAC;KACJ,CAAC,CAAC;AACP,CAAC;AA3BD,gDA2BC;AAED;;;GAGG;AAKH,IAAa,OAAO,eAApB,MAAa,OAAQ,SAAQ,4BAAW;IAEpC;;OAEG;IACI,KAAK,CAAC,GAAG,CAAC,SAA0B;QAEvC,MAAM,KAAK,GAAG,IAAI,CAAC,UAAU,CAAC,SAAS,CAAC,CAAC;QAEzC,MAAM,QAAQ,GAAgB,IAAA,gBAAI,EAAC;YAC/B,OAAO,EAAE;gBACL,GAAG,KAAK;gBACR,wBAAwB,EAAE,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,wBAAwB,CAAC;gBACzE,UAAU,EAAE,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,UAAU,CAAC;gBAC7C,iBAAiB,EAAE,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,iBAAiB,CAAC;gBAC3D,eAAe,EAAE,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,eAAe,CAAC;gBACvD,gBAAgB,EAAE,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,gBAAgB,CAAC;gBACzD,QAAQ,EAAE,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,QAAQ,CAAC;aAC5C;SACJ,CAAC,CAAC;QAEH,MAAM,MAAM,GAAG,IAAI,SAAO,CAAC,CAAC,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC;QACnD,MAAM,CAAC,KAAK,CAAC,IAAA,uBAAW,GAAE,EAAE,IAAA,oBAAQ,EAAC,IAAA,kBAAW,EAAC,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,CAAC,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC;QAExF,MAAM,IAAI,GAAG,MAAM,IAAA,uBAAM,EAAC,MAAM,EAAE,QAAQ,CAAC,CAAC;QAE5C,kEAAkE;QAClE,OAAO,IAAI,aAAa,CAAC,IAAI,EAAE,IAAI,SAAO,CAAC,CAAC,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC;IAC/E,CAAC;IAED;;;;OAIG;IACK,UAAU,CAAI,IAAa;QAC/B,OAAO,OAAO,IAAI,KAAK,WAAW,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,IAAA,cAAO,EAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;IAC5E,CAAC;IAED;;;;OAIG;IACK,UAAU,CAAC,KAAsB;QAErC,IAAI,UAAwB,CAAC;QAE7B,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE;YAC3B,UAAU,GAAG,EAAE,SAAS,EAAE,KAAK,EAAE,CAAC;SACrC;aAAM,IAAK,KAAwB,CAAC,aAAa,EAAE;YAChD,UAAU,GAAI,KAAwB,CAAC,aAAa,EAAE,CAAC;SAC1D;aAAM;YACH,UAAU,GAAiB,KAAK,CAAC;SACpC;QAED,OAAO,UAAU,CAAC;IACtB,CAAC;CACJ,CAAA;AA1DY,OAAO;IAJnB,IAAA,2BAAW,EAAC,uBAAuB,CAAC;IACpC,IAAA,qBAAS,EAAC,UAAyB,IAAI;QACpC,OAAO,IAAI,CAAC,GAAG,CAAkB,IAAI,CAAC,CAAC;IAC3C,CAAC,CAAC;GACW,OAAO,CA0DnB;AA1DY,0BAAO;AA+DP,QAAA,MAAM,GAAkD,IAAA,mCAAkB,EAAC,OAAO,CAAC,CAAC;AAEjG,MAAa,aAAa;IAEtB,YAAY,WAAgB,EAChB,OAAgB,EAChB,MAAoB,EACpB,OAAwB,IAAI,EAC5B,WAA4B,IAAI;QAHhC,YAAO,GAAP,OAAO,CAAS;QAChB,WAAM,GAAN,MAAM,CAAc;QACpB,SAAI,GAAJ,IAAI,CAAwB;QAC5B,aAAQ,GAAR,QAAQ,CAAwB;QAExC,IAAI,CAAC,IAAI,GAAG,WAAW,CAAC,SAAS,CAAC,CAAC,CAAC,WAAW,CAAC,SAAS,CAAC,CAAC,CAAC,WAAW,CAAC;IAC5E,CAAC;IAED,IAAW,WAAW;;QAClB,OAAO,CAAA,MAAA,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,gBAAgB,0CAAE,WAAW,KAAI,CAAC,CAAC;IACpD,CAAC;IAED,IAAW,QAAQ;;QACf,OAAO,CAAA,MAAA,MAAA,MAAA,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,gBAAgB,0CAAE,kBAAkB,0CAAE,eAAe,0CAAE,QAAQ,KAAI,CAAC,CAAC;IACtF,CAAC;IAED,IAAW,SAAS;;QAChB,OAAO,CAAA,MAAA,MAAA,MAAA,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,gBAAgB,0CAAE,kBAAkB,0CAAE,eAAe,0CAAE,SAAS,KAAI,CAAC,CAAC;IACvF,CAAC;IAED,IAAW,4BAA4B;;QACnC,OAAO,CAAA,MAAA,MAAA,MAAA,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,gBAAgB,0CAAE,kBAAkB,0CAAE,eAAe,0CAAE,4BAA4B,KAAI,CAAC,CAAC;IAC1G,CAAC;IAED,IAAW,gBAAgB;QACvB,OAAO,IAAI,CAAC,IAAI,CAAC;IACrB,CAAC;IAED,IAAW,oBAAoB;;QAC3B,IAAI,IAAI,CAAC,QAAQ,KAAK,IAAI,EAAE;YACxB,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC,mBAAmB,CAAC,CAAA,MAAA,MAAA,MAAA,MAAA,IAAI,CAAC,IAAI,0CAAE,kBAAkB,0CAAE,eAAe,0CAAE,KAAK,0CAAE,IAAI,KAAI,IAAI,CAAC,CAAC;SACjH;QACD,OAAO,IAAI,CAAC,QAAQ,CAAC;IACzB,CAAC;IAED;;;;;OAKG;IACI,OAAO,CAAC,UAAkB,EAAE,QAAiB;QAEhD,8DAA8D;QAC9D,IAAI,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC,QAAQ,EAAE;YAChC,OAAO,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;SAChC;QAED,8EAA8E;QAC9E,uDAAuD;QACvD,MAAM,IAAI,GAAG,QAAQ,KAAK,SAAS,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,IAAA,UAAG,EAAC,IAAI,CAAC,MAAM,EAAE,UAAU,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,CAAC,EAAE,CAAC;QAE1G,MAAM,KAAK,GAAiB;YACxB,GAAG,IAAI,CAAC,MAAM;YACd,QAAQ,EAAE,IAAI;YACd,QAAQ,EAAE,IAAI,GAAG,CAAC,UAAU,GAAG,CAAC,CAAC;SACpC,CAAC;QAEF,0BAA0B;QAC1B,IAAI,KAAK,CAAC,QAAQ,GAAG,IAAI,CAAC,SAAS,EAAE;YACjC,OAAO,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;SAChC;QAED,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;IACnC,CAAC;IAED;;;;OAIG;IACO,mBAAmB,CAAC,UAAe;QAEzC,MAAM,OAAO,GAAG,IAAI,KAAK,EAAiB,CAAC;QAE3C,IAAI,OAAO,CAAC,UAAU,CAAC,KAAK,WAAW,IAAI,UAAU,IAAI,IAAI,EAAE;YAC3D,OAAO,EAAE,CAAC;SACb;QAED,MAAM,WAAW,GAAG,UAAU,CAAC,OAAO,CAAC,CAAC,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC,CAAC,UAAU,CAAC;QAEzE,KAAK,MAAM,UAAU,IAAI,WAAW,EAAE;YAElC,MAAM,KAAK,GAAkC,UAAU,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,UAAU,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,UAAU,CAAC,KAAK,CAAC;YAEpH,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,IAAI,EAAE,EAAE;gBAEpC,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC;gBAE3B,OAAO,GAAG,CAAC;YAEf,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC;SACX;QAED,OAAO,OAAO,CAAC;IACnB,CAAC;CACJ;AAnGD,sCAmGC"}

package/commonjs/search/suggest.d.ts

@@ -0,0 +1,76 @@
+import { _SPInstance, SPInit } from "../spqueryable.js";
+export declare class _Suggest extends _SPInstance {
+    run(query: ISuggestQuery): Promise<ISuggestResult>;
+    private mapQueryToQueryString;
+}
+export interface ISuggest extends Pick<_Suggest, "run" | "using"> {
+    (init: ISuggestQuery): Promise<ISuggestResult>;
+}
+export declare const Suggest: (base: SPInit, path?: string) => ISuggest;
+/**
+ * Defines a query execute against the search/suggest endpoint (see https://msdn.microsoft.com/en-us/library/office/dn194079.aspx)
+ */
+export interface ISuggestQuery {
+    /**
+     * A string that contains the text for the search query.
+     */
+    querytext: string;
+    /**
+     * The number of query suggestions to retrieve. Must be greater than zero (0). The default value is 5.
+     */
+    count?: number;
+    /**
+     * The number of personal results to retrieve. Must be greater than zero (0). The default value is 5.
+     */
+    personalCount?: number;
+    /**
+     * A Boolean value that specifies whether to retrieve pre-query or post-query suggestions. true to return pre-query suggestions; otherwise, false. The default value is false.
+     */
+    preQuery?: boolean;
+    /**
+     * A Boolean value that specifies whether to hit-highlight or format in bold the query suggestions. true to format in bold the terms in the returned query suggestions
+     * that match terms in the specified query; otherwise, false. The default value is true.
+     */
+    hitHighlighting?: boolean;
+    /**
+     * A Boolean value that specifies whether to capitalize the first letter in each term in the returned query suggestions. true to capitalize the first letter in each term;
+     * otherwise, false. The default value is false.
+     */
+    capitalize?: boolean;
+    /**
+     * The locale ID (LCID) for the query (see https://msdn.microsoft.com/en-us/library/cc233982.aspx).
+     */
+    culture?: string;
+    /**
+     * A Boolean value that specifies whether stemming is enabled. true to enable stemming; otherwise, false. The default value is true.
+     */
+    stemming?: boolean;
+    /**
+     * A Boolean value that specifies whether to include people names in the returned query suggestions. true to include people names in the returned query suggestions;
+     * otherwise, false. The default value is true.
+     */
+    includePeople?: boolean;
+    /**
+     * A Boolean value that specifies whether to turn on query rules for this query. true to turn on query rules; otherwise, false. The default value is true.
+     */
+    queryRules?: boolean;
+    /**
+     * A Boolean value that specifies whether to return query suggestions for prefix matches. true to return query suggestions based on prefix matches, otherwise, false when
+     * query suggestions should match the full query word.
+     */
+    prefixMatch?: boolean;
+    [key: string]: string | number | boolean;
+}
+export interface ISuggestResult {
+    readonly PeopleNames: string[];
+    readonly PersonalResults: IPersonalResultSuggestion[];
+    readonly Queries: any[];
+}
+export interface IPersonalResultSuggestion {
+    readonly HighlightedTitle?: string;
+    readonly IsBestBet?: boolean;
+    readonly Title?: string;
+    readonly TypeId?: string;
+    readonly Url?: string;
+}
+//# sourceMappingURL=suggest.d.ts.map

package/commonjs/search/suggest.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"suggest.d.ts","sourceRoot":"","sources":["../../../../../packages/sp/search/suggest.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,EAAsB,MAAM,mBAAmB,CAAC;AAI5E,qBACa,QAAS,SAAQ,WAAW;IAExB,GAAG,CAAC,KAAK,EAAE,aAAa,GAAG,OAAO,CAAC,cAAc,CAAC;IAc/D,OAAO,CAAC,qBAAqB;CAuBhC;AAED,MAAM,WAAW,QAAS,SAAQ,IAAI,CAAC,QAAQ,EAAE,KAAK,GAAG,OAAO,CAAC;IAC7D,CAAC,IAAI,EAAE,aAAa,GAAG,OAAO,CAAC,cAAc,CAAC,CAAC;CAClD;AACD,eAAO,MAAM,OAAO,EAAE,CAAC,IAAI,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,MAAM,KAAK,QAA4C,CAAC;AAEpG;;GAEG;AACH,MAAM,WAAW,aAAa;IAC1B;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAC;IAEnB;;;OAGG;IACH,eAAe,CAAC,EAAE,OAAO,CAAC;IAE1B;;;OAGG;IACH,UAAU,CAAC,EAAE,OAAO,CAAC;IAErB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAC;IAEnB;;;OAGG;IACH,aAAa,CAAC,EAAE,OAAO,CAAC;IAExB;;OAEG;IACH,UAAU,CAAC,EAAE,OAAO,CAAC;IAErB;;;OAGG;IACH,WAAW,CAAC,EAAE,OAAO,CAAC;IAEtB,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,GAAG,OAAO,CAAC;CAC5C;AAED,MAAM,WAAW,cAAc;IAC3B,QAAQ,CAAC,WAAW,EAAE,MAAM,EAAE,CAAC;IAC/B,QAAQ,CAAC,eAAe,EAAE,yBAAyB,EAAE,CAAC;IACtD,QAAQ,CAAC,OAAO,EAAE,GAAG,EAAE,CAAC;CAC3B;AAED,MAAM,WAAW,yBAAyB;IACtC,QAAQ,CAAC,gBAAgB,CAAC,EAAE,MAAM,CAAC;IACnC,QAAQ,CAAC,SAAS,CAAC,EAAE,OAAO,CAAC;IAC7B,QAAQ,CAAC,KAAK,CAAC,EAAE,MAAM,CAAC;IACxB,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,CAAC;IACzB,QAAQ,CAAC,GAAG,CAAC,EAAE,MAAM,CAAC;CACzB"}

package/commonjs/search/suggest.js

@@ -0,0 +1,44 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Suggest = exports._Suggest = void 0;
+const tslib_1 = require("tslib");
+const spqueryable_js_1 = require("../spqueryable.js");
+const core_1 = require("@pnp/core");
+const decorators_js_1 = require("../decorators.js");
+let _Suggest = class _Suggest extends spqueryable_js_1._SPInstance {
+    async run(query) {
+        this.mapQueryToQueryString(query);
+        const response = await this();
+        const mapper = (0, core_1.hOP)(response, "suggest") ? (s_1) => response.suggest[s_1].results : (s_2) => response[s_2];
+        return {
+            PeopleNames: mapper("PeopleNames"),
+            PersonalResults: mapper("PersonalResults"),
+            Queries: mapper("Queries"),
+        };
+    }
+    mapQueryToQueryString(query) {
+        const setProp = (q) => (checkProp) => (sp) => {
+            if ((0, core_1.hOP)(q, checkProp)) {
+                this.query.set(sp, q[checkProp].toString());
+            }
+        };
+        this.query.set("querytext", `'${query.querytext}'`);
+        const querySetter = setProp(query);
+        querySetter("count")("inumberofquerysuggestions");
+        querySetter("personalCount")("inumberofresultsuggestions");
+        querySetter("preQuery")("fprequerysuggestions");
+        querySetter("hitHighlighting")("fhithighlighting");
+        querySetter("capitalize")("fcapitalizefirstletters");
+        querySetter("culture")("culture");
+        querySetter("stemming")("enablestemming");
+        querySetter("includePeople")("showpeoplenamesuggestions");
+        querySetter("queryRules")("enablequeryrules");
+        querySetter("prefixMatch")("fprefixmatchallterms");
+    }
+};
+_Suggest = (0, tslib_1.__decorate)([
+    (0, decorators_js_1.defaultPath)("_api/search/suggest")
+], _Suggest);
+exports._Suggest = _Suggest;
+exports.Suggest = (0, spqueryable_js_1.spInvokableFactory)(_Suggest);
+//# sourceMappingURL=suggest.js.map

package/commonjs/search/suggest.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"suggest.js","sourceRoot":"","sources":["../../../../../packages/sp/search/suggest.ts"],"names":[],"mappings":";;;;AAAA,sDAA4E;AAC5E,oCAAgC;AAChC,oDAA+C;AAG/C,IAAa,QAAQ,GAArB,MAAa,QAAS,SAAQ,4BAAW;IAE9B,KAAK,CAAC,GAAG,CAAC,KAAoB;QAEjC,IAAI,CAAC,qBAAqB,CAAC,KAAK,CAAC,CAAC;QAElC,MAAM,QAAQ,GAAG,MAAM,IAAI,EAAE,CAAC;QAC9B,MAAM,MAAM,GAAG,IAAA,UAAG,EAAC,QAAQ,EAAE,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC,GAAW,EAAE,EAAE,CAAC,QAAQ,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,GAAW,EAAE,EAAE,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC;QAE1H,OAAO;YACH,WAAW,EAAE,MAAM,CAAC,aAAa,CAAC;YAClC,eAAe,EAAE,MAAM,CAAC,iBAAiB,CAAC;YAC1C,OAAO,EAAE,MAAM,CAAC,SAAS,CAAC;SAC7B,CAAC;IACN,CAAC;IAEO,qBAAqB,CAAC,KAAoB;QAE9C,MAAM,OAAO,GAAG,CAAC,CAAgB,EAAE,EAAE,CAAC,CAAC,SAAiB,EAAE,EAAE,CAAC,CAAC,EAAU,EAAE,EAAE;YACxE,IAAI,IAAA,UAAG,EAAC,CAAC,EAAE,SAAS,CAAC,EAAE;gBACnB,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,EAAE,EAAE,CAAC,CAAC,SAAS,CAAC,CAAC,QAAQ,EAAE,CAAC,CAAC;aAC/C;QACL,CAAC,CAAC;QAEF,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,WAAW,EAAE,IAAI,KAAK,CAAC,SAAS,GAAG,CAAC,CAAC;QAEpD,MAAM,WAAW,GAAG,OAAO,CAAC,KAAK,CAAC,CAAC;QAEnC,WAAW,CAAC,OAAO,CAAC,CAAC,2BAA2B,CAAC,CAAC;QAClD,WAAW,CAAC,eAAe,CAAC,CAAC,4BAA4B,CAAC,CAAC;QAC3D,WAAW,CAAC,UAAU,CAAC,CAAC,sBAAsB,CAAC,CAAC;QAChD,WAAW,CAAC,iBAAiB,CAAC,CAAC,kBAAkB,CAAC,CAAC;QACnD,WAAW,CAAC,YAAY,CAAC,CAAC,yBAAyB,CAAC,CAAC;QACrD,WAAW,CAAC,SAAS,CAAC,CAAC,SAAS,CAAC,CAAC;QAClC,WAAW,CAAC,UAAU,CAAC,CAAC,gBAAgB,CAAC,CAAC;QAC1C,WAAW,CAAC,eAAe,CAAC,CAAC,2BAA2B,CAAC,CAAC;QAC1D,WAAW,CAAC,YAAY,CAAC,CAAC,kBAAkB,CAAC,CAAC;QAC9C,WAAW,CAAC,aAAa,CAAC,CAAC,sBAAsB,CAAC,CAAC;IACvD,CAAC;CACJ,CAAA;AAvCY,QAAQ;IADpB,IAAA,2BAAW,EAAC,qBAAqB,CAAC;GACtB,QAAQ,CAuCpB;AAvCY,4BAAQ;AA4CR,QAAA,OAAO,GAAmD,IAAA,mCAAkB,EAAC,QAAQ,CAAC,CAAC"}