@microsoft/sp-search-extensibility 1.15.0-beta.1 → 1.15.0

package/dist/4958ea79-6ff3-4480-8291-0932dd010869.manifest.json

@@ -12,12 +12,12 @@
     "scriptResources": {
       "sp-search-extensibility": {
         "type": "path",
-        "path": "sp-search-extensibility_none_78d3312af37751eb75c1.js"
+        "path": "sp-search-extensibility_none_fdb6f0ef1959cb9349fd.js"
       },
       "tslib": {
         "type": "component",
         "id": "01c4df03-e775-48cb-aa14-171ee5199a15",
-        "version": "1.10.0"
+        "version": "2.3.1"
       },
       "@microsoft/sp-loader": {
         "type": "component",

package/dist/index-internal.d.ts

@@ -8,85 +8,18 @@ import { BaseExtension } from '@microsoft/sp-extension-base';
 import { ExtensionContext } from '@microsoft/sp-extension-base';
 import { ServiceScope } from '@microsoft/sp-core-library';
 
-/**
- * This is the base class that third parties should extend when implementing
- * a client-side extension that can modify the search query.
- *
- * In the component manifest, the "extensionType" should be set to "SearchQueryModifier".
- *
- * @beta
- */
-export declare abstract class BaseSearchQueryModifier<TProperties> extends BaseExtension<TProperties> {
-    /**
-     * {@inheritDoc @microsoft/sp-component-base#BaseComponent.context}
-     */
-    protected readonly context: SearchQueryModifierContext;
-    /**
-     * Timeout for the search query modifier in milliseconds.
-     * If the execution takes longer than the timeout, the original query will be used instead of the modified one.
-     *
-     * @virtual
-     */
-    get timeout(): number;
-    /**
-     * Returns a modified search query.
-     *
-     * @param query - Query to modify.
-     * @param scenario - Search scenario.
-     * @returns - Modified query.
-     *
-     * @virtual
-     */
-    modifySearchQuery(query: IQuery, scenario: SearchQueryScenario): Promise<IQuery>;
-}
+/* Excluded from this release type: BaseSearchQueryModifier */
 
 /* Excluded from this release type: _IPreloadedCustomAction */
 
-/**
- * Query object. Includes the query text that will be used for search and exposed through dynamic data.
- *
- * @remarks
- * Additional properties can be added to the object to pass data between extensions.
- *
- * @beta
- */
-export declare interface IQuery {
-    /**
-     * Text of the query.
-     */
-    queryText: string;
-    /**
-     * Query text that the user provided.
-     */
-    originalQueryText: string;
-}
+/* Excluded from this release type: IQuery */
 
 /* Excluded from this release type: _ISearchQueryExtensionManager */
 
 /* Excluded from this release type: _SearchQueryExtensionManager */
 
-/**
- * Context for the search query modifier extensions.
- *
- * @beta
- */
-export declare class SearchQueryModifierContext extends ExtensionContext {
-}
+/* Excluded from this release type: SearchQueryModifierContext */
 
-/**
- * Scenario for the search query modifier.
- *
- * @beta
- */
-export declare enum SearchQueryScenario {
-    /**
-     * Search results scenario.
-     */
-    SearchResults = 1,
-    /**
-     * Search suggestions scenario.
-     */
-    SearchSuggestions = 2
-}
+/* Excluded from this release type: SearchQueryScenario */
 
 export { }

package/dist/tsdoc-metadata.json

@@ -5,7 +5,7 @@
   "toolPackages": [
     {
       "packageName": "@microsoft/api-extractor",
-      "packageVersion": "7.19.4"
+      "packageVersion": "7.24.1"
     }
   ]
 }

package/lib-commonjs/index.js

@@ -1,15 +1,19 @@
 "use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 Object.defineProperty(exports, "__esModule", { value: true });
+exports._SearchQueryExtensionManager = exports.SearchQueryModifierContext = exports.SearchQueryScenario = exports.BaseSearchQueryModifier = void 0;
 /**
  * SharePoint Framework developer support for customizing search.
  *
  * @packagedocumentation
  */
 var BaseSearchQueryModifier_1 = require("./BaseSearchQueryModifier");
-Object.defineProperty(exports, "BaseSearchQueryModifier", { enumerable: true, get: function () { return BaseSearchQueryModifier_1.default; } });
+Object.defineProperty(exports, "BaseSearchQueryModifier", { enumerable: true, get: function () { return __importDefault(BaseSearchQueryModifier_1).default; } });
 Object.defineProperty(exports, "SearchQueryScenario", { enumerable: true, get: function () { return BaseSearchQueryModifier_1.SearchQueryScenario; } });
 var SearchQueryModifierContext_1 = require("./SearchQueryModifierContext");
-Object.defineProperty(exports, "SearchQueryModifierContext", { enumerable: true, get: function () { return SearchQueryModifierContext_1.default; } });
+Object.defineProperty(exports, "SearchQueryModifierContext", { enumerable: true, get: function () { return __importDefault(SearchQueryModifierContext_1).default; } });
 var SearchQueryExtensionManager_1 = require("./SearchQueryExtensionManager");
-Object.defineProperty(exports, "_SearchQueryExtensionManager", { enumerable: true, get: function () { return SearchQueryExtensionManager_1.default; } });
+Object.defineProperty(exports, "_SearchQueryExtensionManager", { enumerable: true, get: function () { return __importDefault(SearchQueryExtensionManager_1).default; } });
 //# sourceMappingURL=index.js.map

package/lib-commonjs/tab/SearchQueryModifier.js

@@ -127,11 +127,11 @@ var SearchQueryModifier = /** @class */ (function () {
         }));
         TAB.AddTask(TAB.MakeTask(function () {
             var ddValue = _this._getDynamicDataValue(); // tslint:disable-line: no-any
-            TAB.Log.Verify(ddValue && ddValue.searchQuery === value, message + " - The actual value was \"" + JSON.stringify(ddValue) + "\".");
+            TAB.Log.Verify(ddValue && ddValue.searchQuery === value, "".concat(message, " - The actual value was \"").concat(JSON.stringify(ddValue), "\"."));
         }));
     };
     SearchQueryModifier.prototype._getPageUrl = function (params, customActions) {
-        return SPTaskLib.PageUtil.CreatePageUrl("/SitePages/" + this._pageName + ".aspx", { params: params, customActions: customActions });
+        return SPTaskLib.PageUtil.CreatePageUrl("/SitePages/".concat(this._pageName, ".aspx"), { params: params, customActions: customActions });
     };
     /**
      * Returns the object stored in the dynamic data value as a JSON. Returns undefined when there is no value or

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@microsoft/sp-search-extensibility",
-  "version": "1.15.0-beta.1",
+  "version": "1.15.0",
   "description": "SharePoint Framework developer support for customizing search",
   "license": "SEE LICENSE IN \"EULA\" FOLDER",
   "main": "lib-commonjs/index.js",
@@ -14,10 +14,10 @@
     "node": ">=12.13.0 <13.0.0 || >=14.15.0 <15.0.0 || >=16.13.0 <17.0.0"
   },
   "dependencies": {
-    "@microsoft/sp-core-library": "1.15.0-beta.1",
-    "@microsoft/sp-diagnostics": "1.15.0-beta.1",
-    "@microsoft/sp-extension-base": "1.15.0-beta.1",
-    "@microsoft/sp-loader": "1.15.0-beta.1",
-    "tslib": "~1.10.0"
+    "@microsoft/sp-core-library": "1.15.0",
+    "@microsoft/sp-diagnostics": "1.15.0",
+    "@microsoft/sp-extension-base": "1.15.0",
+    "@microsoft/sp-loader": "1.15.0",
+    "tslib": "2.3.1"
   }
 }