@dxos/plugin-search 0.8.4-main.b97322e → 0.8.4-main.bc2380dfbc

package/src/hooks/useGlobalSearch.tsx

@@ -2,12 +2,18 @@
 // Copyright 2023 DXOS.org
 //
 
-import React, { createContext, type PropsWithChildren, useContext, useMemo, useState } from 'react';
+import React, { type PropsWithChildren, createContext, useCallback, useContext, useState } from 'react';
 
 import { raise } from '@dxos/debug';
+import { type Entity } from '@dxos/echo';
+import { GlobalFilterProvider } from '@dxos/react-ui-search';
+
+import { type SearchResult } from '#types';
 
 import { filterObjectsSync, queryStringToMatch } from './sync';
-import { type SearchResult } from '../types';
+
+// Re-export for backward compatibility.
+export { useGlobalFilteredObjects, GlobalFilterProvider } from '@dxos/react-ui-search';
 
 type SearchContextType = {
   match?: RegExp;
@@ -16,26 +22,40 @@ type SearchContextType = {
 
 const SearchContext = createContext<SearchContextType>({});
 
+/**
+ * Provider for global search context.
+ * Also provides the GlobalFilterProvider for useGlobalFilteredObjects to work.
+ */
 export const SearchContextProvider = ({ children }: PropsWithChildren) => {
   const [match, setMatch] = useState<RegExp>();
   const handleMatch = (text?: string) => setMatch(queryStringToMatch(text));
-  return <SearchContext.Provider value={{ match, setMatch: handleMatch }}>{children}</SearchContext.Provider>;
+
+  // Provide a filter function for useGlobalFilteredObjects.
+  const filterFn = useCallback(
+    <T extends Entity.Any>(objects: T[]): T[] => {
+      if (!match) {
+        return objects;
+      }
+
+      return filterObjectsSync(objects, match)
+        .filter((result) => result.object)
+        .map((result) => result.object!);
+    },
+    [match],
+  );
+
+  return (
+    <SearchContext.Provider value={{ match, setMatch: handleMatch }}>
+      <GlobalFilterProvider filter={filterFn}>{children}</GlobalFilterProvider>
+    </SearchContext.Provider>
+  );
 };
 
 export const useGlobalSearch = () => {
   return useContext(SearchContext) ?? raise(new Error('Missing SearchContext.'));
 };
 
-export const useGlobalSearchResults = <T extends Record<string, any>>(objects?: T[]): SearchResult[] => {
+export const useGlobalSearchResults = <T extends Entity.Unknown>(objects?: T[]): SearchResult<T>[] => {
   const { match } = useGlobalSearch();
   return objects && match ? filterObjectsSync(objects, match) : [];
 };
-
-export const useGlobalFilteredObjects = <T extends Record<string, any>>(objects?: T[]): T[] => {
-  const { match } = useGlobalSearch();
-  if (!match || !objects) {
-    return objects ?? [];
-  }
-
-  return useMemo(() => filterObjectsSync(objects, match).map((result) => result.object), [objects, match]);
-};

package/src/hooks/useSearchResults.ts

@@ -5,12 +5,13 @@
 import { yieldOrContinue } from 'main-thread-scheduling';
 import { useEffect, useState } from 'react';
 
-import { DataType } from '@dxos/schema';
+import { type Entity } from '@dxos/echo';
+import { Text } from '@dxos/schema';
 
 // TODO(thure): Deprecate search-sync, move still-relevant utilities elsewhere (here, probably).
 import { mapObjectToTextFields, queryStringToMatch } from './sync';
 
-export const filterObjects = async <T extends Record<string, any>>(
+export const filterObjects = async <T extends Entity.Unknown>(
   objects: T[],
   match?: RegExp,
 ): Promise<Map<T, string[][]>> => {
@@ -18,9 +19,10 @@ export const filterObjects = async <T extends Record<string, any>>(
   if (!match) {
     return result;
   }
+
   await Promise.all(
     objects
-      .filter((object) => !(object instanceof DataType.Text))
+      .filter((object) => !(object instanceof Text.Text))
       .map(async (object) => {
         await yieldOrContinue('interactive');
         const fields = mapObjectToTextFields<T>(object);
@@ -34,10 +36,11 @@ export const filterObjects = async <T extends Record<string, any>>(
           });
       }),
   );
+
   return result;
 };
 
-export const useSearchResults = <T extends Record<string, any>>(
+export const useSearchResults = <T extends Entity.Unknown>(
   queryString?: string,
   objects?: T[],
   delay: number = 400,
@@ -47,14 +50,14 @@ export const useSearchResults = <T extends Record<string, any>>(
 
   useEffect(() => {
     setPending(!!(objects && queryString));
-    const timeoutId = setTimeout(async () => {
+    const timeout = setTimeout(async () => {
       const nextResults =
         objects && queryString ? await filterObjects(objects, queryStringToMatch(queryString)) : new Map();
       setResults(nextResults);
       setPending(false);
     }, delay);
 
-    return () => clearTimeout(timeoutId);
+    return () => clearTimeout(timeout);
   }, [queryString, objects]);
 
   return [pending, results];

package/src/hooks/useWebSearch.ts

@@ -2,45 +2,51 @@
 // Copyright 2025 DXOS.org
 //
 
-import { useState } from 'react';
+import { useCallback, useState } from 'react';
 
-import { EdgeAiServiceClient } from '@dxos/ai';
-import { AI_SERVICE_ENDPOINT, EXA_API_KEY } from '@dxos/ai/testing';
-import { Obj } from '@dxos/echo';
-import { type DXN } from '@dxos/keys';
+import { EXA_API_KEY } from '@dxos/ai/testing';
+import { Entity } from '@dxos/echo';
 import { log } from '@dxos/log';
 import { getIconAnnotation } from '@dxos/schema';
-import { Testing } from '@dxos/schema/testing';
+import { TestSchema } from '@dxos/schema/testing';
+
+import { type SearchResult } from '#types';
 
-import { getStringProperty } from './sync';
 import { search } from '../search';
-import { type SearchResult } from '../types';
+import { getStringProperty } from './sync';
 
-export const useWebSearch = ({ query, context }: { query?: string; context?: string }) => {
-  const AiService = new EdgeAiServiceClient({
-    endpoint: AI_SERVICE_ENDPOINT.REMOTE,
-  });
+export type UseWebSearchProps = {
+  query?: string;
+  context?: string;
+};
+
+export type UseWebSearch = {
+  update: () => Promise<void>;
+  results: SearchResult[];
+  isLoading: boolean;
+};
 
+/** @deprecated */
+// TODO(burdon): Remove testing deps.
+export const useWebSearch = ({ query, context }: UseWebSearchProps): UseWebSearch => {
   const [results, setResults] = useState<SearchResult[]>([]);
   const [isLoading, setIsLoading] = useState(false);
 
-  const runSearch = async () => {
+  const update = useCallback(async () => {
     try {
       setIsLoading(true);
       log.info('Running web search', { query, context });
       const results = await search({
         query,
         context,
-        schema: [Testing.Project, Testing.Organization, Testing.Contact],
-        AiService,
+        schema: [TestSchema.Person, TestSchema.Project, TestSchema.Organization], // TODO(burdon): ???
         exaApiKey: EXA_API_KEY,
       });
 
       const mappedResults = results.data.map((result): SearchResult => {
-        const schema = Obj.getSchema(result);
+        const schema = Entity.getSchema(result);
         return {
           id: result.id,
-          objectType: Obj.getTypename(result) as DXN.String | undefined,
           label: getStringProperty(result, ['name', 'title', 'label']),
           snippet: getStringProperty(result, ['description', 'content', 'website', 'email']),
           object: result,
@@ -52,7 +58,7 @@ export const useWebSearch = ({ query, context }: { query?: string; context?: str
     } finally {
       setIsLoading(false);
     }
-  };
+  }, [query, context]);
 
-  return { runSearch, results, isLoading };
+  return { update, results, isLoading };
 };

package/src/index.ts

@@ -2,8 +2,8 @@
 // Copyright 2023 DXOS.org
 //
 
+// TODO(wittjosiah): Hooks should not be exported from the plugin package at all.
+//   Either refactor callers to not need them or factor them out to a shared package.
 export * from './hooks';
 export * from './meta';
 export * from './types';
-
-export * from './SearchPlugin';

package/src/meta.ts

@@ -2,16 +2,19 @@
 // Copyright 2023 DXOS.org
 //
 
-import { type PluginMeta } from '@dxos/app-framework';
+import { type Plugin } from '@dxos/app-framework';
+import { trim } from '@dxos/util';
 
-export const SEARCH_PLUGIN = 'dxos.org/plugin/search';
-export const SEARCH_RESULT = `${SEARCH_PLUGIN}/result`;
-
-export const meta: PluginMeta = {
-  id: SEARCH_PLUGIN,
+export const meta: Plugin.Meta = {
+  id: 'org.dxos.plugin.search',
   name: 'Search',
-  description: 'Search ECHO spaces for content.',
+  description: trim`
+    Full-text search engine for finding content across all spaces and object types.
+    Quickly locate documents, tables, and other objects with instant results and relevance ranking.
+  `,
   icon: 'ph--magnifying-glass--regular',
   source: 'https://github.com/dxos/dxos/tree/main/packages/plugins/plugin-search',
   tags: ['labs'],
 };
+
+export const SEARCH_RESULT = `${meta.id}.result`;

package/src/operations/index.ts

@@ -0,0 +1,7 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import { OperationHandlerSet } from '@dxos/compute';
+
+export const SearchOperationHandlerSet = OperationHandlerSet.lazy(() => import('./open-search'));

package/src/operations/open-search.ts

@@ -0,0 +1,24 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import * as Effect from 'effect/Effect';
+
+import { LayoutOperation } from '@dxos/app-toolkit';
+import { Operation } from '@dxos/compute';
+
+import { SEARCH_DIALOG } from '../constants';
+import { SearchOperation } from '../types';
+
+const handler: Operation.WithHandler<typeof SearchOperation.OpenSearch> = SearchOperation.OpenSearch.pipe(
+  Operation.withHandler(
+    Effect.fnUntraced(function* () {
+      yield* Operation.invoke(LayoutOperation.UpdateDialog, {
+        subject: SEARCH_DIALOG,
+        blockAlign: 'start',
+      });
+    }),
+  ),
+);
+
+export default handler;

package/src/plugin.ts

@@ -0,0 +1,11 @@
+//
+// Copyright 2023 DXOS.org
+//
+
+import { Plugin } from '@dxos/app-framework';
+
+import { meta } from './meta';
+
+export const SearchPlugin = Plugin.lazy(meta, () => import('#plugin'));
+
+export { SearchOperationHandlerSet } from './operations';

package/src/search/exa.test.ts

@@ -5,9 +5,8 @@
 import { describe, test } from 'vitest';
 
 import { EXA_API_KEY } from '@dxos/ai/testing';
-import { todo } from '@dxos/debug';
 import { log } from '@dxos/log';
-import { Testing } from '@dxos/schema/testing';
+import { TestSchema } from '@dxos/schema/testing';
 
 import { search } from './exa';
 
@@ -16,8 +15,7 @@ describe.skip('Search', () => {
     test.skip('contacts', { timeout: 60_000 }, async () => {
       const objects = await search({
         query: 'top executives at google',
-        schema: [Testing.Contact],
-        AiService: null as any, // TODO: Implement AiService
+        schema: [TestSchema.Person],
         exaApiKey: EXA_API_KEY,
       });
 
@@ -27,8 +25,7 @@ describe.skip('Search', () => {
     test.skip('contacts projects and orgs', { timeout: 60_000 }, async () => {
       const objects = await search({
         query: 'top executives at google',
-        schema: [Testing.Contact, Testing.Project, Testing.Organization],
-        AiService: todo(),
+        schema: [TestSchema.Person, TestSchema.Project, TestSchema.Organization],
         exaApiKey: EXA_API_KEY,
       });
 
@@ -38,8 +35,7 @@ describe.skip('Search', () => {
     test('a19z org, projects they invest in and team', { timeout: 60_000 }, async () => {
       const objects = await search({
         query: 'a19z org, projects they invest in and team',
-        schema: [Testing.Project, Testing.Organization, Testing.Contact],
-        AiService: todo(),
+        schema: [TestSchema.Project, TestSchema.Organization, TestSchema.Person],
         exaApiKey: EXA_API_KEY,
       });
 
@@ -49,8 +45,7 @@ describe.skip('Search', () => {
     test('companies building CRDTs', { timeout: 60_000 }, async () => {
       const objects = await search({
         query: 'companies building CRDTs',
-        schema: [Testing.Project, Testing.Organization, Testing.Contact],
-        AiService: todo(),
+        schema: [TestSchema.Project, TestSchema.Organization, TestSchema.Person],
         exaApiKey: EXA_API_KEY,
       });
 
@@ -62,8 +57,7 @@ describe.skip('Search', () => {
     test('composer context-based search', { timeout: 60_000 }, async () => {
       const objects = await search({
         context: COMPOSER_DXOS_DOC,
-        schema: [Testing.Project, Testing.Organization, Testing.Contact],
-        AiService: todo(),
+        schema: [TestSchema.Project, TestSchema.Organization, TestSchema.Person],
         exaApiKey: EXA_API_KEY,
       });
 
@@ -73,8 +67,7 @@ describe.skip('Search', () => {
     test.only('edge architecture', { timeout: 60_000 }, async () => {
       const objects = await search({
         context: EDGE_ARCHITECTURE_DOC,
-        schema: [Testing.Project, Testing.Organization, Testing.Contact],
-        AiService: todo(),
+        schema: [TestSchema.Project, TestSchema.Organization, TestSchema.Person],
         exaApiKey: EXA_API_KEY,
       });
 
@@ -83,9 +76,7 @@ describe.skip('Search', () => {
   });
 });
 
-// TODO(dmaretskyi): Import as txt.
 const COMPOSER_DXOS_DOC = `
-
 ![img](https://dxos.network/dxos-logotype-blue.png)
 # Welcome to Composer by DXOS
 
@@ -93,7 +84,7 @@ const COMPOSER_DXOS_DOC = `
 
 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.
 
-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.
+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.
 
 ## Disclaimer
 
@@ -219,6 +210,4 @@ const EDGE_ARCHITECTURE_DOC = `
 - given the fq id of the deployment object, anyone in the space should be able to invoke the function even if they don't have access to the object itself
 
 ### Service Side
-
-
 `;