@gooddata/sdk-ui-semantic-search 10.9.0-alpha.25 → 10.9.0-alpha.27

Sign up to get free protection for your applications and to get access to all the features.
@@ -2,10 +2,10 @@ import * as React from "react";
2
2
  import { GenAISemanticSearchType, ISemanticSearchResultItem } from "@gooddata/sdk-model";
3
3
  import { IAnalyticalBackend } from "@gooddata/sdk-backend-spi";
4
4
  /**
5
- * Core semantic search component props.
6
- * @alpha
5
+ * Semantic search component props.
6
+ * @beta
7
7
  */
8
- export type SemanticSearchCoreProps = {
8
+ export type SemanticSearchProps = {
9
9
  /**
10
10
  * An analytical backend to use for the search. Can be omitted and taken from context.
11
11
  */
@@ -14,6 +14,10 @@ export type SemanticSearchCoreProps = {
14
14
  * A workspace to search in. Can be omitted and taken from context.
15
15
  */
16
16
  workspace?: string;
17
+ /**
18
+ * A locale to use for the search. Can be omitted and taken from context.
19
+ */
20
+ locale?: string;
17
21
  /**
18
22
  * A function called when the user selects an item from the search results.
19
23
  */
@@ -43,16 +47,9 @@ export type SemanticSearchCoreProps = {
43
47
  */
44
48
  placeholder?: string;
45
49
  };
46
- /**
47
- * Semantic search component props.
48
- * @alpha
49
- */
50
- export type SemanticSearchProps = SemanticSearchCoreProps & {
51
- locale?: string;
52
- };
53
50
  /**
54
51
  * Semantic search filed with dropdown for selecting items.
55
- * @alpha
52
+ * @beta
56
53
  */
57
54
  export declare const SemanticSearch: React.FC<SemanticSearchProps>;
58
55
  //# sourceMappingURL=SemanticSearch.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"SemanticSearch.d.ts","sourceRoot":"","sources":["../src/SemanticSearch.tsx"],"names":[],"mappings":"AAEA,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AAE/B,OAAO,EAAE,uBAAuB,EAAE,yBAAyB,EAAE,MAAM,qBAAqB,CAAC;AAIzF,OAAO,EAAE,kBAAkB,EAAE,MAAM,2BAA2B,CAAC;AAK/D;;;GAGG;AACH,MAAM,MAAM,uBAAuB,GAAG;IAClC;;OAEG;IACH,OAAO,CAAC,EAAE,kBAAkB,CAAC;IAC7B;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB;;OAEG;IACH,QAAQ,EAAE,CAAC,IAAI,EAAE,yBAAyB,KAAK,IAAI,CAAC;IACpD;;OAEG;IACH,OAAO,CAAC,EAAE,CAAC,YAAY,EAAE,MAAM,KAAK,IAAI,CAAC;IACzC;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB;;OAEG;IACH,WAAW,CAAC,EAAE,uBAAuB,EAAE,CAAC;IACxC;;OAEG;IACH,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IACf;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;CACxB,CAAC;AA2GF;;;GAGG;AACH,MAAM,MAAM,mBAAmB,GAAG,uBAAuB,GAAG;IACxD,MAAM,CAAC,EAAE,MAAM,CAAC;CACnB,CAAC;AAEF;;;GAGG;AACH,eAAO,MAAM,cAAc,EAAE,KAAK,CAAC,EAAE,CAAC,mBAAmB,CAMxD,CAAC"}
1
+ {"version":3,"file":"SemanticSearch.d.ts","sourceRoot":"","sources":["../src/SemanticSearch.tsx"],"names":[],"mappings":"AAEA,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AAE/B,OAAO,EAAE,uBAAuB,EAAE,yBAAyB,EAAE,MAAM,qBAAqB,CAAC;AAIzF,OAAO,EAAE,kBAAkB,EAAE,MAAM,2BAA2B,CAAC;AAK/D;;;GAGG;AACH,MAAM,MAAM,mBAAmB,GAAG;IAC9B;;OAEG;IACH,OAAO,CAAC,EAAE,kBAAkB,CAAC;IAC7B;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB;;OAEG;IACH,QAAQ,EAAE,CAAC,IAAI,EAAE,yBAAyB,KAAK,IAAI,CAAC;IACpD;;OAEG;IACH,OAAO,CAAC,EAAE,CAAC,YAAY,EAAE,MAAM,KAAK,IAAI,CAAC;IACzC;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB;;OAEG;IACH,WAAW,CAAC,EAAE,uBAAuB,EAAE,CAAC;IACxC;;OAEG;IACH,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IACf;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;CACxB,CAAC;AA2GF;;;GAGG;AACH,eAAO,MAAM,cAAc,EAAE,KAAK,CAAC,EAAE,CAAC,mBAAmB,CAMxD,CAAC"}
@@ -13,7 +13,7 @@ import { useElementWidth } from "./hooks/useElementWidth.js";
13
13
  const DEBOUNCE = 300;
14
14
  /**
15
15
  * Semantic search component core.
16
- * @alpha
16
+ * @beta
17
17
  */
18
18
  const SemanticSearchCore = ({ backend, workspace, onSelect, onError, objectTypes, deepSearch = false, limit = 10, className, placeholder, }) => {
19
19
  // Input value handling
@@ -64,7 +64,7 @@ const SemanticSearchCore = ({ backend, workspace, onSelect, onError, objectTypes
64
64
  };
65
65
  /**
66
66
  * Semantic search filed with dropdown for selecting items.
67
- * @alpha
67
+ * @beta
68
68
  */
69
69
  export const SemanticSearch = ({ locale, ...coreProps }) => {
70
70
  return (React.createElement(IntlWrapper, { locale: locale },
@@ -1 +1 @@
1
- {"version":3,"file":"SemanticSearch.js","sourceRoot":"","sources":["../src/SemanticSearch.tsx"],"names":[],"mappings":"AAAA,gCAAgC;AAEhC,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AAC/B,OAAO,EAAE,iBAAiB,EAAE,KAAK,EAAE,QAAQ,EAAE,MAAM,sBAAsB,CAAC;AAE1E,OAAO,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AAC/C,OAAO,EAAE,yBAAyB,EAAE,MAAM,gCAAgC,CAAC;AAC3E,OAAO,EAAE,iBAAiB,EAAE,MAAM,kBAAkB,CAAC;AAErD,OAAO,UAAU,MAAM,YAAY,CAAC;AAEpC,OAAO,EAAE,eAAe,EAAE,MAAM,4BAA4B,CAAC;AA6C7D;;;GAGG;AACH,MAAM,QAAQ,GAAG,GAAG,CAAC;AAErB;;;GAGG;AACH,MAAM,kBAAkB,GAAsC,CAAC,EAC3D,OAAO,EACP,SAAS,EACT,QAAQ,EACR,OAAO,EACP,WAAW,EACX,UAAU,GAAG,KAAK,EAClB,KAAK,GAAG,EAAE,EACV,SAAS,EACT,WAAW,GACd,EAAE,EAAE;IACD,uBAAuB;IACvB,MAAM,CAAC,KAAK,EAAE,QAAQ,EAAE,UAAU,EAAE,YAAY,CAAC,GAAG,iBAAiB,CAAC,EAAE,EAAE,QAAQ,CAAC,CAAC;IACpF,MAAM,QAAQ,GAAG,KAAK,CAAC,MAAM,CAAQ,IAAI,CAAC,CAAC;IAE3C,iBAAiB;IACjB,MAAM,EAAE,YAAY,EAAE,aAAa,EAAE,WAAW,EAAE,GAAG,iBAAiB,CAAC;QACnE,OAAO;QACP,SAAS;QACT,UAAU;QACV,WAAW;QACX,UAAU;QACV,KAAK;KACR,CAAC,CAAC;IAEH,iCAAiC;IACjC,MAAM,SAAS,GAA0C,KAAK,CAAC,OAAO,CAClE,GAAG,EAAE,CAAC,aAAa,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,EAAE,IAAI,EAAE,CAAC,CAAC,EAC7C,CAAC,aAAa,CAAC,CAClB,CAAC;IAEF,6CAA6C;IAC7C,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,GAAG,eAAe,EAAE,CAAC;IAEvC,gBAAgB;IAChB,KAAK,CAAC,SAAS,CAAC,GAAG,EAAE;QACjB,IAAI,OAAO,IAAI,YAAY,KAAK,OAAO,EAAE,CAAC;YACtC,OAAO,CAAC,WAAW,CAAC,CAAC;QACzB,CAAC;IACL,CAAC,EAAE,CAAC,OAAO,EAAE,WAAW,EAAE,YAAY,CAAC,CAAC,CAAC;IAEzC,OAAO,CACH,oBAAC,QAAQ,IACL,SAAS,EAAE,UAAU,CAAC,oBAAoB,EAAE,SAAS,CAAC,EACtD,qBAAqB,EAAE;YACnB,YAAY;YACZ,mCAAmC;YACnC,4BAA4B;SAC/B,EACD,UAAU,EAAE,CAAC,EAAE,QAAQ,EAAE,aAAa,EAAE,EAAE,EAAE;YACxC,IAAI,CAAC,aAAa,CAAC,MAAM,IAAI,YAAY,KAAK,SAAS,EAAE,CAAC;gBACtD,OAAO,IAAI,CAAC;YAChB,CAAC;YAED,OAAO,CACH,oBAAC,yBAAyB,IACtB,KAAK,EAAE,KAAK,EACZ,QAAQ,EAAE,QAAQ,EAClB,aAAa,EAAE,SAAS,EACxB,aAAa,EAAE,YAAY,KAAK,SAAS,EACzC,QAAQ,EAAE,CAAC,IAAI,EAAE,EAAE;oBACf,2BAA2B;oBAC3B,MAAM,KAAK,GAAG,QAAQ,CAAC,OAAO,EAAE,YAAY,EAAE,YAAY,CAAC;oBAC3D,IAAI,KAAK,EAAE,CAAC;wBACR,KAAK,CAAC,IAAI,EAAE,CAAC;oBACjB,CAAC;oBACD,YAAY,CAAC,EAAE,CAAC,CAAC;oBACjB,aAAa,EAAE,CAAC;oBAEhB,2BAA2B;oBAC3B,QAAQ,CAAC,IAAI,CAAC,CAAC;gBACnB,CAAC,GACH,CACL,CAAC;QACN,CAAC,EACD,YAAY,EAAE,CAAC,EAAE,YAAY,EAAE,EAAE,EAAE;YAC/B,OAAO,CACH,6BAAK,GAAG,EAAE,GAAG;gBACT,oBAAC,KAAK,IACF,SAAS,EAAC,2BAA2B,EACrC,GAAG,EAAE,QAAQ,EACb,WAAW,EAAE,WAAW,EACxB,QAAQ,QACR,UAAU,QACV,KAAK,EAAE,KAAK,EACZ,QAAQ,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,EACpC,OAAO,EAAE,YAAY,GACvB,CACA,CACT,CAAC;QACN,CAAC,GACH,CACL,CAAC;AACN,CAAC,CAAC;AAUF;;;GAGG;AACH,MAAM,CAAC,MAAM,cAAc,GAAkC,CAAC,EAAE,MAAM,EAAE,GAAG,SAAS,EAAE,EAAE,EAAE;IACtF,OAAO,CACH,oBAAC,WAAW,IAAC,MAAM,EAAE,MAAM;QACvB,oBAAC,kBAAkB,OAAK,SAAS,GAAI,CAC3B,CACjB,CAAC;AACN,CAAC,CAAC"}
1
+ {"version":3,"file":"SemanticSearch.js","sourceRoot":"","sources":["../src/SemanticSearch.tsx"],"names":[],"mappings":"AAAA,gCAAgC;AAEhC,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AAC/B,OAAO,EAAE,iBAAiB,EAAE,KAAK,EAAE,QAAQ,EAAE,MAAM,sBAAsB,CAAC;AAE1E,OAAO,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AAC/C,OAAO,EAAE,yBAAyB,EAAE,MAAM,gCAAgC,CAAC;AAC3E,OAAO,EAAE,iBAAiB,EAAE,MAAM,kBAAkB,CAAC;AAErD,OAAO,UAAU,MAAM,YAAY,CAAC;AAEpC,OAAO,EAAE,eAAe,EAAE,MAAM,4BAA4B,CAAC;AAiD7D;;;GAGG;AACH,MAAM,QAAQ,GAAG,GAAG,CAAC;AAErB;;;GAGG;AACH,MAAM,kBAAkB,GAAkD,CAAC,EACvE,OAAO,EACP,SAAS,EACT,QAAQ,EACR,OAAO,EACP,WAAW,EACX,UAAU,GAAG,KAAK,EAClB,KAAK,GAAG,EAAE,EACV,SAAS,EACT,WAAW,GACd,EAAE,EAAE;IACD,uBAAuB;IACvB,MAAM,CAAC,KAAK,EAAE,QAAQ,EAAE,UAAU,EAAE,YAAY,CAAC,GAAG,iBAAiB,CAAC,EAAE,EAAE,QAAQ,CAAC,CAAC;IACpF,MAAM,QAAQ,GAAG,KAAK,CAAC,MAAM,CAAQ,IAAI,CAAC,CAAC;IAE3C,iBAAiB;IACjB,MAAM,EAAE,YAAY,EAAE,aAAa,EAAE,WAAW,EAAE,GAAG,iBAAiB,CAAC;QACnE,OAAO;QACP,SAAS;QACT,UAAU;QACV,WAAW;QACX,UAAU;QACV,KAAK;KACR,CAAC,CAAC;IAEH,iCAAiC;IACjC,MAAM,SAAS,GAA0C,KAAK,CAAC,OAAO,CAClE,GAAG,EAAE,CAAC,aAAa,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,EAAE,IAAI,EAAE,CAAC,CAAC,EAC7C,CAAC,aAAa,CAAC,CAClB,CAAC;IAEF,6CAA6C;IAC7C,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,GAAG,eAAe,EAAE,CAAC;IAEvC,gBAAgB;IAChB,KAAK,CAAC,SAAS,CAAC,GAAG,EAAE;QACjB,IAAI,OAAO,IAAI,YAAY,KAAK,OAAO,EAAE,CAAC;YACtC,OAAO,CAAC,WAAW,CAAC,CAAC;QACzB,CAAC;IACL,CAAC,EAAE,CAAC,OAAO,EAAE,WAAW,EAAE,YAAY,CAAC,CAAC,CAAC;IAEzC,OAAO,CACH,oBAAC,QAAQ,IACL,SAAS,EAAE,UAAU,CAAC,oBAAoB,EAAE,SAAS,CAAC,EACtD,qBAAqB,EAAE;YACnB,YAAY;YACZ,mCAAmC;YACnC,4BAA4B;SAC/B,EACD,UAAU,EAAE,CAAC,EAAE,QAAQ,EAAE,aAAa,EAAE,EAAE,EAAE;YACxC,IAAI,CAAC,aAAa,CAAC,MAAM,IAAI,YAAY,KAAK,SAAS,EAAE,CAAC;gBACtD,OAAO,IAAI,CAAC;YAChB,CAAC;YAED,OAAO,CACH,oBAAC,yBAAyB,IACtB,KAAK,EAAE,KAAK,EACZ,QAAQ,EAAE,QAAQ,EAClB,aAAa,EAAE,SAAS,EACxB,aAAa,EAAE,YAAY,KAAK,SAAS,EACzC,QAAQ,EAAE,CAAC,IAAI,EAAE,EAAE;oBACf,2BAA2B;oBAC3B,MAAM,KAAK,GAAG,QAAQ,CAAC,OAAO,EAAE,YAAY,EAAE,YAAY,CAAC;oBAC3D,IAAI,KAAK,EAAE,CAAC;wBACR,KAAK,CAAC,IAAI,EAAE,CAAC;oBACjB,CAAC;oBACD,YAAY,CAAC,EAAE,CAAC,CAAC;oBACjB,aAAa,EAAE,CAAC;oBAEhB,2BAA2B;oBAC3B,QAAQ,CAAC,IAAI,CAAC,CAAC;gBACnB,CAAC,GACH,CACL,CAAC;QACN,CAAC,EACD,YAAY,EAAE,CAAC,EAAE,YAAY,EAAE,EAAE,EAAE;YAC/B,OAAO,CACH,6BAAK,GAAG,EAAE,GAAG;gBACT,oBAAC,KAAK,IACF,SAAS,EAAC,2BAA2B,EACrC,GAAG,EAAE,QAAQ,EACb,WAAW,EAAE,WAAW,EACxB,QAAQ,QACR,UAAU,QACV,KAAK,EAAE,KAAK,EACZ,QAAQ,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,EACpC,OAAO,EAAE,YAAY,GACvB,CACA,CACT,CAAC;QACN,CAAC,GACH,CACL,CAAC;AACN,CAAC,CAAC;AAEF;;;GAGG;AACH,MAAM,CAAC,MAAM,cAAc,GAAkC,CAAC,EAAE,MAAM,EAAE,GAAG,SAAS,EAAE,EAAE,EAAE;IACtF,OAAO,CACH,oBAAC,WAAW,IAAC,MAAM,EAAE,MAAM;QACvB,oBAAC,kBAAkB,OAAK,SAAS,GAAI,CAC3B,CACjB,CAAC;AACN,CAAC,CAAC"}
@@ -2,7 +2,7 @@ import { ISemanticSearchResultItem, GenAISemanticSearchType, ISemanticSearchRela
2
2
  import { IAnalyticalBackend } from "@gooddata/sdk-backend-spi";
3
3
  /**
4
4
  * The result of the semantic search hook.
5
- * @alpha
5
+ * @beta
6
6
  */
7
7
  export type SemanticSearchInputResult = {
8
8
  /**
@@ -25,7 +25,7 @@ export type SemanticSearchInputResult = {
25
25
  };
26
26
  /**
27
27
  * Input parameters for the semantic search hook.
28
- * @alpha
28
+ * @beta
29
29
  */
30
30
  export type SemanticSearchHookInput = {
31
31
  /**
@@ -60,7 +60,7 @@ export type SemanticSearchHookInput = {
60
60
  * Hook to perform semantic search.
61
61
  * Makes the request to server and returns the search results.
62
62
  * The request is cancellable and auto-updates when the search term changes.
63
- * @alpha
63
+ * @beta
64
64
  */
65
65
  export declare const useSemanticSearch: ({ searchTerm, objectTypes, deepSearch, limit, backend, workspace, }: SemanticSearchHookInput) => SemanticSearchInputResult;
66
66
  //# sourceMappingURL=useSemanticSearch.d.ts.map
@@ -15,7 +15,7 @@ const DEFAULT_OBJECT_TYPES = [];
15
15
  * Hook to perform semantic search.
16
16
  * Makes the request to server and returns the search results.
17
17
  * The request is cancellable and auto-updates when the search term changes.
18
- * @alpha
18
+ * @beta
19
19
  */
20
20
  export const useSemanticSearch = ({ searchTerm, objectTypes = DEFAULT_OBJECT_TYPES, deepSearch, limit, backend, workspace, }) => {
21
21
  const [state, setState] = useState(DEFAULT_STATE);
package/esm/index.d.ts CHANGED
@@ -1,8 +1,8 @@
1
1
  /**
2
2
  * This package provides React hooks and components for semantic search.
3
3
  * @packageDocumentation
4
- * @alpha
4
+ * @beta
5
5
  */
6
- export * from "./hooks/index.js";
6
+ export * from "./hooks/useSemanticSearch.js";
7
7
  export * from "./SemanticSearch.js";
8
8
  //# sourceMappingURL=index.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAEA;;;;GAIG;AAEH,cAAc,kBAAkB,CAAC;AACjC,cAAc,qBAAqB,CAAC"}
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAEA;;;;GAIG;AAEH,cAAc,8BAA8B,CAAC;AAC7C,cAAc,qBAAqB,CAAC"}
package/esm/index.js CHANGED
@@ -2,8 +2,8 @@
2
2
  /**
3
3
  * This package provides React hooks and components for semantic search.
4
4
  * @packageDocumentation
5
- * @alpha
5
+ * @beta
6
6
  */
7
- export * from "./hooks/index.js";
7
+ export * from "./hooks/useSemanticSearch.js";
8
8
  export * from "./SemanticSearch.js";
9
9
  //# sourceMappingURL=index.js.map
package/esm/index.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAEhC;;;;GAIG;AAEH,cAAc,kBAAkB,CAAC;AACjC,cAAc,qBAAqB,CAAC"}
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAEhC;;;;GAIG;AAEH,cAAc,8BAA8B,CAAC;AAC7C,cAAc,qBAAqB,CAAC"}
@@ -1,7 +1,7 @@
1
1
  /**
2
2
  * This package provides React hooks and components for semantic search.
3
3
  * @packageDocumentation
4
- * @alpha
4
+ * @beta
5
5
  */
6
6
 
7
7
  import { GenAISemanticSearchType } from '@gooddata/sdk-model';
@@ -12,56 +12,13 @@ import * as React_2 from 'react';
12
12
 
13
13
  /**
14
14
  * Semantic search filed with dropdown for selecting items.
15
- * @alpha
15
+ * @beta
16
16
  */
17
17
  export declare const SemanticSearch: React_2.FC<SemanticSearchProps>;
18
18
 
19
- /**
20
- * Core semantic search component props.
21
- * @alpha
22
- */
23
- export declare type SemanticSearchCoreProps = {
24
- /**
25
- * An analytical backend to use for the search. Can be omitted and taken from context.
26
- */
27
- backend?: IAnalyticalBackend;
28
- /**
29
- * A workspace to search in. Can be omitted and taken from context.
30
- */
31
- workspace?: string;
32
- /**
33
- * A function called when the user selects an item from the search results.
34
- */
35
- onSelect: (item: ISemanticSearchResultItem) => void;
36
- /**
37
- * A function called when an error occurs during the search.
38
- */
39
- onError?: (errorMessage: string) => void;
40
- /**
41
- * Additional CSS class for the component.
42
- */
43
- className?: string;
44
- /**
45
- * A list of object types to search for.
46
- */
47
- objectTypes?: GenAISemanticSearchType[];
48
- /**
49
- * A flag to enable deep search, i.e. search dashboard by their contents.
50
- */
51
- deepSearch?: boolean;
52
- /**
53
- * A limit of search results to return.
54
- */
55
- limit?: number;
56
- /**
57
- * Placeholder text for the search input.
58
- */
59
- placeholder?: string;
60
- };
61
-
62
19
  /**
63
20
  * Input parameters for the semantic search hook.
64
- * @alpha
21
+ * @beta
65
22
  */
66
23
  export declare type SemanticSearchHookInput = {
67
24
  /**
@@ -95,7 +52,7 @@ export declare type SemanticSearchHookInput = {
95
52
 
96
53
  /**
97
54
  * The result of the semantic search hook.
98
- * @alpha
55
+ * @beta
99
56
  */
100
57
  export declare type SemanticSearchInputResult = {
101
58
  /**
@@ -119,32 +76,56 @@ export declare type SemanticSearchInputResult = {
119
76
 
120
77
  /**
121
78
  * Semantic search component props.
122
- * @alpha
79
+ * @beta
123
80
  */
124
- export declare type SemanticSearchProps = SemanticSearchCoreProps & {
81
+ export declare type SemanticSearchProps = {
82
+ /**
83
+ * An analytical backend to use for the search. Can be omitted and taken from context.
84
+ */
85
+ backend?: IAnalyticalBackend;
86
+ /**
87
+ * A workspace to search in. Can be omitted and taken from context.
88
+ */
89
+ workspace?: string;
90
+ /**
91
+ * A locale to use for the search. Can be omitted and taken from context.
92
+ */
125
93
  locale?: string;
94
+ /**
95
+ * A function called when the user selects an item from the search results.
96
+ */
97
+ onSelect: (item: ISemanticSearchResultItem) => void;
98
+ /**
99
+ * A function called when an error occurs during the search.
100
+ */
101
+ onError?: (errorMessage: string) => void;
102
+ /**
103
+ * Additional CSS class for the component.
104
+ */
105
+ className?: string;
106
+ /**
107
+ * A list of object types to search for.
108
+ */
109
+ objectTypes?: GenAISemanticSearchType[];
110
+ /**
111
+ * A flag to enable deep search, i.e. search dashboard by their contents.
112
+ */
113
+ deepSearch?: boolean;
114
+ /**
115
+ * A limit of search results to return.
116
+ */
117
+ limit?: number;
118
+ /**
119
+ * Placeholder text for the search input.
120
+ */
121
+ placeholder?: string;
126
122
  };
127
123
 
128
- /**
129
- * List and DropdownList components require explicit width to render correctly.
130
- * This hook measures the width of the input element and returns it.
131
- * There are no UTs for this because jsdom does not compute element dimensions.
132
- * @internal
133
- */
134
- export declare const useElementWidth: () => [React_2.RefCallback<HTMLElement>, number];
135
-
136
- /**
137
- * This hook provides keyboard navigation for a list of items. It listens to ArrowUp, ArrowDown and Enter keys and
138
- * calls the onSelect callback when Enter is pressed.
139
- * @internal
140
- */
141
- export declare const useListSelector: <T>(items: T[], onSelect: (item: T, e: MouseEvent | KeyboardEvent) => void) => [T, (item: T) => void];
142
-
143
124
  /**
144
125
  * Hook to perform semantic search.
145
126
  * Makes the request to server and returns the search results.
146
127
  * The request is cancellable and auto-updates when the search term changes.
147
- * @alpha
128
+ * @beta
148
129
  */
149
130
  export declare const useSemanticSearch: ({ searchTerm, objectTypes, deepSearch, limit, backend, workspace, }: SemanticSearchHookInput) => SemanticSearchInputResult;
150
131
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@gooddata/sdk-ui-semantic-search",
3
- "version": "10.9.0-alpha.25",
3
+ "version": "10.9.0-alpha.27",
4
4
  "description": "GoodData SDK TypeScript & React skeleton",
5
5
  "repository": {
6
6
  "type": "git",
@@ -37,11 +37,11 @@
37
37
  "react-intl": "^6.4.1",
38
38
  "tslib": "^2.5.0",
39
39
  "classnames": "^2.3.1",
40
- "@gooddata/sdk-model": "10.9.0-alpha.25",
41
- "@gooddata/sdk-ui-kit": "10.9.0-alpha.25",
42
- "@gooddata/sdk-ui": "10.9.0-alpha.25",
43
- "@gooddata/sdk-ui-theme-provider": "10.9.0-alpha.25",
44
- "@gooddata/sdk-backend-spi": "10.9.0-alpha.25"
40
+ "@gooddata/sdk-model": "10.9.0-alpha.27",
41
+ "@gooddata/sdk-ui": "10.9.0-alpha.27",
42
+ "@gooddata/sdk-ui-kit": "10.9.0-alpha.27",
43
+ "@gooddata/sdk-backend-spi": "10.9.0-alpha.27",
44
+ "@gooddata/sdk-ui-theme-provider": "10.9.0-alpha.27"
45
45
  },
46
46
  "peerDependencies": {
47
47
  "react": "^16.10.0 || ^17.0.0 || ^18.0.0",
@@ -83,7 +83,7 @@
83
83
  "stylelint": "^13.8.0",
84
84
  "stylelint-checkstyle-formatter": "^0.1.2",
85
85
  "stylelint-config-prettier": "^8.0.2",
86
- "@gooddata/sdk-backend-mockingbird": "10.9.0-alpha.25"
86
+ "@gooddata/sdk-backend-mockingbird": "10.9.0-alpha.27"
87
87
  },
88
88
  "scripts": {
89
89
  "clean": "rm -rf ci dist esm coverage *.log styles/css tsconfig.tsbuildinfo",