@microsoft/sp-search-extensibility 1.15.2 → 1.16.0-beta.2

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

@@ -3,7 +3,7 @@
   "id": "4958ea79-6ff3-4480-8291-0932dd010869",
   "alias": "SPSearchExtensibility",
   "componentType": "Library",
-  "version": "1.15.2",
+  "version": "1.16.0",
   "loaderConfig": {
     "internalModuleBaseUrls": [
       "https://localhost:4321/dist/"
@@ -12,7 +12,7 @@
     "scriptResources": {
       "sp-search-extensibility": {
         "type": "path",
-        "path": "sp-search-extensibility_none_b27a85c80b513145229b.js"
+        "path": "sp-search-extensibility_none_0e068c81521948f47b35.js"
       },
       "tslib": {
         "type": "component",
@@ -22,22 +22,22 @@
       "@microsoft/sp-loader": {
         "type": "component",
         "id": "1c6c9123-7aac-41f3-a376-3caea41ed83f",
-        "version": "1.15.2"
+        "version": "1.16.0"
       },
       "@microsoft/sp-core-library": {
         "type": "component",
         "id": "7263c7d0-1d6a-45ec-8d85-d4d1d234171b",
-        "version": "1.15.2"
+        "version": "1.16.0"
       },
       "@microsoft/sp-extension-base": {
         "type": "component",
         "id": "0773bd53-a69e-4293-87e6-ba80ea4d614b",
-        "version": "1.15.2"
+        "version": "1.16.0"
       },
       "@microsoft/sp-diagnostics": {
         "type": "component",
         "id": "78359e4b-07c2-43c6-8d0b-d060b4d577e8",
-        "version": "1.15.2"
+        "version": "1.16.0"
       }
     }
   }

package/dist/index-internal-beta.d.ts

@@ -14,7 +14,7 @@ import { ServiceScope } from '@microsoft/sp-core-library';
  *
  * In the component manifest, the "extensionType" should be set to "SearchQueryModifier".
  *
- * @beta
+ * @public
  */
 export declare abstract class BaseSearchQueryModifier<TProperties> extends BaseExtension<TProperties> {
     /**
@@ -48,7 +48,7 @@ export declare abstract class BaseSearchQueryModifier<TProperties> extends BaseE
  * @remarks
  * Additional properties can be added to the object to pass data between extensions.
  *
- * @beta
+ * @public
  */
 export declare interface IQuery {
     /**
@@ -68,7 +68,7 @@ export declare interface IQuery {
 /**
  * Context for the search query modifier extensions.
  *
- * @beta
+ * @public
  */
 export declare class SearchQueryModifierContext extends ExtensionContext {
 }
@@ -76,7 +76,7 @@ export declare class SearchQueryModifierContext extends ExtensionContext {
 /**
  * Scenario for the search query modifier.
  *
- * @beta
+ * @public
  */
 export declare enum SearchQueryScenario {
     /**

package/dist/index-internal-public.d.ts

@@ -8,18 +8,85 @@ import { BaseExtension } from '@microsoft/sp-extension-base';
 import { ExtensionContext } from '@microsoft/sp-extension-base';
 import { ServiceScope } from '@microsoft/sp-core-library';
 
-/* Excluded from this release type: BaseSearchQueryModifier */
+/**
+ * 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".
+ *
+ * @public
+ */
+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: _IPreloadedCustomAction */
 
-/* Excluded from this release type: IQuery */
+/**
+ * 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.
+ *
+ * @public
+ */
+export declare interface IQuery {
+    /**
+     * Text of the query.
+     */
+    queryText: string;
+    /**
+     * Query text that the user provided.
+     */
+    originalQueryText: string;
+}
 
 /* Excluded from this release type: _ISearchQueryExtensionManager */
 
 /* Excluded from this release type: _SearchQueryExtensionManager */
 
-/* Excluded from this release type: SearchQueryModifierContext */
+/**
+ * Context for the search query modifier extensions.
+ *
+ * @public
+ */
+export declare class SearchQueryModifierContext extends ExtensionContext {
+}
 
-/* Excluded from this release type: SearchQueryScenario */
+/**
+ * Scenario for the search query modifier.
+ *
+ * @public
+ */
+export declare enum SearchQueryScenario {
+    /**
+     * Search results scenario.
+     */
+    SearchResults = 1,
+    /**
+     * Search suggestions scenario.
+     */
+    SearchSuggestions = 2
+}
 
 export { }

package/dist/index-internal.d.ts

@@ -8,18 +8,85 @@ import { BaseExtension } from '@microsoft/sp-extension-base';
 import { ExtensionContext } from '@microsoft/sp-extension-base';
 import { ServiceScope } from '@microsoft/sp-core-library';
 
-/* Excluded from this release type: BaseSearchQueryModifier */
+/**
+ * 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".
+ *
+ * @public
+ */
+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: _IPreloadedCustomAction */
 
-/* Excluded from this release type: IQuery */
+/**
+ * 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.
+ *
+ * @public
+ */
+export declare interface IQuery {
+    /**
+     * Text of the query.
+     */
+    queryText: string;
+    /**
+     * Query text that the user provided.
+     */
+    originalQueryText: string;
+}
 
 /* Excluded from this release type: _ISearchQueryExtensionManager */
 
 /* Excluded from this release type: _SearchQueryExtensionManager */
 
-/* Excluded from this release type: SearchQueryModifierContext */
+/**
+ * Context for the search query modifier extensions.
+ *
+ * @public
+ */
+export declare class SearchQueryModifierContext extends ExtensionContext {
+}
 
-/* Excluded from this release type: SearchQueryScenario */
+/**
+ * Scenario for the search query modifier.
+ *
+ * @public
+ */
+export declare enum SearchQueryScenario {
+    /**
+     * Search results scenario.
+     */
+    SearchResults = 1,
+    /**
+     * Search suggestions scenario.
+     */
+    SearchSuggestions = 2
+}
 
 export { }

package/dist/{sp-search-extensibility_none_b27a85c80b513145229b.js → sp-search-extensibility_none_0e068c81521948f47b35.js}

@@ -1 +1 @@
-define("4958ea79-6ff3-4480-8291-0932dd010869_1.15.2",["tslib","@microsoft/sp-loader","@microsoft/sp-core-library","@microsoft/sp-extension-base","@microsoft/sp-diagnostics"],function(n,a,i,r,o){return function(e){var t={};function n(a){if(t[a])return t[a].exports;var i=t[a]={i:a,l:!1,exports:{}};return e[a].call(i.exports,i,i.exports,n),i.l=!0,i.exports}return n.m=e,n.c=t,n.d=function(e,t,a){n.o(e,t)||Object.defineProperty(e,t,{enumerable:!0,get:a})},n.r=function(e){"undefined"!=typeof Symbol&&Symbol.toStringTag&&Object.defineProperty(e,Symbol.toStringTag,{value:"Module"}),Object.defineProperty(e,"__esModule",{value:!0})},n.t=function(e,t){if(1&t&&(e=n(e)),8&t)return e;if(4&t&&"object"==typeof e&&e&&e.__esModule)return e;var a=Object.create(null);if(n.r(a),Object.defineProperty(a,"default",{enumerable:!0,value:e}),2&t&&"string"!=typeof e)for(var i in e)n.d(a,i,function(t){return e[t]}.bind(null,i));return a},n.n=function(e){var t=e&&e.__esModule?function(){return e.default}:function(){return e};return n.d(t,"a",t),t},n.o=function(e,t){return Object.prototype.hasOwnProperty.call(e,t)},n.p="",n(n.s="mwqp")}({"17wl":function(e,t){e.exports=n},I6O9:function(e,t){e.exports=a},UWqr:function(e,t){e.exports=i},ZFc5:function(e,t){e.exports=r},mwqp:function(e,t,n){"use strict";n.r(t),n.d(t,"BaseSearchQueryModifier",function(){return s}),n.d(t,"SearchQueryScenario",function(){return a}),n.d(t,"SearchQueryModifierContext",function(){return d}),n.d(t,"_SearchQueryExtensionManager",function(){return p});var a,i=n("17wl"),r=n("ZFc5");!function(e){e[e.SearchResults=1]="SearchResults",e[e.SearchSuggestions=2]="SearchSuggestions"}(a||(a={}));var o=function(e){function t(){return null!==e&&e.apply(this,arguments)||this}return Object(i.__extends)(t,e),Object.defineProperty(t.prototype,"timeout",{get:function(){return 1e4},enumerable:!1,configurable:!0}),t.prototype.modifySearchQuery=function(e,t){return Promise.resolve(e)},t}(r.BaseExtension),s=o,c=function(e){function t(){return null!==e&&e.apply(this,arguments)||this}return Object(i.__extends)(t,e),t}(r.ExtensionContext),d=c,l=n("UWqr"),u=n("ut3N"),f=n("I6O9"),p=function(){function e(e){this._extensionManager=new r._ExtensionManager(e,s),this._extensions=[]}return e.prototype.initializeExtensions=function(e){var t=this,n=new u._QosMonitor("SearchQueryExtensionManager.initializeExtensions"),a=this._getCustomActions(e).filter(function(e){return"ClientSideExtension.SearchQueryModifier"===e.location&&!!f.SPComponentLoader.tryGetManifestById(e.clientSideComponentId)}).sort(function(e,t){return(e.sequence||Number.MAX_VALUE)-(t.sequence||Number.MAX_VALUE)}).map(function(e){return t._extensionManager.createExtension(e.clientSideComponentId.toString(),e.clientSideComponentProperties,function(e){return new d(e)})});return Promise.all(a).then(function(e){t._extensions=e;var a=t._extensions.length;return n.writeSuccess({numberOfExtensions:a}),a}).catch(function(e){throw n.writeUnexpectedFailure(void 0,e,{numberOfExtensions:0}),e})},e.prototype.getSearchQuery=function(e){var t=this,n=Promise.resolve({queryText:e,originalQueryText:e});return this._extensions.forEach(function(a){n=n.then(function(n){return t._processQuery(a,n,e)})}),n.then(function(e){return e.queryText})},e.prototype._processQuery=function(e,t,n){var r=new u._QosMonitor("SearchQueryExtensionManager.processQuery"),o={componentId:e.componentId,alias:e.manifest.alias},s=new Promise(function(n){setTimeout(function(){r.writeExpectedFailure("Timeout",void 0,o),n(t)},e.timeout)});return Promise.race([s,e.modifySearchQuery(Object(i.__assign)(Object(i.__assign)({},t),{originalQueryText:n}),a.SearchResults)]).then(function(e){return r.writeSuccess(o),e}).catch(function(e){throw r.writeUnexpectedFailure(void 0,e,o),e})},e.prototype._getCustomActions=function(e){return this._getDebugCustomActions().concat(e)},e.prototype._getDebugCustomActions=function(){var e=[],t=new URL(window.location.href).searchParams.get("customActions");if(t){var n=decodeURIComponent(t),a=JSON.parse(n);if(a)for(var i=0,r=Object.keys(a);i<r.length;i++){var o=r[i],s=l.Guid.tryParse(o),c=a[o].location,d=a[o].sequence;e.push({clientSideComponentId:s.toString(),location:c,sequence:d})}}return e},e}()},ut3N:function(e,t){e.exports=o}})});
+define("4958ea79-6ff3-4480-8291-0932dd010869_1.16.0",["tslib","@microsoft/sp-loader","@microsoft/sp-core-library","@microsoft/sp-extension-base","@microsoft/sp-diagnostics"],function(n,a,i,r,o){return function(e){var t={};function n(a){if(t[a])return t[a].exports;var i=t[a]={i:a,l:!1,exports:{}};return e[a].call(i.exports,i,i.exports,n),i.l=!0,i.exports}return n.m=e,n.c=t,n.d=function(e,t,a){n.o(e,t)||Object.defineProperty(e,t,{enumerable:!0,get:a})},n.r=function(e){"undefined"!=typeof Symbol&&Symbol.toStringTag&&Object.defineProperty(e,Symbol.toStringTag,{value:"Module"}),Object.defineProperty(e,"__esModule",{value:!0})},n.t=function(e,t){if(1&t&&(e=n(e)),8&t)return e;if(4&t&&"object"==typeof e&&e&&e.__esModule)return e;var a=Object.create(null);if(n.r(a),Object.defineProperty(a,"default",{enumerable:!0,value:e}),2&t&&"string"!=typeof e)for(var i in e)n.d(a,i,function(t){return e[t]}.bind(null,i));return a},n.n=function(e){var t=e&&e.__esModule?function(){return e.default}:function(){return e};return n.d(t,"a",t),t},n.o=function(e,t){return Object.prototype.hasOwnProperty.call(e,t)},n.p="",n(n.s="mwqp")}({"17wl":function(e,t){e.exports=n},I6O9:function(e,t){e.exports=a},UWqr:function(e,t){e.exports=i},ZFc5:function(e,t){e.exports=r},mwqp:function(e,t,n){"use strict";n.r(t),n.d(t,"BaseSearchQueryModifier",function(){return s}),n.d(t,"SearchQueryScenario",function(){return a}),n.d(t,"SearchQueryModifierContext",function(){return d}),n.d(t,"_SearchQueryExtensionManager",function(){return p});var a,i=n("17wl"),r=n("ZFc5");!function(e){e[e.SearchResults=1]="SearchResults",e[e.SearchSuggestions=2]="SearchSuggestions"}(a||(a={}));var o=function(e){function t(){return null!==e&&e.apply(this,arguments)||this}return Object(i.__extends)(t,e),Object.defineProperty(t.prototype,"timeout",{get:function(){return 1e4},enumerable:!1,configurable:!0}),t.prototype.modifySearchQuery=function(e,t){return Promise.resolve(e)},t}(r.BaseExtension),s=o,c=function(e){function t(){return null!==e&&e.apply(this,arguments)||this}return Object(i.__extends)(t,e),t}(r.ExtensionContext),d=c,l=n("UWqr"),u=n("ut3N"),f=n("I6O9"),p=function(){function e(e){this._extensionManager=new r._ExtensionManager(e,s),this._extensions=[]}return e.prototype.initializeExtensions=function(e){var t=this,n=new u._QosMonitor("SearchQueryExtensionManager.initializeExtensions"),a=this._getCustomActions(e).filter(function(e){return"ClientSideExtension.SearchQueryModifier"===e.location&&!!f.SPComponentLoader.tryGetManifestById(e.clientSideComponentId)}).sort(function(e,t){return(e.sequence||Number.MAX_VALUE)-(t.sequence||Number.MAX_VALUE)}).map(function(e){return t._extensionManager.createExtension(e.clientSideComponentId.toString(),e.clientSideComponentProperties,function(e){return new d(e)})});return Promise.all(a).then(function(e){t._extensions=e;var a=t._extensions.length;return n.writeSuccess({numberOfExtensions:a}),a}).catch(function(e){throw n.writeUnexpectedFailure(void 0,e,{numberOfExtensions:0}),e})},e.prototype.getSearchQuery=function(e){var t=this,n=Promise.resolve({queryText:e,originalQueryText:e});return this._extensions.forEach(function(a){n=n.then(function(n){return t._processQuery(a,n,e)})}),n.then(function(e){return e.queryText})},e.prototype._processQuery=function(e,t,n){var r=new u._QosMonitor("SearchQueryExtensionManager.processQuery"),o={componentId:e.componentId,alias:e.manifest.alias},s=new Promise(function(n){setTimeout(function(){r.writeExpectedFailure("Timeout",void 0,o),n(t)},e.timeout)});return Promise.race([s,e.modifySearchQuery(Object(i.__assign)(Object(i.__assign)({},t),{originalQueryText:n}),a.SearchResults)]).then(function(e){return r.writeSuccess(o),e}).catch(function(e){throw r.writeUnexpectedFailure(void 0,e,o),e})},e.prototype._getCustomActions=function(e){return this._getDebugCustomActions().concat(e)},e.prototype._getDebugCustomActions=function(){var e=[],t=new URL(window.location.href).searchParams.get("customActions");if(t){var n=decodeURIComponent(t),a=JSON.parse(n);if(a)for(var i=0,r=Object.keys(a);i<r.length;i++){var o=r[i],s=l.Guid.tryParse(o),c=a[o].location,d=a[o].sequence;e.push({clientSideComponentId:s.toString(),location:c,sequence:d})}}return e},e}()},ut3N:function(e,t){e.exports=o}})});

package/dist/tsdoc-metadata.json

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

package/lib-commonjs/BaseSearchQueryModifier.js

@@ -6,7 +6,7 @@ var sp_extension_base_1 = require("@microsoft/sp-extension-base");
 /**
  * Scenario for the search query modifier.
  *
- * @beta
+ * @public
  */
 var SearchQueryScenario;
 (function (SearchQueryScenario) {
@@ -25,7 +25,7 @@ var SearchQueryScenario;
  *
  * In the component manifest, the "extensionType" should be set to "SearchQueryModifier".
  *
- * @beta
+ * @public
  */
 var BaseSearchQueryModifier = /** @class */ (function (_super) {
     tslib_1.__extends(BaseSearchQueryModifier, _super);

package/lib-commonjs/SearchQueryModifierContext.js

@@ -5,7 +5,7 @@ var sp_extension_base_1 = require("@microsoft/sp-extension-base");
 /**
  * Context for the search query modifier extensions.
  *
- * @beta
+ * @public
  */
 var SearchQueryModifierContext = /** @class */ (function (_super) {
     tslib_1.__extends(SearchQueryModifierContext, _super);

package/package.json

@@ -1,8 +1,9 @@
 {
   "name": "@microsoft/sp-search-extensibility",
-  "version": "1.15.2",
+  "version": "1.16.0-beta.2",
   "description": "SharePoint Framework developer support for customizing search",
-  "license": "SEE LICENSE IN \"EULA\" FOLDER",
+  "license": "https://aka.ms/spfx/license",
+  "homepage": "http://aka.ms/spfx",
   "main": "lib-commonjs/index.js",
   "module": "lib/index.js",
   "typings": "dist/index-internal.d.ts",
@@ -14,10 +15,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.2",
-    "@microsoft/sp-diagnostics": "1.15.2",
-    "@microsoft/sp-extension-base": "1.15.2",
-    "@microsoft/sp-loader": "1.15.2",
+    "@microsoft/sp-core-library": "1.16.0-beta.2",
+    "@microsoft/sp-diagnostics": "1.16.0-beta.2",
+    "@microsoft/sp-extension-base": "1.16.0-beta.2",
+    "@microsoft/sp-loader": "1.16.0-beta.2",
     "tslib": "2.3.1"
   }
 }