@dxos/plugin-search 0.8.4-main.ead640a → 0.8.4-main.effb148878

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.
Files changed (200) hide show
  1. package/LICENSE +102 -5
  2. package/README.md +0 -1
  3. package/dist/lib/neutral/SearchArticle-CQMZ46ZS.mjs +51 -0
  4. package/dist/lib/neutral/SearchArticle-CQMZ46ZS.mjs.map +7 -0
  5. package/dist/lib/neutral/SearchDialog-IFMA5UP5.mjs +76 -0
  6. package/dist/lib/neutral/SearchDialog-IFMA5UP5.mjs.map +7 -0
  7. package/dist/lib/neutral/SearchPlugin.mjs +10 -0
  8. package/dist/lib/neutral/SearchPlugin.mjs.map +7 -0
  9. package/dist/lib/neutral/app-graph-builder-B3W3UWHV.mjs +71 -0
  10. package/dist/lib/neutral/app-graph-builder-B3W3UWHV.mjs.map +7 -0
  11. package/dist/lib/neutral/capabilities/index.mjs +13 -0
  12. package/dist/lib/neutral/capabilities/index.mjs.map +7 -0
  13. package/dist/lib/neutral/chunk-7ASS5WTT.mjs +8 -0
  14. package/dist/lib/neutral/chunk-7ASS5WTT.mjs.map +7 -0
  15. package/dist/lib/neutral/chunk-7VNJDD75.mjs +22 -0
  16. package/dist/lib/neutral/chunk-7VNJDD75.mjs.map +7 -0
  17. package/dist/lib/neutral/chunk-FIZRI3JV.mjs +27 -0
  18. package/dist/lib/neutral/chunk-FIZRI3JV.mjs.map +7 -0
  19. package/dist/lib/neutral/chunk-J5LGTIGS.mjs +10 -0
  20. package/dist/lib/neutral/chunk-J5LGTIGS.mjs.map +7 -0
  21. package/dist/lib/neutral/chunk-NAKPT2JM.mjs +8 -0
  22. package/dist/lib/neutral/chunk-NAKPT2JM.mjs.map +7 -0
  23. package/dist/lib/neutral/chunk-NBE5GQ5J.mjs +282 -0
  24. package/dist/lib/neutral/chunk-NBE5GQ5J.mjs.map +7 -0
  25. package/dist/lib/neutral/chunk-QWFRJRPV.mjs +38 -0
  26. package/dist/lib/neutral/chunk-QWFRJRPV.mjs.map +7 -0
  27. package/dist/lib/neutral/components/index.mjs +97 -0
  28. package/dist/lib/neutral/components/index.mjs.map +7 -0
  29. package/dist/lib/neutral/containers/index.mjs +11 -0
  30. package/dist/lib/neutral/containers/index.mjs.map +7 -0
  31. package/dist/lib/neutral/hooks/index.mjs +30 -0
  32. package/dist/lib/neutral/hooks/index.mjs.map +7 -0
  33. package/dist/lib/neutral/index.mjs +40 -0
  34. package/dist/lib/neutral/index.mjs.map +7 -0
  35. package/dist/lib/neutral/meta.json +1 -0
  36. package/dist/lib/neutral/meta.mjs +10 -0
  37. package/dist/lib/neutral/meta.mjs.map +7 -0
  38. package/dist/lib/neutral/open-search-ABE2Y6ZG.mjs +23 -0
  39. package/dist/lib/neutral/open-search-ABE2Y6ZG.mjs.map +7 -0
  40. package/dist/lib/neutral/operation-handler-DY624P2R.mjs +13 -0
  41. package/dist/lib/neutral/operation-handler-DY624P2R.mjs.map +7 -0
  42. package/dist/lib/neutral/operations/index.mjs +8 -0
  43. package/dist/lib/neutral/operations/index.mjs.map +7 -0
  44. package/dist/lib/neutral/plugin.mjs +16 -0
  45. package/dist/lib/neutral/plugin.mjs.map +7 -0
  46. package/dist/lib/neutral/react-surface-ER7Q4W6Y.mjs +61 -0
  47. package/dist/lib/neutral/react-surface-ER7Q4W6Y.mjs.map +7 -0
  48. package/dist/lib/neutral/testing.mjs +8 -0
  49. package/dist/lib/neutral/testing.mjs.map +7 -0
  50. package/dist/lib/neutral/translations.mjs +25 -0
  51. package/dist/lib/neutral/translations.mjs.map +7 -0
  52. package/dist/lib/neutral/types/index.mjs +8 -0
  53. package/dist/lib/neutral/types/index.mjs.map +7 -0
  54. package/dist/types/src/SearchPlugin.d.ts +3 -1
  55. package/dist/types/src/SearchPlugin.d.ts.map +1 -1
  56. package/dist/types/src/capabilities/app-graph-builder.d.ts +4 -2
  57. package/dist/types/src/capabilities/app-graph-builder.d.ts.map +1 -1
  58. package/dist/types/src/capabilities/index.d.ts +5 -3
  59. package/dist/types/src/capabilities/index.d.ts.map +1 -1
  60. package/dist/types/src/capabilities/operation-handler.d.ts +6 -0
  61. package/dist/types/src/capabilities/operation-handler.d.ts.map +1 -0
  62. package/dist/types/src/capabilities/react-surface.d.ts +3 -2
  63. package/dist/types/src/capabilities/react-surface.d.ts.map +1 -1
  64. package/dist/types/src/components/SearchResultStack/SearchResultStack.d.ts +9 -0
  65. package/dist/types/src/components/SearchResultStack/SearchResultStack.d.ts.map +1 -0
  66. package/dist/types/src/components/SearchResultStack/index.d.ts +2 -0
  67. package/dist/types/src/components/SearchResultStack/index.d.ts.map +1 -0
  68. package/dist/types/src/components/index.d.ts +1 -3
  69. package/dist/types/src/components/index.d.ts.map +1 -1
  70. package/dist/types/src/constants.d.ts +2 -0
  71. package/dist/types/src/constants.d.ts.map +1 -0
  72. package/dist/types/src/containers/SearchArticle/SearchArticle.d.ts +4 -0
  73. package/dist/types/src/containers/SearchArticle/SearchArticle.d.ts.map +1 -0
  74. package/dist/types/src/{components/Searchbar/Searchbar.stories.d.ts → containers/SearchArticle/SearchArticle.stories.d.ts} +3 -2
  75. package/dist/types/src/containers/SearchArticle/SearchArticle.stories.d.ts.map +1 -0
  76. package/dist/types/src/containers/SearchArticle/index.d.ts +2 -0
  77. package/dist/types/src/containers/SearchArticle/index.d.ts.map +1 -0
  78. package/dist/types/src/containers/SearchDialog/SearchDialog.d.ts +7 -0
  79. package/dist/types/src/containers/SearchDialog/SearchDialog.d.ts.map +1 -0
  80. package/dist/types/src/{components/SearchResults/SearchResults.stories.d.ts → containers/SearchDialog/SearchDialog.stories.d.ts} +4 -4
  81. package/dist/types/src/containers/SearchDialog/SearchDialog.stories.d.ts.map +1 -0
  82. package/dist/types/src/containers/SearchDialog/index.d.ts +2 -0
  83. package/dist/types/src/containers/SearchDialog/index.d.ts.map +1 -0
  84. package/dist/types/src/containers/index.d.ts +4 -0
  85. package/dist/types/src/containers/index.d.ts.map +1 -0
  86. package/dist/types/src/hooks/index.d.ts +1 -0
  87. package/dist/types/src/hooks/index.d.ts.map +1 -1
  88. package/dist/types/src/hooks/sync.d.ts +4 -3
  89. package/dist/types/src/hooks/sync.d.ts.map +1 -1
  90. package/dist/types/src/hooks/useGlobalSearch.d.ts +8 -4
  91. package/dist/types/src/hooks/useGlobalSearch.d.ts.map +1 -1
  92. package/dist/types/src/hooks/useSearchResults.d.ts +3 -2
  93. package/dist/types/src/hooks/useSearchResults.d.ts.map +1 -1
  94. package/dist/types/src/hooks/useWebSearch.d.ts +7 -4
  95. package/dist/types/src/hooks/useWebSearch.d.ts.map +1 -1
  96. package/dist/types/src/index.d.ts +0 -1
  97. package/dist/types/src/index.d.ts.map +1 -1
  98. package/dist/types/src/meta.d.ts +2 -2
  99. package/dist/types/src/meta.d.ts.map +1 -1
  100. package/dist/types/src/operations/index.d.ts +3 -0
  101. package/dist/types/src/operations/index.d.ts.map +1 -0
  102. package/dist/types/src/operations/open-search.d.ts +5 -0
  103. package/dist/types/src/operations/open-search.d.ts.map +1 -0
  104. package/dist/types/src/plugin.d.ts +4 -0
  105. package/dist/types/src/plugin.d.ts.map +1 -0
  106. package/dist/types/src/search/exa.d.ts +5 -4
  107. package/dist/types/src/search/exa.d.ts.map +1 -1
  108. package/dist/types/src/testing.d.ts +2 -0
  109. package/dist/types/src/testing.d.ts.map +1 -0
  110. package/dist/types/src/translations.d.ts +15 -10
  111. package/dist/types/src/translations.d.ts.map +1 -1
  112. package/dist/types/src/types/SearchOperation.d.ts +3 -0
  113. package/dist/types/src/types/SearchOperation.d.ts.map +1 -0
  114. package/dist/types/src/types/index.d.ts +1 -1
  115. package/dist/types/src/types/index.d.ts.map +1 -1
  116. package/dist/types/src/types/search.d.ts +1 -20
  117. package/dist/types/src/types/search.d.ts.map +1 -1
  118. package/dist/types/tsconfig.tsbuildinfo +1 -1
  119. package/package.json +119 -47
  120. package/src/SearchPlugin.tsx +14 -47
  121. package/src/capabilities/app-graph-builder.ts +55 -69
  122. package/src/capabilities/index.ts +8 -4
  123. package/src/capabilities/operation-handler.ts +16 -0
  124. package/src/capabilities/react-surface.tsx +65 -52
  125. package/src/components/SearchResultStack/SearchResultStack.tsx +118 -0
  126. package/src/components/SearchResultStack/index.ts +5 -0
  127. package/src/components/index.ts +1 -3
  128. package/src/constants.ts +7 -0
  129. package/src/containers/SearchArticle/SearchArticle.stories.tsx +79 -0
  130. package/src/containers/SearchArticle/SearchArticle.tsx +60 -0
  131. package/src/containers/SearchArticle/index.ts +5 -0
  132. package/src/containers/SearchDialog/SearchDialog.stories.tsx +108 -0
  133. package/src/containers/SearchDialog/SearchDialog.tsx +93 -0
  134. package/src/containers/SearchDialog/index.ts +5 -0
  135. package/src/containers/index.ts +8 -0
  136. package/src/hooks/index.ts +2 -0
  137. package/src/hooks/sync.test.ts +9 -7
  138. package/src/hooks/sync.ts +32 -34
  139. package/src/hooks/useGlobalSearch.tsx +32 -13
  140. package/src/hooks/useSearchResults.ts +7 -4
  141. package/src/hooks/useWebSearch.ts +25 -14
  142. package/src/index.ts +2 -2
  143. package/src/meta.ts +25 -5
  144. package/src/operations/index.ts +7 -0
  145. package/src/operations/open-search.ts +24 -0
  146. package/src/plugin.ts +11 -0
  147. package/src/search/exa.test.ts +9 -11
  148. package/src/search/exa.ts +11 -10
  149. package/src/testing.ts +7 -0
  150. package/src/translations.ts +10 -9
  151. package/src/types/SearchOperation.ts +19 -0
  152. package/src/types/command-score.d.ts +16 -0
  153. package/src/types/index.ts +2 -1
  154. package/src/types/search.ts +1 -25
  155. package/dist/lib/browser/app-graph-builder-YME7SN7O.mjs +0 -78
  156. package/dist/lib/browser/app-graph-builder-YME7SN7O.mjs.map +0 -7
  157. package/dist/lib/browser/chunk-5N6LDSFF.mjs +0 -18
  158. package/dist/lib/browser/chunk-5N6LDSFF.mjs.map +0 -7
  159. package/dist/lib/browser/chunk-WN3TVQLV.mjs +0 -190
  160. package/dist/lib/browser/chunk-WN3TVQLV.mjs.map +0 -7
  161. package/dist/lib/browser/chunk-YJGHPWUO.mjs +0 -21
  162. package/dist/lib/browser/chunk-YJGHPWUO.mjs.map +0 -7
  163. package/dist/lib/browser/index.mjs +0 -110
  164. package/dist/lib/browser/index.mjs.map +0 -7
  165. package/dist/lib/browser/intent-resolver-XNVR4XRX.mjs +0 -22
  166. package/dist/lib/browser/intent-resolver-XNVR4XRX.mjs.map +0 -7
  167. package/dist/lib/browser/meta.json +0 -1
  168. package/dist/lib/browser/react-surface-YOGLADC4.mjs +0 -470
  169. package/dist/lib/browser/react-surface-YOGLADC4.mjs.map +0 -7
  170. package/dist/types/src/capabilities/intent-resolver.d.ts +0 -4
  171. package/dist/types/src/capabilities/intent-resolver.d.ts.map +0 -1
  172. package/dist/types/src/components/Search.stories.d.ts +0 -16
  173. package/dist/types/src/components/Search.stories.d.ts.map +0 -1
  174. package/dist/types/src/components/SearchDialog.d.ts +0 -7
  175. package/dist/types/src/components/SearchDialog.d.ts.map +0 -1
  176. package/dist/types/src/components/SearchMain.d.ts +0 -7
  177. package/dist/types/src/components/SearchMain.d.ts.map +0 -1
  178. package/dist/types/src/components/SearchResults/SearchResults.d.ts +0 -20
  179. package/dist/types/src/components/SearchResults/SearchResults.d.ts.map +0 -1
  180. package/dist/types/src/components/SearchResults/SearchResults.stories.d.ts.map +0 -1
  181. package/dist/types/src/components/SearchResults/index.d.ts +0 -2
  182. package/dist/types/src/components/SearchResults/index.d.ts.map +0 -1
  183. package/dist/types/src/components/Searchbar/Searchbar.d.ts +0 -14
  184. package/dist/types/src/components/Searchbar/Searchbar.d.ts.map +0 -1
  185. package/dist/types/src/components/Searchbar/Searchbar.stories.d.ts.map +0 -1
  186. package/dist/types/src/components/Searchbar/index.d.ts +0 -2
  187. package/dist/types/src/components/Searchbar/index.d.ts.map +0 -1
  188. package/dist/types/src/types/action.d.ts +0 -13
  189. package/dist/types/src/types/action.d.ts.map +0 -1
  190. package/src/capabilities/intent-resolver.ts +0 -18
  191. package/src/components/Search.stories.tsx +0 -64
  192. package/src/components/SearchDialog.tsx +0 -124
  193. package/src/components/SearchMain.tsx +0 -68
  194. package/src/components/SearchResults/SearchResults.stories.tsx +0 -58
  195. package/src/components/SearchResults/SearchResults.tsx +0 -86
  196. package/src/components/SearchResults/index.ts +0 -5
  197. package/src/components/Searchbar/Searchbar.stories.tsx +0 -28
  198. package/src/components/Searchbar/Searchbar.tsx +0 -67
  199. package/src/components/Searchbar/index.ts +0 -5
  200. package/src/types/action.tsx +0 -16
@@ -2,14 +2,19 @@
2
2
  // Copyright 2023 DXOS.org
3
3
  //
4
4
 
5
- import React, { type PropsWithChildren, createContext, useContext, useMemo, useState } from 'react';
5
+ import React, { type PropsWithChildren, createContext, useCallback, useContext, useState } from 'react';
6
6
 
7
7
  import { raise } from '@dxos/debug';
8
+ import { type Entity } from '@dxos/echo';
9
+ import { GlobalFilterProvider } from '@dxos/react-ui-search';
8
10
 
9
- import { type SearchResult } from '../types';
11
+ import { type SearchResult } from '#types';
10
12
 
11
13
  import { filterObjectsSync, queryStringToMatch } from './sync';
12
14
 
15
+ // Re-export for backward compatibility.
16
+ export { useGlobalFilteredObjects, GlobalFilterProvider } from '@dxos/react-ui-search';
17
+
13
18
  type SearchContextType = {
14
19
  match?: RegExp;
15
20
  setMatch?: (text?: string) => void;
@@ -17,26 +22,40 @@ type SearchContextType = {
17
22
 
18
23
  const SearchContext = createContext<SearchContextType>({});
19
24
 
25
+ /**
26
+ * Provider for global search context.
27
+ * Also provides the GlobalFilterProvider for useGlobalFilteredObjects to work.
28
+ */
20
29
  export const SearchContextProvider = ({ children }: PropsWithChildren) => {
21
30
  const [match, setMatch] = useState<RegExp>();
22
31
  const handleMatch = (text?: string) => setMatch(queryStringToMatch(text));
23
- return <SearchContext.Provider value={{ match, setMatch: handleMatch }}>{children}</SearchContext.Provider>;
32
+
33
+ // Provide a filter function for useGlobalFilteredObjects.
34
+ const filterFn = useCallback(
35
+ <T extends Entity.Any>(objects: T[]): T[] => {
36
+ if (!match) {
37
+ return objects;
38
+ }
39
+
40
+ return filterObjectsSync(objects, match)
41
+ .filter((result) => result.object)
42
+ .map((result) => result.object!);
43
+ },
44
+ [match],
45
+ );
46
+
47
+ return (
48
+ <SearchContext.Provider value={{ match, setMatch: handleMatch }}>
49
+ <GlobalFilterProvider filter={filterFn}>{children}</GlobalFilterProvider>
50
+ </SearchContext.Provider>
51
+ );
24
52
  };
25
53
 
26
54
  export const useGlobalSearch = () => {
27
55
  return useContext(SearchContext) ?? raise(new Error('Missing SearchContext.'));
28
56
  };
29
57
 
30
- export const useGlobalSearchResults = <T extends Record<string, any>>(objects?: T[]): SearchResult[] => {
58
+ export const useGlobalSearchResults = <T extends Entity.Unknown>(objects?: T[]): SearchResult<T>[] => {
31
59
  const { match } = useGlobalSearch();
32
60
  return objects && match ? filterObjectsSync(objects, match) : [];
33
61
  };
34
-
35
- export const useGlobalFilteredObjects = <T extends Record<string, any>>(objects?: T[]): T[] => {
36
- const { match } = useGlobalSearch();
37
- if (!match || !objects) {
38
- return objects ?? [];
39
- }
40
-
41
- return useMemo(() => filterObjectsSync(objects, match).map((result) => result.object), [objects, match]);
42
- };
@@ -5,12 +5,13 @@
5
5
  import { yieldOrContinue } from 'main-thread-scheduling';
6
6
  import { useEffect, useState } from 'react';
7
7
 
8
- import { DataType } from '@dxos/schema';
8
+ import { type Entity, Obj } from '@dxos/echo';
9
+ import { Text } from '@dxos/schema';
9
10
 
10
11
  // TODO(thure): Deprecate search-sync, move still-relevant utilities elsewhere (here, probably).
11
12
  import { mapObjectToTextFields, queryStringToMatch } from './sync';
12
13
 
13
- export const filterObjects = async <T extends Record<string, any>>(
14
+ export const filterObjects = async <T extends Entity.Unknown>(
14
15
  objects: T[],
15
16
  match?: RegExp,
16
17
  ): Promise<Map<T, string[][]>> => {
@@ -18,9 +19,10 @@ export const filterObjects = async <T extends Record<string, any>>(
18
19
  if (!match) {
19
20
  return result;
20
21
  }
22
+
21
23
  await Promise.all(
22
24
  objects
23
- .filter((object) => !(object instanceof DataType.Text))
25
+ .filter((object) => !Obj.instanceOf(Text.Text, object))
24
26
  .map(async (object) => {
25
27
  await yieldOrContinue('interactive');
26
28
  const fields = mapObjectToTextFields<T>(object);
@@ -34,10 +36,11 @@ export const filterObjects = async <T extends Record<string, any>>(
34
36
  });
35
37
  }),
36
38
  );
39
+
37
40
  return result;
38
41
  };
39
42
 
40
- export const useSearchResults = <T extends Record<string, any>>(
43
+ export const useSearchResults = <T extends Entity.Unknown>(
41
44
  queryString?: string,
42
45
  objects?: T[],
43
46
  delay: number = 400,
@@ -2,44 +2,55 @@
2
2
  // Copyright 2025 DXOS.org
3
3
  //
4
4
 
5
- import { useState } from 'react';
5
+ import { useCallback, useState } from 'react';
6
6
 
7
7
  import { EXA_API_KEY } from '@dxos/ai/testing';
8
- import { Obj } from '@dxos/echo';
9
- import { type DXN } from '@dxos/keys';
8
+ import { Entity, Type } from '@dxos/echo';
10
9
  import { log } from '@dxos/log';
11
10
  import { getIconAnnotation } from '@dxos/schema';
12
- import { Testing } from '@dxos/schema/testing';
11
+ import { TestSchema } from '@dxos/schema/testing';
13
12
 
14
- import { search } from '../search';
15
- import { type SearchResult } from '../types';
13
+ import { type SearchResult } from '#types';
16
14
 
15
+ import { search } from '../search';
17
16
  import { getStringProperty } from './sync';
18
17
 
19
- export const useWebSearch = ({ query, context }: { query?: string; context?: string }) => {
18
+ export type UseWebSearchProps = {
19
+ query?: string;
20
+ context?: string;
21
+ };
22
+
23
+ export type UseWebSearch = {
24
+ update: () => Promise<void>;
25
+ results: SearchResult[];
26
+ isLoading: boolean;
27
+ };
28
+
29
+ /** @deprecated */
30
+ // TODO(burdon): Remove testing deps.
31
+ export const useWebSearch = ({ query, context }: UseWebSearchProps): UseWebSearch => {
20
32
  const [results, setResults] = useState<SearchResult[]>([]);
21
33
  const [isLoading, setIsLoading] = useState(false);
22
34
 
23
- const runSearch = async () => {
35
+ const update = useCallback(async () => {
24
36
  try {
25
37
  setIsLoading(true);
26
38
  log.info('Running web search', { query, context });
27
39
  const results = await search({
28
40
  query,
29
41
  context,
30
- schema: [Testing.Project, Testing.Organization, Testing.Contact],
42
+ types: [TestSchema.Person, TestSchema.Project, TestSchema.Organization], // TODO(burdon): ???
31
43
  exaApiKey: EXA_API_KEY,
32
44
  });
33
45
 
34
46
  const mappedResults = results.data.map((result): SearchResult => {
35
- const schema = Obj.getSchema(result);
47
+ const schema = Entity.getType(result);
36
48
  return {
37
49
  id: result.id,
38
- objectType: Obj.getTypename(result) as DXN.String | undefined,
39
50
  label: getStringProperty(result, ['name', 'title', 'label']),
40
51
  snippet: getStringProperty(result, ['description', 'content', 'website', 'email']),
41
52
  object: result,
42
- icon: schema?.pipe(getIconAnnotation),
53
+ icon: schema ? getIconAnnotation(Type.getSchema(schema)) : undefined,
43
54
  };
44
55
  });
45
56
 
@@ -47,7 +58,7 @@ export const useWebSearch = ({ query, context }: { query?: string; context?: str
47
58
  } finally {
48
59
  setIsLoading(false);
49
60
  }
50
- };
61
+ }, [query, context]);
51
62
 
52
- return { runSearch, results, isLoading };
63
+ return { update, results, isLoading };
53
64
  };
package/src/index.ts CHANGED
@@ -2,8 +2,8 @@
2
2
  // Copyright 2023 DXOS.org
3
3
  //
4
4
 
5
+ // TODO(wittjosiah): Hooks should not be exported from the plugin package at all.
6
+ // Either refactor callers to not need them or factor them out to a shared package.
5
7
  export * from './hooks';
6
8
  export * from './meta';
7
9
  export * from './types';
8
-
9
- export * from './SearchPlugin';
package/src/meta.ts CHANGED
@@ -2,15 +2,35 @@
2
2
  // Copyright 2023 DXOS.org
3
3
  //
4
4
 
5
- import { type PluginMeta } from '@dxos/app-framework';
5
+ import { type Plugin } from '@dxos/app-framework';
6
+ import { trim } from '@dxos/util';
6
7
 
7
- export const meta: PluginMeta = {
8
- id: 'dxos.org/plugin/search',
8
+ export const meta: Plugin.Meta = {
9
+ id: 'org.dxos.plugin.search',
9
10
  name: 'Search',
10
- description: 'Search ECHO spaces for content.',
11
+ author: 'DXOS',
12
+ description: trim`
13
+ Full-text search engine for finding content across all spaces and object types in DXOS Composer.
14
+ The plugin provides a global command-palette style dialog (invoked via the OpenSearch operation)
15
+ that debounces user input and matches it against every field of every ECHO object in the active
16
+ space, returning ranked results with field-level match context.
17
+
18
+ A persistent SearchArticle panel can be pinned in the deck companion sidebar so the query stays
19
+ visible while navigating documents. Both surfaces share a SearchContextProvider that drives the
20
+ GlobalFilterProvider, allowing any view that uses useGlobalFilteredObjects to automatically show
21
+ only the objects matching the current query.
22
+
23
+ Web search is available through the Exa integration: when an API key is configured, the plugin
24
+ can fetch and rank external web results alongside local objects. The results are structured with
25
+ URL, title, and snippet fields ready for use in Composer documents.
26
+
27
+ All search operations are registered through the standard DXOS operations system and can be
28
+ wired into keyboard shortcuts, command palettes, and AI assistants via the OperationHandlerSet.
29
+ `,
11
30
  icon: 'ph--magnifying-glass--regular',
12
31
  source: 'https://github.com/dxos/dxos/tree/main/packages/plugins/plugin-search',
32
+ spec: 'PLUGIN.mdl',
13
33
  tags: ['labs'],
14
34
  };
15
35
 
16
- export const SEARCH_RESULT = `${meta.id}/result`;
36
+ export const SEARCH_RESULT = `${meta.id}.result`;
@@ -0,0 +1,7 @@
1
+ //
2
+ // Copyright 2025 DXOS.org
3
+ //
4
+
5
+ import { OperationHandlerSet } from '@dxos/compute';
6
+
7
+ export const SearchOperationHandlerSet = OperationHandlerSet.lazy(() => import('./open-search'));
@@ -0,0 +1,24 @@
1
+ //
2
+ // Copyright 2025 DXOS.org
3
+ //
4
+
5
+ import * as Effect from 'effect/Effect';
6
+
7
+ import { LayoutOperation } from '@dxos/app-toolkit';
8
+ import { Operation } from '@dxos/compute';
9
+
10
+ import { SEARCH_DIALOG } from '../constants';
11
+ import { SearchOperation } from '../types';
12
+
13
+ const handler: Operation.WithHandler<typeof SearchOperation.OpenSearch> = SearchOperation.OpenSearch.pipe(
14
+ Operation.withHandler(
15
+ Effect.fnUntraced(function* () {
16
+ yield* Operation.invoke(LayoutOperation.UpdateDialog, {
17
+ subject: SEARCH_DIALOG,
18
+ blockAlign: 'start',
19
+ });
20
+ }),
21
+ ),
22
+ );
23
+
24
+ export default handler;
package/src/plugin.ts ADDED
@@ -0,0 +1,11 @@
1
+ //
2
+ // Copyright 2023 DXOS.org
3
+ //
4
+
5
+ import { Plugin } from '@dxos/app-framework';
6
+
7
+ import { meta } from './meta';
8
+
9
+ export const SearchPlugin = Plugin.lazy(meta, () => import('#plugin'));
10
+
11
+ export { SearchOperationHandlerSet } from './operations';
@@ -6,8 +6,7 @@ import { describe, test } from 'vitest';
6
6
 
7
7
  import { EXA_API_KEY } from '@dxos/ai/testing';
8
8
  import { log } from '@dxos/log';
9
- import { Testing } from '@dxos/schema/testing';
10
- import { trim } from '@dxos/util';
9
+ import { TestSchema } from '@dxos/schema/testing';
11
10
 
12
11
  import { search } from './exa';
13
12
 
@@ -16,7 +15,7 @@ describe.skip('Search', () => {
16
15
  test.skip('contacts', { timeout: 60_000 }, async () => {
17
16
  const objects = await search({
18
17
  query: 'top executives at google',
19
- schema: [Testing.Contact],
18
+ types: [TestSchema.Person],
20
19
  exaApiKey: EXA_API_KEY,
21
20
  });
22
21
 
@@ -26,7 +25,7 @@ describe.skip('Search', () => {
26
25
  test.skip('contacts projects and orgs', { timeout: 60_000 }, async () => {
27
26
  const objects = await search({
28
27
  query: 'top executives at google',
29
- schema: [Testing.Contact, Testing.Project, Testing.Organization],
28
+ types: [TestSchema.Person, TestSchema.Project, TestSchema.Organization],
30
29
  exaApiKey: EXA_API_KEY,
31
30
  });
32
31
 
@@ -36,7 +35,7 @@ describe.skip('Search', () => {
36
35
  test('a19z org, projects they invest in and team', { timeout: 60_000 }, async () => {
37
36
  const objects = await search({
38
37
  query: 'a19z org, projects they invest in and team',
39
- schema: [Testing.Project, Testing.Organization, Testing.Contact],
38
+ types: [TestSchema.Project, TestSchema.Organization, TestSchema.Person],
40
39
  exaApiKey: EXA_API_KEY,
41
40
  });
42
41
 
@@ -46,7 +45,7 @@ describe.skip('Search', () => {
46
45
  test('companies building CRDTs', { timeout: 60_000 }, async () => {
47
46
  const objects = await search({
48
47
  query: 'companies building CRDTs',
49
- schema: [Testing.Project, Testing.Organization, Testing.Contact],
48
+ types: [TestSchema.Project, TestSchema.Organization, TestSchema.Person],
50
49
  exaApiKey: EXA_API_KEY,
51
50
  });
52
51
 
@@ -58,7 +57,7 @@ describe.skip('Search', () => {
58
57
  test('composer context-based search', { timeout: 60_000 }, async () => {
59
58
  const objects = await search({
60
59
  context: COMPOSER_DXOS_DOC,
61
- schema: [Testing.Project, Testing.Organization, Testing.Contact],
60
+ types: [TestSchema.Project, TestSchema.Organization, TestSchema.Person],
62
61
  exaApiKey: EXA_API_KEY,
63
62
  });
64
63
 
@@ -68,7 +67,7 @@ describe.skip('Search', () => {
68
67
  test.only('edge architecture', { timeout: 60_000 }, async () => {
69
68
  const objects = await search({
70
69
  context: EDGE_ARCHITECTURE_DOC,
71
- schema: [Testing.Project, Testing.Organization, Testing.Contact],
70
+ types: [TestSchema.Project, TestSchema.Organization, TestSchema.Person],
72
71
  exaApiKey: EXA_API_KEY,
73
72
  });
74
73
 
@@ -77,8 +76,7 @@ describe.skip('Search', () => {
77
76
  });
78
77
  });
79
78
 
80
- // TODO(dmaretskyi): Import as txt.
81
- const COMPOSER_DXOS_DOC = trim`
79
+ const COMPOSER_DXOS_DOC = `
82
80
  ![img](https://dxos.network/dxos-logotype-blue.png)
83
81
  # Welcome to Composer by DXOS
84
82
 
@@ -86,7 +84,7 @@ const COMPOSER_DXOS_DOC = trim`
86
84
 
87
85
  Composer is an extensible application that includes familiar components such as documents, diagrams, and tables. It leverages DXOS — a full stack framework for building collaborative local-first applications.
88
86
 
89
- With our upcoming SDK, you'll be able to build custom plugins, leverage external APIs and integrate with LLMs. All inside of a private collaborative workspace.
87
+ With our SDK, you'll be able to build custom plugins, leverage external APIs and integrate with LLMs. All inside of a private collaborative workspace.
90
88
 
91
89
  ## Disclaimer
92
90
 
package/src/search/exa.ts CHANGED
@@ -8,17 +8,17 @@ import * as Option from 'effect/Option';
8
8
  import * as Schema from 'effect/Schema';
9
9
  import * as SchemaAST from 'effect/SchemaAST';
10
10
 
11
- import { Key, Obj } from '@dxos/echo';
12
- import { ReferenceAnnotationId } from '@dxos/echo/internal';
11
+ import { type Entity, Key, Obj, type Type } from '@dxos/echo';
13
12
  import { isEncodedReference } from '@dxos/echo-protocol';
13
+ import { ReferenceAnnotationId } from '@dxos/echo/internal';
14
14
  import { mapAst } from '@dxos/effect';
15
15
  import { deepMapValues, trim } from '@dxos/util';
16
16
 
17
- export type SearchOptions<Schema extends Schema.Schema.AnyNoContext> = {
17
+ export type SearchOptions<T extends Type.AnyEntity> = {
18
18
  query?: string;
19
19
  // TODO(dmaretskyi): How can we pass this through.
20
20
  context?: string;
21
- schema: Schema[];
21
+ types: T[];
22
22
  exaApiKey: string;
23
23
  liveCrawl?: boolean;
24
24
  };
@@ -31,9 +31,10 @@ export type SearchResult<T = unknown> = {
31
31
  };
32
32
  };
33
33
 
34
- export const search = async <Schema extends Schema.Schema.AnyNoContext>(
35
- options: SearchOptions<Schema>,
36
- ): Promise<SearchResult<Schema.Schema.Type<Schema>>> => {
34
+ /** @deprecated Use MixedStreamParser */
35
+ export const search = async <T extends Type.AnyEntity>(
36
+ options: SearchOptions<T>,
37
+ ): Promise<SearchResult<Entity.Unknown>> => {
37
38
  throw new Error('Not implemented');
38
39
  // assertArgument(options.query || options.context, "query or context", "query or context is required");
39
40
  // let contextSearchTerms: readonly string[] = [];
@@ -63,7 +64,7 @@ export const search = async <Schema extends Schema.Schema.AnyNoContext>(
63
64
  // model: '@anthropic/claude-3-5-haiku-20241022',
64
65
  // systemPrompt,
65
66
  // history: [
66
- // Obj.make(DataType.Message, {
67
+ // Obj.make(Message.Message, {
67
68
  // created: new Date().toISOString(),
68
69
  // sender: { role: 'user' },
69
70
  // blocks: context.results.map(
@@ -159,7 +160,7 @@ const DATA_EXTRACTION_INSTRUCTIONS = trim`
159
160
  // Prefer own names of people, companies, and projects, technologies, and other entities.
160
161
  // `,
161
162
  // history: [
162
- // Obj.make(DataType.Message, {
163
+ // Obj.make(Message.Message, {
163
164
  // created: new Date().toISOString(),
164
165
  // sender: { role: 'user' },
165
166
  // blocks: [
@@ -180,7 +181,7 @@ const DATA_EXTRACTION_INSTRUCTIONS = trim`
180
181
  // return terms;
181
182
  // };
182
183
 
183
- const sanitizeObjects = (entries: { data: any; schema: Schema.Schema.AnyNoContext }[]) => {
184
+ const sanitizeObjects = (entries: { data: any; schema: Type.AnyObj }[]) => {
184
185
  const idMap = new Map<string, string>();
185
186
 
186
187
  return entries
package/src/testing.ts ADDED
@@ -0,0 +1,7 @@
1
+ //
2
+ // Copyright 2025 DXOS.org
3
+ //
4
+
5
+ // Eager re-export of `SearchPlugin`. See `@dxos/plugin-testing/src/core.ts`
6
+ // for the rationale.
7
+ export * from './SearchPlugin';
@@ -3,21 +3,22 @@
3
3
  //
4
4
 
5
5
  import { type Resource } from '@dxos/react-ui';
6
+ import { translations as searchTranslations } from '@dxos/react-ui-search/translations';
6
7
 
7
- import { meta } from './meta';
8
+ import { meta } from '#meta';
8
9
 
9
10
  export const translations = [
11
+ ...searchTranslations,
10
12
  {
11
13
  'en-US': {
12
14
  [meta.id]: {
13
- 'plugin name': 'Search',
14
- 'search action label': 'Search spaces',
15
- 'search placeholder': 'Search…',
16
- 'search dialog title': 'Open',
17
- 'recently closed heading': 'Recently closed',
18
- 'pending results message': 'Searching…',
19
- 'empty results message': 'No matching items in your spaces',
20
- 'search label': 'Search',
15
+ 'plugin.name': 'Search',
16
+ 'search-action.label': 'Search spaces',
17
+ 'search.placeholder': 'Search…',
18
+ 'search-dialog.title': 'Search',
19
+ 'recently-closed.heading': 'Recently closed',
20
+ 'pending-results.message': 'Searching…',
21
+ 'search.label': 'Search',
21
22
  },
22
23
  },
23
24
  },
@@ -0,0 +1,19 @@
1
+ //
2
+ // Copyright 2025 DXOS.org
3
+ //
4
+
5
+ // @import-as-namespace
6
+
7
+ import * as Schema from 'effect/Schema';
8
+
9
+ import { Operation } from '@dxos/compute';
10
+
11
+ import { meta } from '#meta';
12
+
13
+ const SEARCH_OPERATION = `${meta.id}.operation`;
14
+
15
+ export const OpenSearch = Operation.make({
16
+ meta: { key: `${SEARCH_OPERATION}.open-search`, name: 'Open Search', icon: 'ph--magnifying-glass--regular' },
17
+ input: Schema.Void,
18
+ output: Schema.Void,
19
+ });
@@ -0,0 +1,16 @@
1
+ //
2
+ // Copyright 2025 DXOS.org
3
+ //
4
+
5
+ declare module 'command-score' {
6
+ /**
7
+ * Scores how well a string matches a query using a fuzzy matching algorithm.
8
+ * Used by cmdk for its built-in filtering.
9
+ *
10
+ * @param string - The string to score against.
11
+ * @param query - The search query.
12
+ * @returns A score between 0 and 1, where higher values indicate better matches.
13
+ */
14
+ function commandScore(string: string, query: string): number;
15
+ export default commandScore;
16
+ }
@@ -2,5 +2,6 @@
2
2
  // Copyright 2025 DXOS.org
3
3
  //
4
4
 
5
- export * from './action';
6
5
  export type * from './search';
6
+
7
+ export * as SearchOperation from './SearchOperation';
@@ -2,28 +2,4 @@
2
2
  // Copyright 2025 DXOS.org
3
3
  //
4
4
 
5
- import type { DXN } from '@dxos/keys';
6
-
7
- export type SearchResult = {
8
- id: string;
9
-
10
- /**
11
- * Type kind: "contact", "project", "org", etc.
12
- */
13
- type?: string;
14
- label?: string;
15
- match?: RegExp;
16
- snippet?: string;
17
-
18
- /**
19
- * Icon id.
20
- */
21
- icon?: string;
22
-
23
- /**
24
- * DXN of the object type.
25
- */
26
- objectType?: DXN.String;
27
-
28
- object?: any;
29
- };
5
+ export type { SearchResult } from '@dxos/react-ui-search';
@@ -1,78 +0,0 @@
1
- import {
2
- SearchAction
3
- } from "./chunk-YJGHPWUO.mjs";
4
- import {
5
- meta
6
- } from "./chunk-5N6LDSFF.mjs";
7
-
8
- // src/capabilities/app-graph-builder.ts
9
- import { Rx } from "@effect-rx/rx-react";
10
- import * as Function from "effect/Function";
11
- import * as Option from "effect/Option";
12
- import { Capabilities, contributes, createIntent } from "@dxos/app-framework";
13
- import { ClientCapabilities } from "@dxos/plugin-client";
14
- import { ATTENDABLE_PATH_SEPARATOR, DECK_COMPANION_TYPE } from "@dxos/plugin-deck/types";
15
- import { ROOT_ID, createExtension, rxFromSignal } from "@dxos/plugin-graph";
16
- import { parseId } from "@dxos/react-client/echo";
17
- var app_graph_builder_default = ((context) => contributes(Capabilities.AppGraphBuilder, [
18
- createExtension({
19
- id: `${meta.id}/space-search`,
20
- connector: (node) => Rx.make((get) => Function.pipe(get(node), Option.flatMap((node2) => node2.id === ROOT_ID ? Option.some(node2) : Option.none()), Option.map((node2) => {
21
- const workspace = get(rxFromSignal(() => context.getCapability(Capabilities.Layout).workspace));
22
- const client = context.getCapability(ClientCapabilities.Client);
23
- const { spaceId } = parseId(workspace);
24
- const space = spaceId ? client.spaces.get(spaceId) : null;
25
- return [
26
- {
27
- id: [
28
- node2.id,
29
- "search"
30
- ].join(ATTENDABLE_PATH_SEPARATOR),
31
- type: DECK_COMPANION_TYPE,
32
- data: space,
33
- properties: {
34
- label: [
35
- "search label",
36
- {
37
- ns: meta.id
38
- }
39
- ],
40
- icon: "ph--magnifying-glass--regular",
41
- disposition: "hidden"
42
- }
43
- }
44
- ];
45
- }), Option.getOrElse(() => [])))
46
- }),
47
- createExtension({
48
- id: meta.id,
49
- actions: (node) => Rx.make((get) => Function.pipe(get(node), Option.flatMap((node2) => node2.id === ROOT_ID ? Option.some(node2) : Option.none()), Option.map(() => {
50
- return [
51
- {
52
- id: SearchAction.OpenSearch._tag,
53
- data: async () => {
54
- const { dispatchPromise: dispatch } = context.getCapability(Capabilities.IntentDispatcher);
55
- await dispatch(createIntent(SearchAction.OpenSearch));
56
- },
57
- properties: {
58
- label: [
59
- "search action label",
60
- {
61
- ns: meta.id
62
- }
63
- ],
64
- icon: "ph--magnifying-glass--regular",
65
- keyBinding: {
66
- macos: "shift+meta+f",
67
- windows: "shift+alt+f"
68
- }
69
- }
70
- }
71
- ];
72
- }), Option.getOrElse(() => [])))
73
- })
74
- ]));
75
- export {
76
- app_graph_builder_default as default
77
- };
78
- //# sourceMappingURL=app-graph-builder-YME7SN7O.mjs.map
@@ -1,7 +0,0 @@
1
- {
2
- "version": 3,
3
- "sources": ["../../../src/capabilities/app-graph-builder.ts"],
4
- "sourcesContent": ["//\n// Copyright 2025 DXOS.org\n//\n\nimport { Rx } from '@effect-rx/rx-react';\nimport * as Function from 'effect/Function';\nimport * as Option from 'effect/Option';\n\nimport { Capabilities, type PluginContext, contributes, createIntent } from '@dxos/app-framework';\nimport { ClientCapabilities } from '@dxos/plugin-client';\nimport { ATTENDABLE_PATH_SEPARATOR, DECK_COMPANION_TYPE } from '@dxos/plugin-deck/types';\nimport { ROOT_ID, createExtension, rxFromSignal } from '@dxos/plugin-graph';\nimport { parseId } from '@dxos/react-client/echo';\n\nimport { meta } from '../meta';\nimport { SearchAction } from '../types';\n\nexport default (context: PluginContext) =>\n contributes(Capabilities.AppGraphBuilder, [\n createExtension({\n id: `${meta.id}/space-search`,\n connector: (node) =>\n Rx.make((get) =>\n Function.pipe(\n get(node),\n Option.flatMap((node) => (node.id === ROOT_ID ? Option.some(node) : Option.none())),\n Option.map((node) => {\n const workspace = get(rxFromSignal(() => context.getCapability(Capabilities.Layout).workspace));\n const client = context.getCapability(ClientCapabilities.Client);\n const { spaceId } = parseId(workspace);\n const space = spaceId ? client.spaces.get(spaceId) : null;\n\n return [\n {\n id: [node.id, 'search'].join(ATTENDABLE_PATH_SEPARATOR),\n type: DECK_COMPANION_TYPE,\n data: space,\n properties: {\n label: ['search label', { ns: meta.id }],\n icon: 'ph--magnifying-glass--regular',\n disposition: 'hidden',\n },\n },\n ];\n }),\n Option.getOrElse(() => []),\n ),\n ),\n }),\n createExtension({\n id: meta.id,\n actions: (node) =>\n Rx.make((get) =>\n Function.pipe(\n get(node),\n Option.flatMap((node) => (node.id === ROOT_ID ? Option.some(node) : Option.none())),\n Option.map(() => {\n return [\n {\n id: SearchAction.OpenSearch._tag,\n data: async () => {\n const { dispatchPromise: dispatch } = context.getCapability(Capabilities.IntentDispatcher);\n await dispatch(createIntent(SearchAction.OpenSearch));\n },\n properties: {\n label: ['search action label', { ns: meta.id }],\n icon: 'ph--magnifying-glass--regular',\n keyBinding: {\n macos: 'shift+meta+f',\n windows: 'shift+alt+f',\n },\n },\n },\n ];\n }),\n Option.getOrElse(() => []),\n ),\n ),\n }),\n ]);\n"],
5
- "mappings": ";;;;;;;;AAIA,SAASA,UAAU;AACnB,YAAYC,cAAc;AAC1B,YAAYC,YAAY;AAExB,SAASC,cAAkCC,aAAaC,oBAAoB;AAC5E,SAASC,0BAA0B;AACnC,SAASC,2BAA2BC,2BAA2B;AAC/D,SAASC,SAASC,iBAAiBC,oBAAoB;AACvD,SAASC,eAAe;AAKxB,IAAA,6BAAe,CAACC,YACdC,YAAYC,aAAaC,iBAAiB;EACxCC,gBAAgB;IACdC,IAAI,GAAGC,KAAKD,EAAE;IACdE,WAAW,CAACC,SACVC,GAAGC,KAAK,CAACC,QACEC,cACPD,IAAIH,IAAAA,GACGK,eAAQ,CAACL,UAAUA,MAAKH,OAAOS,UAAiBC,YAAKP,KAAAA,IAAeQ,YAAI,CAAA,GACxEC,WAAI,CAACT,UAAAA;AACV,YAAMU,YAAYP,IAAIQ,aAAa,MAAMnB,QAAQoB,cAAclB,aAAamB,MAAM,EAAEH,SAAS,CAAA;AAC7F,YAAMI,SAAStB,QAAQoB,cAAcG,mBAAmBC,MAAM;AAC9D,YAAM,EAAEC,QAAO,IAAKC,QAAQR,SAAAA;AAC5B,YAAMS,QAAQF,UAAUH,OAAOM,OAAOjB,IAAIc,OAAAA,IAAW;AAErD,aAAO;QACL;UACEpB,IAAI;YAACG,MAAKH;YAAI;YAAUwB,KAAKC,yBAAAA;UAC7BC,MAAMC;UACNC,MAAMN;UACNO,YAAY;YACVC,OAAO;cAAC;cAAgB;gBAAEC,IAAI9B,KAAKD;cAAG;;YACtCgC,MAAM;YACNC,aAAa;UACf;QACF;;IAEJ,CAAA,GACOC,iBAAU,MAAM,CAAA,CAAE,CAAA,CAAA;EAGjC,CAAA;EACAnC,gBAAgB;IACdC,IAAIC,KAAKD;IACTmC,SAAS,CAAChC,SACRC,GAAGC,KAAK,CAACC,QACEC,cACPD,IAAIH,IAAAA,GACGK,eAAQ,CAACL,UAAUA,MAAKH,OAAOS,UAAiBC,YAAKP,KAAAA,IAAeQ,YAAI,CAAA,GACxEC,WAAI,MAAA;AACT,aAAO;QACL;UACEZ,IAAIoC,aAAaC,WAAWC;UAC5BV,MAAM,YAAA;AACJ,kBAAM,EAAEW,iBAAiBC,SAAQ,IAAK7C,QAAQoB,cAAclB,aAAa4C,gBAAgB;AACzF,kBAAMD,SAASE,aAAaN,aAAaC,UAAU,CAAA;UACrD;UACAR,YAAY;YACVC,OAAO;cAAC;cAAuB;gBAAEC,IAAI9B,KAAKD;cAAG;;YAC7CgC,MAAM;YACNW,YAAY;cACVC,OAAO;cACPC,SAAS;YACX;UACF;QACF;;IAEJ,CAAA,GACOX,iBAAU,MAAM,CAAA,CAAE,CAAA,CAAA;EAGjC,CAAA;CACD;",
6
- "names": ["Rx", "Function", "Option", "Capabilities", "contributes", "createIntent", "ClientCapabilities", "ATTENDABLE_PATH_SEPARATOR", "DECK_COMPANION_TYPE", "ROOT_ID", "createExtension", "rxFromSignal", "parseId", "context", "contributes", "Capabilities", "AppGraphBuilder", "createExtension", "id", "meta", "connector", "node", "Rx", "make", "get", "pipe", "flatMap", "ROOT_ID", "some", "none", "map", "workspace", "rxFromSignal", "getCapability", "Layout", "client", "ClientCapabilities", "Client", "spaceId", "parseId", "space", "spaces", "join", "ATTENDABLE_PATH_SEPARATOR", "type", "DECK_COMPANION_TYPE", "data", "properties", "label", "ns", "icon", "disposition", "getOrElse", "actions", "SearchAction", "OpenSearch", "_tag", "dispatchPromise", "dispatch", "IntentDispatcher", "createIntent", "keyBinding", "macos", "windows"]
7
- }