@microsoft/sp-search-extensibility 1.15.2 → 1.16.0-beta.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/4958ea79-6ff3-4480-8291-0932dd010869.manifest.json +6 -6
- package/dist/index-internal.d.ts +71 -4
- package/dist/{sp-search-extensibility_none_b27a85c80b513145229b.js → sp-search-extensibility_none_89bf05afbfbcbfa4beb0.js} +1 -1
- package/dist/tsdoc-metadata.json +1 -1
- package/package.json +6 -5
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
"id": "4958ea79-6ff3-4480-8291-0932dd010869",
|
|
4
4
|
"alias": "SPSearchExtensibility",
|
|
5
5
|
"componentType": "Library",
|
|
6
|
-
"version": "1.
|
|
6
|
+
"version": "1.16.0",
|
|
7
7
|
"loaderConfig": {
|
|
8
8
|
"internalModuleBaseUrls": [
|
|
9
9
|
"https://localhost:4321/dist/"
|
|
@@ -12,7 +12,7 @@
|
|
|
12
12
|
"scriptResources": {
|
|
13
13
|
"sp-search-extensibility": {
|
|
14
14
|
"type": "path",
|
|
15
|
-
"path": "sp-search-
|
|
15
|
+
"path": "sp-search-extensibility_none_89bf05afbfbcbfa4beb0.js"
|
|
16
16
|
},
|
|
17
17
|
"tslib": {
|
|
18
18
|
"type": "component",
|
|
@@ -22,22 +22,22 @@
|
|
|
22
22
|
"@microsoft/sp-loader": {
|
|
23
23
|
"type": "component",
|
|
24
24
|
"id": "1c6c9123-7aac-41f3-a376-3caea41ed83f",
|
|
25
|
-
"version": "1.
|
|
25
|
+
"version": "1.16.0"
|
|
26
26
|
},
|
|
27
27
|
"@microsoft/sp-core-library": {
|
|
28
28
|
"type": "component",
|
|
29
29
|
"id": "7263c7d0-1d6a-45ec-8d85-d4d1d234171b",
|
|
30
|
-
"version": "1.
|
|
30
|
+
"version": "1.16.0"
|
|
31
31
|
},
|
|
32
32
|
"@microsoft/sp-extension-base": {
|
|
33
33
|
"type": "component",
|
|
34
34
|
"id": "0773bd53-a69e-4293-87e6-ba80ea4d614b",
|
|
35
|
-
"version": "1.
|
|
35
|
+
"version": "1.16.0"
|
|
36
36
|
},
|
|
37
37
|
"@microsoft/sp-diagnostics": {
|
|
38
38
|
"type": "component",
|
|
39
39
|
"id": "78359e4b-07c2-43c6-8d0b-d060b4d577e8",
|
|
40
|
-
"version": "1.
|
|
40
|
+
"version": "1.16.0"
|
|
41
41
|
}
|
|
42
42
|
}
|
|
43
43
|
}
|
package/dist/index-internal.d.ts
CHANGED
|
@@ -8,18 +8,85 @@ import { BaseExtension } from '@microsoft/sp-extension-base';
|
|
|
8
8
|
import { ExtensionContext } from '@microsoft/sp-extension-base';
|
|
9
9
|
import { ServiceScope } from '@microsoft/sp-core-library';
|
|
10
10
|
|
|
11
|
-
|
|
11
|
+
/**
|
|
12
|
+
* This is the base class that third parties should extend when implementing
|
|
13
|
+
* a client-side extension that can modify the search query.
|
|
14
|
+
*
|
|
15
|
+
* In the component manifest, the "extensionType" should be set to "SearchQueryModifier".
|
|
16
|
+
*
|
|
17
|
+
* @beta
|
|
18
|
+
*/
|
|
19
|
+
export declare abstract class BaseSearchQueryModifier<TProperties> extends BaseExtension<TProperties> {
|
|
20
|
+
/**
|
|
21
|
+
* {@inheritDoc @microsoft/sp-component-base#BaseComponent.context}
|
|
22
|
+
*/
|
|
23
|
+
protected readonly context: SearchQueryModifierContext;
|
|
24
|
+
/**
|
|
25
|
+
* Timeout for the search query modifier in milliseconds.
|
|
26
|
+
* If the execution takes longer than the timeout, the original query will be used instead of the modified one.
|
|
27
|
+
*
|
|
28
|
+
* @virtual
|
|
29
|
+
*/
|
|
30
|
+
get timeout(): number;
|
|
31
|
+
/**
|
|
32
|
+
* Returns a modified search query.
|
|
33
|
+
*
|
|
34
|
+
* @param query - Query to modify.
|
|
35
|
+
* @param scenario - Search scenario.
|
|
36
|
+
* @returns - Modified query.
|
|
37
|
+
*
|
|
38
|
+
* @virtual
|
|
39
|
+
*/
|
|
40
|
+
modifySearchQuery(query: IQuery, scenario: SearchQueryScenario): Promise<IQuery>;
|
|
41
|
+
}
|
|
12
42
|
|
|
13
43
|
/* Excluded from this release type: _IPreloadedCustomAction */
|
|
14
44
|
|
|
15
|
-
|
|
45
|
+
/**
|
|
46
|
+
* Query object. Includes the query text that will be used for search and exposed through dynamic data.
|
|
47
|
+
*
|
|
48
|
+
* @remarks
|
|
49
|
+
* Additional properties can be added to the object to pass data between extensions.
|
|
50
|
+
*
|
|
51
|
+
* @beta
|
|
52
|
+
*/
|
|
53
|
+
export declare interface IQuery {
|
|
54
|
+
/**
|
|
55
|
+
* Text of the query.
|
|
56
|
+
*/
|
|
57
|
+
queryText: string;
|
|
58
|
+
/**
|
|
59
|
+
* Query text that the user provided.
|
|
60
|
+
*/
|
|
61
|
+
originalQueryText: string;
|
|
62
|
+
}
|
|
16
63
|
|
|
17
64
|
/* Excluded from this release type: _ISearchQueryExtensionManager */
|
|
18
65
|
|
|
19
66
|
/* Excluded from this release type: _SearchQueryExtensionManager */
|
|
20
67
|
|
|
21
|
-
|
|
68
|
+
/**
|
|
69
|
+
* Context for the search query modifier extensions.
|
|
70
|
+
*
|
|
71
|
+
* @beta
|
|
72
|
+
*/
|
|
73
|
+
export declare class SearchQueryModifierContext extends ExtensionContext {
|
|
74
|
+
}
|
|
22
75
|
|
|
23
|
-
|
|
76
|
+
/**
|
|
77
|
+
* Scenario for the search query modifier.
|
|
78
|
+
*
|
|
79
|
+
* @beta
|
|
80
|
+
*/
|
|
81
|
+
export declare enum SearchQueryScenario {
|
|
82
|
+
/**
|
|
83
|
+
* Search results scenario.
|
|
84
|
+
*/
|
|
85
|
+
SearchResults = 1,
|
|
86
|
+
/**
|
|
87
|
+
* Search suggestions scenario.
|
|
88
|
+
*/
|
|
89
|
+
SearchSuggestions = 2
|
|
90
|
+
}
|
|
24
91
|
|
|
25
92
|
export { }
|
|
@@ -1 +1 @@
|
|
|
1
|
-
define("4958ea79-6ff3-4480-8291-0932dd010869_1.
|
|
1
|
+
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
CHANGED
package/package.json
CHANGED
|
@@ -1,8 +1,9 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@microsoft/sp-search-extensibility",
|
|
3
|
-
"version": "1.
|
|
3
|
+
"version": "1.16.0-beta.1",
|
|
4
4
|
"description": "SharePoint Framework developer support for customizing search",
|
|
5
5
|
"license": "SEE LICENSE IN \"EULA\" FOLDER",
|
|
6
|
+
"homepage": "http://aka.ms/spfx",
|
|
6
7
|
"main": "lib-commonjs/index.js",
|
|
7
8
|
"module": "lib/index.js",
|
|
8
9
|
"typings": "dist/index-internal.d.ts",
|
|
@@ -14,10 +15,10 @@
|
|
|
14
15
|
"node": ">=12.13.0 <13.0.0 || >=14.15.0 <15.0.0 || >=16.13.0 <17.0.0"
|
|
15
16
|
},
|
|
16
17
|
"dependencies": {
|
|
17
|
-
"@microsoft/sp-core-library": "1.
|
|
18
|
-
"@microsoft/sp-diagnostics": "1.
|
|
19
|
-
"@microsoft/sp-extension-base": "1.
|
|
20
|
-
"@microsoft/sp-loader": "1.
|
|
18
|
+
"@microsoft/sp-core-library": "1.16.0-beta.1",
|
|
19
|
+
"@microsoft/sp-diagnostics": "1.16.0-beta.1",
|
|
20
|
+
"@microsoft/sp-extension-base": "1.16.0-beta.1",
|
|
21
|
+
"@microsoft/sp-loader": "1.16.0-beta.1",
|
|
21
22
|
"tslib": "2.3.1"
|
|
22
23
|
}
|
|
23
24
|
}
|