@pnp/sp 2.8.0 → 2.12.0

package/search/suggest.d.ts

@@ -1,77 +1,77 @@
-import { _SharePointQueryableInstance, ISharePointQueryable } from "../sharepointqueryable.js";
-import { IConfigOptions } from "@pnp/common";
-export declare class _Suggest extends _SharePointQueryableInstance {
-    execute(query: ISuggestQuery): Promise<ISuggestResult>;
-    private mapQueryToQueryString;
-}
-export interface ISuggest {
-    (query: ISuggestQuery): Promise<ISuggestResult>;
-}
-export declare const Suggest: (baseUrl: string | ISharePointQueryable, options?: IConfigOptions, runtime?: import("@pnp/common").Runtime) => 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;
-}
+import { _SharePointQueryableInstance, ISharePointQueryable } from "../sharepointqueryable.js";
+import { IConfigOptions } from "@pnp/common";
+export declare class _Suggest extends _SharePointQueryableInstance {
+    execute(query: ISuggestQuery): Promise<ISuggestResult>;
+    private mapQueryToQueryString;
+}
+export interface ISuggest {
+    (query: ISuggestQuery): Promise<ISuggestResult>;
+}
+export declare const Suggest: (baseUrl: string | ISharePointQueryable, options?: IConfigOptions, runtime?: import("@pnp/common").Runtime) => 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/search/suggest.js

@@ -1,67 +1,67 @@
-import { __awaiter, __decorate, __extends, __generator } from "tslib";
-import { _SharePointQueryableInstance } from "../sharepointqueryable.js";
-import { hOP, DefaultRuntime } from "@pnp/common";
-import { defaultPath } from "../decorators.js";
-import { tag } from "../telemetry.js";
-var _Suggest = /** @class */ (function (_super) {
-    __extends(_Suggest, _super);
-    function _Suggest() {
-        return _super !== null && _super.apply(this, arguments) || this;
-    }
-    _Suggest.prototype.execute = function (query) {
-        return __awaiter(this, void 0, void 0, function () {
-            var response, mapper;
-            return __generator(this, function (_a) {
-                switch (_a.label) {
-                    case 0:
-                        this.mapQueryToQueryString(query);
-                        return [4 /*yield*/, this.get()];
-                    case 1:
-                        response = _a.sent();
-                        mapper = hOP(response, "suggest") ? function (s_1) { return response.suggest[s_1].results; } : function (s_2) { return response[s_2]; };
-                        return [2 /*return*/, {
-                                PeopleNames: mapper("PeopleNames"),
-                                PersonalResults: mapper("PersonalResults"),
-                                Queries: mapper("Queries"),
-                            }];
-                }
-            });
-        });
-    };
-    _Suggest.prototype.mapQueryToQueryString = function (query) {
-        var _this = this;
-        var setProp = function (q) { return function (checkProp) { return function (sp) {
-            if (hOP(q, checkProp)) {
-                _this.query.set(sp, q[checkProp].toString());
-            }
-        }; }; };
-        this.query.set("querytext", "'" + query.querytext + "'");
-        var 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");
-    };
-    __decorate([
-        tag("su.execute")
-    ], _Suggest.prototype, "execute", null);
-    _Suggest = __decorate([
-        defaultPath("_api/search/suggest")
-    ], _Suggest);
-    return _Suggest;
-}(_SharePointQueryableInstance));
-export { _Suggest };
-export var Suggest = function (baseUrl, options, runtime) {
-    if (options === void 0) { options = {}; }
-    if (runtime === void 0) { runtime = DefaultRuntime; }
-    return function (query) {
-        return (new _Suggest(baseUrl)).configure(options).setRuntime(runtime).execute(query);
-    };
-};
+import { __awaiter, __decorate, __extends, __generator } from "tslib";
+import { _SharePointQueryableInstance } from "../sharepointqueryable.js";
+import { hOP, DefaultRuntime } from "@pnp/common";
+import { defaultPath } from "../decorators.js";
+import { tag } from "../telemetry.js";
+var _Suggest = /** @class */ (function (_super) {
+    __extends(_Suggest, _super);
+    function _Suggest() {
+        return _super !== null && _super.apply(this, arguments) || this;
+    }
+    _Suggest.prototype.execute = function (query) {
+        return __awaiter(this, void 0, void 0, function () {
+            var response, mapper;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0:
+                        this.mapQueryToQueryString(query);
+                        return [4 /*yield*/, this.get()];
+                    case 1:
+                        response = _a.sent();
+                        mapper = hOP(response, "suggest") ? function (s_1) { return response.suggest[s_1].results; } : function (s_2) { return response[s_2]; };
+                        return [2 /*return*/, {
+                                PeopleNames: mapper("PeopleNames"),
+                                PersonalResults: mapper("PersonalResults"),
+                                Queries: mapper("Queries"),
+                            }];
+                }
+            });
+        });
+    };
+    _Suggest.prototype.mapQueryToQueryString = function (query) {
+        var _this = this;
+        var setProp = function (q) { return function (checkProp) { return function (sp) {
+            if (hOP(q, checkProp)) {
+                _this.query.set(sp, q[checkProp].toString());
+            }
+        }; }; };
+        this.query.set("querytext", "'" + query.querytext + "'");
+        var 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");
+    };
+    __decorate([
+        tag("su.execute")
+    ], _Suggest.prototype, "execute", null);
+    _Suggest = __decorate([
+        defaultPath("_api/search/suggest")
+    ], _Suggest);
+    return _Suggest;
+}(_SharePointQueryableInstance));
+export { _Suggest };
+export var Suggest = function (baseUrl, options, runtime) {
+    if (options === void 0) { options = {}; }
+    if (runtime === void 0) { runtime = DefaultRuntime; }
+    return function (query) {
+        return (new _Suggest(baseUrl)).configure(options).setRuntime(runtime).execute(query);
+    };
+};
 //# sourceMappingURL=suggest.js.map