@dxos/plugin-search 0.9.0 → 0.9.1-main.c7dcc2e112
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/lib/neutral/{SearchDialog-IFMA5UP5.mjs → SearchDialog-Z3TXJ55M.mjs} +4 -4
- package/dist/lib/neutral/SearchDialog-Z3TXJ55M.mjs.map +7 -0
- package/dist/lib/neutral/SearchPlugin.mjs +1 -1
- package/dist/lib/neutral/{app-graph-builder-ADB5LBS5.mjs → app-graph-builder-26EBAR52.mjs} +5 -5
- package/dist/lib/neutral/app-graph-builder-26EBAR52.mjs.map +7 -0
- package/dist/lib/neutral/capabilities/index.mjs +2 -2
- package/dist/lib/neutral/chunk-2JPRW3GN.mjs +50 -0
- package/dist/lib/neutral/chunk-2JPRW3GN.mjs.map +7 -0
- package/dist/lib/neutral/{chunk-GT3AGVU6.mjs → chunk-BODTE4FK.mjs} +2 -2
- package/dist/lib/neutral/chunk-BODTE4FK.mjs.map +7 -0
- package/dist/lib/neutral/{chunk-TN4G3MZZ.mjs → chunk-E2F6MF44.mjs} +2 -2
- package/dist/lib/neutral/{chunk-2XHA22US.mjs → chunk-H4PKSTAJ.mjs} +2 -2
- package/dist/lib/neutral/{chunk-2XHA22US.mjs.map → chunk-H4PKSTAJ.mjs.map} +3 -3
- package/dist/lib/neutral/{chunk-BST37VRI.mjs → chunk-P6LRQZVR.mjs} +3 -3
- package/dist/lib/neutral/chunk-P6LRQZVR.mjs.map +7 -0
- package/dist/lib/neutral/components/index.mjs +7 -5
- package/dist/lib/neutral/components/index.mjs.map +3 -3
- package/dist/lib/neutral/containers/index.mjs +1 -1
- package/dist/lib/neutral/index.mjs +2 -2
- package/dist/lib/neutral/meta.json +1 -1
- package/dist/lib/neutral/meta.mjs +1 -1
- package/dist/lib/neutral/{open-search-Y6OUELN3.mjs → open-search-STQH3TXW.mjs} +3 -3
- package/dist/lib/neutral/operations/index.mjs +1 -1
- package/dist/lib/neutral/plugin.mjs +2 -2
- package/dist/lib/neutral/{react-surface-3IXL3EOJ.mjs → react-surface-VQXLVMC2.mjs} +4 -5
- package/dist/lib/neutral/react-surface-VQXLVMC2.mjs.map +7 -0
- package/dist/lib/neutral/testing.mjs +1 -1
- package/dist/lib/neutral/translations.mjs +1 -1
- package/dist/lib/neutral/translations.mjs.map +3 -3
- package/dist/lib/neutral/types/index.mjs +1 -1
- package/dist/types/dx.config.d.ts +28 -0
- package/dist/types/dx.config.d.ts.map +1 -0
- package/dist/types/src/capabilities/index.d.ts +2 -2
- package/dist/types/src/capabilities/index.d.ts.map +1 -1
- package/dist/types/src/capabilities/react-surface.d.ts +2 -2
- package/dist/types/src/capabilities/react-surface.d.ts.map +1 -1
- package/dist/types/src/constants.d.ts.map +1 -1
- package/dist/types/src/meta.d.ts +28 -2
- package/dist/types/src/meta.d.ts.map +1 -1
- package/dist/types/tsconfig.tsbuildinfo +1 -1
- package/dx.config.ts +36 -0
- package/package.json +31 -30
- package/src/SearchPlugin.tsx +1 -1
- package/src/capabilities/app-graph-builder.ts +4 -4
- package/src/capabilities/react-surface.tsx +3 -4
- package/src/components/SearchResultStack/SearchResultStack.tsx +9 -12
- package/src/constants.ts +1 -1
- package/src/containers/SearchDialog/SearchDialog.tsx +3 -3
- package/src/meta.ts +3 -30
- package/src/translations.ts +1 -1
- package/src/types/SearchOperation.ts +1 -1
- package/dist/lib/neutral/SearchDialog-IFMA5UP5.mjs.map +0 -7
- package/dist/lib/neutral/app-graph-builder-ADB5LBS5.mjs.map +0 -7
- package/dist/lib/neutral/chunk-BST37VRI.mjs.map +0 -7
- package/dist/lib/neutral/chunk-GT3AGVU6.mjs.map +0 -7
- package/dist/lib/neutral/chunk-Q2F6YOOZ.mjs +0 -41
- package/dist/lib/neutral/chunk-Q2F6YOOZ.mjs.map +0 -7
- package/dist/lib/neutral/react-surface-3IXL3EOJ.mjs.map +0 -7
- /package/dist/lib/neutral/{chunk-TN4G3MZZ.mjs.map → chunk-E2F6MF44.mjs.map} +0 -0
- /package/dist/lib/neutral/{open-search-Y6OUELN3.mjs.map → open-search-STQH3TXW.mjs.map} +0 -0
package/dx.config.ts
ADDED
|
@@ -0,0 +1,36 @@
|
|
|
1
|
+
//
|
|
2
|
+
// Copyright 2025 DXOS.org
|
|
3
|
+
//
|
|
4
|
+
|
|
5
|
+
import { Config2 } from '@dxos/app-framework/config';
|
|
6
|
+
import { trim } from '@dxos/util';
|
|
7
|
+
|
|
8
|
+
export default Config2.make({
|
|
9
|
+
plugin: {
|
|
10
|
+
key: 'org.dxos.plugin.search',
|
|
11
|
+
name: 'Search',
|
|
12
|
+
author: 'DXOS',
|
|
13
|
+
description: trim`
|
|
14
|
+
Full-text search engine for finding content across all spaces and object types in DXOS Composer.
|
|
15
|
+
The plugin provides a global command-palette style dialog (invoked via the OpenSearch operation)
|
|
16
|
+
that debounces user input and matches it against every field of every ECHO object in the active
|
|
17
|
+
space, returning ranked results with field-level match context.
|
|
18
|
+
|
|
19
|
+
A persistent SearchArticle panel can be pinned in the deck companion sidebar so the query stays
|
|
20
|
+
visible while navigating documents. Both surfaces share a SearchContextProvider that drives the
|
|
21
|
+
GlobalFilterProvider, allowing any view that uses useGlobalFilteredObjects to automatically show
|
|
22
|
+
only the objects matching the current query.
|
|
23
|
+
|
|
24
|
+
Web search is available through the Exa integration: when an API key is configured, the plugin
|
|
25
|
+
can fetch and rank external web results alongside local objects. The results are structured with
|
|
26
|
+
URL, title, and snippet fields ready for use in Composer documents.
|
|
27
|
+
|
|
28
|
+
All search operations are registered through the standard DXOS operations system and can be
|
|
29
|
+
wired into keyboard shortcuts, command palettes, and AI assistants via the OperationHandlerSet.
|
|
30
|
+
`,
|
|
31
|
+
icon: { key: 'ph--magnifying-glass--regular', hue: 'rose' },
|
|
32
|
+
source: 'https://github.com/dxos/dxos/tree/main/packages/plugins/plugin-search',
|
|
33
|
+
spec: 'PLUGIN.mdl',
|
|
34
|
+
tags: ['labs'],
|
|
35
|
+
},
|
|
36
|
+
});
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@dxos/plugin-search",
|
|
3
|
-
"version": "0.9.
|
|
3
|
+
"version": "0.9.1-main.c7dcc2e112",
|
|
4
4
|
"description": "Search plugin",
|
|
5
5
|
"homepage": "https://dxos.org",
|
|
6
6
|
"bugs": "https://github.com/dxos/dxos/issues",
|
|
@@ -85,32 +85,33 @@
|
|
|
85
85
|
"types": "dist/types/src/index.d.ts",
|
|
86
86
|
"files": [
|
|
87
87
|
"dist",
|
|
88
|
+
"dx.config.ts",
|
|
88
89
|
"src",
|
|
89
90
|
"PLUGIN.mdl"
|
|
90
91
|
],
|
|
91
92
|
"dependencies": {
|
|
92
93
|
"main-thread-scheduling": "^14.1.1",
|
|
93
|
-
"@dxos/ai": "0.9.
|
|
94
|
-
"@dxos/app-toolkit": "0.9.
|
|
95
|
-
"@dxos/
|
|
96
|
-
"@dxos/app-framework": "0.9.
|
|
97
|
-
"@dxos/echo": "0.9.
|
|
98
|
-
"@dxos/echo-protocol": "0.9.
|
|
99
|
-
"@dxos/
|
|
100
|
-
"@dxos/
|
|
101
|
-
"@dxos/
|
|
102
|
-
"@dxos/
|
|
103
|
-
"@dxos/
|
|
104
|
-
"@dxos/
|
|
105
|
-
"@dxos/
|
|
106
|
-
"@dxos/react-ui-
|
|
107
|
-
"@dxos/
|
|
108
|
-
"@dxos/react-ui-
|
|
109
|
-
"@dxos/
|
|
110
|
-
"@dxos/react-ui-
|
|
111
|
-
"@dxos/types": "0.9.
|
|
112
|
-
"@dxos/
|
|
113
|
-
"@dxos/
|
|
94
|
+
"@dxos/ai": "0.9.1-main.c7dcc2e112",
|
|
95
|
+
"@dxos/app-toolkit": "0.9.1-main.c7dcc2e112",
|
|
96
|
+
"@dxos/compute": "0.9.1-main.c7dcc2e112",
|
|
97
|
+
"@dxos/app-framework": "0.9.1-main.c7dcc2e112",
|
|
98
|
+
"@dxos/echo": "0.9.1-main.c7dcc2e112",
|
|
99
|
+
"@dxos/echo-protocol": "0.9.1-main.c7dcc2e112",
|
|
100
|
+
"@dxos/debug": "0.9.1-main.c7dcc2e112",
|
|
101
|
+
"@dxos/effect": "0.9.1-main.c7dcc2e112",
|
|
102
|
+
"@dxos/invariant": "0.9.1-main.c7dcc2e112",
|
|
103
|
+
"@dxos/keys": "0.9.1-main.c7dcc2e112",
|
|
104
|
+
"@dxos/log": "0.9.1-main.c7dcc2e112",
|
|
105
|
+
"@dxos/plugin-graph": "0.9.1-main.c7dcc2e112",
|
|
106
|
+
"@dxos/react-ui-attention": "0.9.1-main.c7dcc2e112",
|
|
107
|
+
"@dxos/react-ui-menu": "0.9.1-main.c7dcc2e112",
|
|
108
|
+
"@dxos/plugin-client": "0.9.1-main.c7dcc2e112",
|
|
109
|
+
"@dxos/react-ui-search": "0.9.1-main.c7dcc2e112",
|
|
110
|
+
"@dxos/schema": "0.9.1-main.c7dcc2e112",
|
|
111
|
+
"@dxos/react-ui-mosaic": "0.9.1-main.c7dcc2e112",
|
|
112
|
+
"@dxos/types": "0.9.1-main.c7dcc2e112",
|
|
113
|
+
"@dxos/util": "0.9.1-main.c7dcc2e112",
|
|
114
|
+
"@dxos/react-client": "0.9.1-main.c7dcc2e112"
|
|
114
115
|
},
|
|
115
116
|
"devDependencies": {
|
|
116
117
|
"@effect-atom/atom-react": "^0.5.0",
|
|
@@ -121,12 +122,12 @@
|
|
|
121
122
|
"react": "~19.2.3",
|
|
122
123
|
"react-dom": "~19.2.3",
|
|
123
124
|
"vite": "^8.0.16",
|
|
124
|
-
"@dxos/plugin-preview": "0.9.
|
|
125
|
-
"@dxos/plugin-testing": "0.9.
|
|
126
|
-
"@dxos/react-ui": "0.9.
|
|
127
|
-
"@dxos/
|
|
128
|
-
"@dxos/
|
|
129
|
-
"@dxos/
|
|
125
|
+
"@dxos/plugin-preview": "0.9.1-main.c7dcc2e112",
|
|
126
|
+
"@dxos/plugin-testing": "0.9.1-main.c7dcc2e112",
|
|
127
|
+
"@dxos/react-ui": "0.9.1-main.c7dcc2e112",
|
|
128
|
+
"@dxos/ui-theme": "0.9.1-main.c7dcc2e112",
|
|
129
|
+
"@dxos/random": "0.9.1-main.c7dcc2e112",
|
|
130
|
+
"@dxos/storybook-utils": "0.9.1-main.c7dcc2e112"
|
|
130
131
|
},
|
|
131
132
|
"peerDependencies": {
|
|
132
133
|
"@effect-atom/atom-react": "^0.5.0",
|
|
@@ -134,8 +135,8 @@
|
|
|
134
135
|
"effect": "3.21.3",
|
|
135
136
|
"react": "~19.2.3",
|
|
136
137
|
"react-dom": "~19.2.3",
|
|
137
|
-
"@dxos/ui
|
|
138
|
-
"@dxos/
|
|
138
|
+
"@dxos/react-ui": "0.9.1-main.c7dcc2e112",
|
|
139
|
+
"@dxos/ui-theme": "0.9.1-main.c7dcc2e112"
|
|
139
140
|
},
|
|
140
141
|
"publishConfig": {
|
|
141
142
|
"access": "public"
|
package/src/SearchPlugin.tsx
CHANGED
|
@@ -18,7 +18,7 @@ export const SearchPlugin = Plugin.define(meta).pipe(
|
|
|
18
18
|
AppPlugin.addSurfaceModule({ activate: ReactSurface }),
|
|
19
19
|
AppPlugin.addTranslationsModule({ translations }),
|
|
20
20
|
AppPlugin.addPluginAssetModule({
|
|
21
|
-
asset: { pluginId: meta.
|
|
21
|
+
asset: { pluginId: meta.profile.key, path: 'PLUGIN.mdl', content: pluginSpec, mimeType: 'application/x-mdl' },
|
|
22
22
|
}),
|
|
23
23
|
Plugin.make,
|
|
24
24
|
);
|
|
@@ -5,7 +5,7 @@
|
|
|
5
5
|
import * as Effect from 'effect/Effect';
|
|
6
6
|
|
|
7
7
|
import { Capability } from '@dxos/app-framework';
|
|
8
|
-
import { AppCapabilities, AppNode,
|
|
8
|
+
import { AppCapabilities, AppNode, Paths } from '@dxos/app-toolkit';
|
|
9
9
|
import { Operation } from '@dxos/compute';
|
|
10
10
|
import { ClientCapabilities } from '@dxos/plugin-client';
|
|
11
11
|
import { GraphBuilder, NodeMatcher } from '@dxos/plugin-graph';
|
|
@@ -24,13 +24,13 @@ export default Capability.makeModule(
|
|
|
24
24
|
const client = yield* Capability.get(ClientCapabilities.Client);
|
|
25
25
|
const layoutAtom = get(yield* Capability.atom(AppCapabilities.Layout))[0];
|
|
26
26
|
const layout = layoutAtom ? get(layoutAtom) : undefined;
|
|
27
|
-
const spaceId = layout?.workspace ? getSpaceIdFromPath(layout.workspace) : undefined;
|
|
27
|
+
const spaceId = layout?.workspace ? Paths.getSpaceIdFromPath(layout.workspace) : undefined;
|
|
28
28
|
const space = spaceId ? client.spaces.get(spaceId) : null;
|
|
29
29
|
|
|
30
30
|
return [
|
|
31
31
|
AppNode.makeDeckCompanion({
|
|
32
32
|
id: linkedSegment('search'),
|
|
33
|
-
label: ['search.label', { ns: meta.
|
|
33
|
+
label: ['search.label', { ns: meta.profile.key }],
|
|
34
34
|
icon: 'ph--magnifying-glass--regular',
|
|
35
35
|
data: space,
|
|
36
36
|
}),
|
|
@@ -49,7 +49,7 @@ export default Capability.makeModule(
|
|
|
49
49
|
return false;
|
|
50
50
|
}),
|
|
51
51
|
properties: {
|
|
52
|
-
label: ['search-action.label', { ns: meta.
|
|
52
|
+
label: ['search-action.label', { ns: meta.profile.key }],
|
|
53
53
|
icon: 'ph--magnifying-glass--regular',
|
|
54
54
|
keyBinding: {
|
|
55
55
|
macos: 'shift+meta+f',
|
|
@@ -8,7 +8,7 @@ import React, { type ComponentProps } from 'react';
|
|
|
8
8
|
import { Capabilities, Capability } from '@dxos/app-framework';
|
|
9
9
|
import { Surface } from '@dxos/app-framework/ui';
|
|
10
10
|
import { AppSurface, useActiveSpace } from '@dxos/app-toolkit/ui';
|
|
11
|
-
import {
|
|
11
|
+
import { isSpace } from '@dxos/react-client/echo';
|
|
12
12
|
|
|
13
13
|
import { SearchArticle, SearchDialog } from '#containers';
|
|
14
14
|
import { SearchContextProvider } from '#hooks';
|
|
@@ -36,7 +36,7 @@ export default Capability.makeModule(() =>
|
|
|
36
36
|
}),
|
|
37
37
|
Surface.create({
|
|
38
38
|
id: `${SEARCH_DIALOG}.searchInput`,
|
|
39
|
-
|
|
39
|
+
filter: Surface.makeFilter(AppSurface.SearchInput),
|
|
40
40
|
component: () => {
|
|
41
41
|
const space = useActiveSpace();
|
|
42
42
|
if (!space) {
|
|
@@ -52,8 +52,7 @@ export default Capability.makeModule(() =>
|
|
|
52
52
|
}),
|
|
53
53
|
Surface.create({
|
|
54
54
|
id: `${SEARCH_DIALOG}.search`,
|
|
55
|
-
|
|
56
|
-
filter: (data): data is { subject: Space } => isSpace(data.subject),
|
|
55
|
+
filter: AppSurface.subject(AppSurface.deckCompanion('search'), isSpace),
|
|
57
56
|
component: ({ data }) => {
|
|
58
57
|
const space = data.subject;
|
|
59
58
|
if (!space) {
|
|
@@ -7,7 +7,7 @@ import React, { type KeyboardEvent, forwardRef, useCallback, useMemo, useState }
|
|
|
7
7
|
import { Surface } from '@dxos/app-framework/ui';
|
|
8
8
|
import { AppSurface, useObjectMenuItems } from '@dxos/app-toolkit/ui';
|
|
9
9
|
import { Entity } from '@dxos/echo';
|
|
10
|
-
import { Card,
|
|
10
|
+
import { Card, IconButton } from '@dxos/react-ui';
|
|
11
11
|
import { ScrollArea } from '@dxos/react-ui';
|
|
12
12
|
import { composable, composableProps } from '@dxos/react-ui';
|
|
13
13
|
import { Menu } from '@dxos/react-ui-menu';
|
|
@@ -94,19 +94,16 @@ const SearchResultTile = forwardRef<HTMLDivElement, SearchResultTileProps>(
|
|
|
94
94
|
<Focus.Item asChild current={current} onCurrentChange={handleCurrentChange}>
|
|
95
95
|
<Card.Root ref={forwardedRef} role='button' classNames='cursor-pointer'>
|
|
96
96
|
<Card.Header>
|
|
97
|
-
<Card.
|
|
97
|
+
<Card.Block />
|
|
98
98
|
<Card.Title>{result.label ?? (result.object && Entity.getLabel(result.object))}</Card.Title>
|
|
99
|
-
<
|
|
100
|
-
<
|
|
101
|
-
iconOnly
|
|
102
|
-
|
|
103
|
-
|
|
104
|
-
|
|
105
|
-
/>
|
|
106
|
-
</Menu.Trigger>
|
|
107
|
-
<Menu.Content items={menuItems} />
|
|
99
|
+
<Card.Block end>
|
|
100
|
+
<Menu.Trigger asChild disabled={!menuItems?.length}>
|
|
101
|
+
<IconButton iconOnly variant='ghost' icon='ph--dots-three-vertical--regular' label='Actions' />
|
|
102
|
+
</Menu.Trigger>
|
|
103
|
+
<Menu.Content items={menuItems} />
|
|
104
|
+
</Card.Block>
|
|
108
105
|
</Card.Header>
|
|
109
|
-
<Surface.Surface type={AppSurface.
|
|
106
|
+
<Surface.Surface type={AppSurface.CardContent} data={{ subject: result.object }} limit={1} />
|
|
110
107
|
</Card.Root>
|
|
111
108
|
</Focus.Item>
|
|
112
109
|
</Mosaic.Tile>
|
package/src/constants.ts
CHANGED
|
@@ -5,7 +5,7 @@
|
|
|
5
5
|
import React, { useCallback, useMemo, useState } from 'react';
|
|
6
6
|
|
|
7
7
|
import { useOperationInvoker } from '@dxos/app-framework/ui';
|
|
8
|
-
import {
|
|
8
|
+
import { LayoutOperation, Paths } from '@dxos/app-toolkit';
|
|
9
9
|
import { type AppSurface } from '@dxos/app-toolkit/ui';
|
|
10
10
|
import { useLayout } from '@dxos/app-toolkit/ui';
|
|
11
11
|
import { Entity, Filter, Obj, Query } from '@dxos/echo';
|
|
@@ -23,7 +23,7 @@ export type SearchDialogProps = AppSurface.SpaceArticleProps<{
|
|
|
23
23
|
}>;
|
|
24
24
|
|
|
25
25
|
export const SearchDialog = ({ space, pivotId: pivotIdProp }: SearchDialogProps) => {
|
|
26
|
-
const { t } = useTranslation(meta.
|
|
26
|
+
const { t } = useTranslation(meta.profile.key);
|
|
27
27
|
const { invokePromise } = useOperationInvoker();
|
|
28
28
|
const { setMatch } = useGlobalSearch();
|
|
29
29
|
const layout = useLayout();
|
|
@@ -53,7 +53,7 @@ export const SearchDialog = ({ space, pivotId: pivotIdProp }: SearchDialogProps)
|
|
|
53
53
|
return;
|
|
54
54
|
}
|
|
55
55
|
|
|
56
|
-
const qualifiedPath = getObjectPathFromObject(result.object);
|
|
56
|
+
const qualifiedPath = Paths.getObjectPathFromObject(result.object);
|
|
57
57
|
await invokePromise(LayoutOperation.UpdateDialog, { state: false });
|
|
58
58
|
await invokePromise(LayoutOperation.Open, {
|
|
59
59
|
subject: [qualifiedPath],
|
package/src/meta.ts
CHANGED
|
@@ -3,36 +3,9 @@
|
|
|
3
3
|
//
|
|
4
4
|
|
|
5
5
|
import { Plugin } from '@dxos/app-framework';
|
|
6
|
-
import { DXN } from '@dxos/keys';
|
|
7
|
-
import { trim } from '@dxos/util';
|
|
8
6
|
|
|
9
|
-
|
|
10
|
-
key: DXN.make('org.dxos.plugin.search'),
|
|
11
|
-
name: 'Search',
|
|
12
|
-
author: 'DXOS',
|
|
13
|
-
description: trim`
|
|
14
|
-
Full-text search engine for finding content across all spaces and object types in DXOS Composer.
|
|
15
|
-
The plugin provides a global command-palette style dialog (invoked via the OpenSearch operation)
|
|
16
|
-
that debounces user input and matches it against every field of every ECHO object in the active
|
|
17
|
-
space, returning ranked results with field-level match context.
|
|
7
|
+
import config from '../dx.config';
|
|
18
8
|
|
|
19
|
-
|
|
20
|
-
visible while navigating documents. Both surfaces share a SearchContextProvider that drives the
|
|
21
|
-
GlobalFilterProvider, allowing any view that uses useGlobalFilteredObjects to automatically show
|
|
22
|
-
only the objects matching the current query.
|
|
9
|
+
export const meta = Plugin.getMetaFromConfig(config);
|
|
23
10
|
|
|
24
|
-
|
|
25
|
-
can fetch and rank external web results alongside local objects. The results are structured with
|
|
26
|
-
URL, title, and snippet fields ready for use in Composer documents.
|
|
27
|
-
|
|
28
|
-
All search operations are registered through the standard DXOS operations system and can be
|
|
29
|
-
wired into keyboard shortcuts, command palettes, and AI assistants via the OperationHandlerSet.
|
|
30
|
-
`,
|
|
31
|
-
icon: 'ph--magnifying-glass--regular',
|
|
32
|
-
iconHue: 'rose',
|
|
33
|
-
source: 'https://github.com/dxos/dxos/tree/main/packages/plugins/plugin-search',
|
|
34
|
-
spec: 'PLUGIN.mdl',
|
|
35
|
-
tags: ['labs'],
|
|
36
|
-
});
|
|
37
|
-
|
|
38
|
-
export const SEARCH_RESULT = `${meta.id}.result`;
|
|
11
|
+
export const SEARCH_RESULT = `${meta.profile.key}.result`;
|
package/src/translations.ts
CHANGED
|
@@ -11,7 +11,7 @@ import { DXN } from '@dxos/keys';
|
|
|
11
11
|
|
|
12
12
|
import { meta } from '#meta';
|
|
13
13
|
|
|
14
|
-
const makeKey = (name: string) => DXN.make(`${meta.
|
|
14
|
+
const makeKey = (name: string) => DXN.make(`${meta.profile.key}.operation.${name}`);
|
|
15
15
|
|
|
16
16
|
export const OpenSearch = Operation.make({
|
|
17
17
|
meta: { key: makeKey('openSearch'), name: 'Open Search', icon: 'ph--magnifying-glass--regular' },
|
|
@@ -1,7 +0,0 @@
|
|
|
1
|
-
{
|
|
2
|
-
"version": 3,
|
|
3
|
-
"sources": ["../../../src/containers/SearchDialog/SearchDialog.tsx"],
|
|
4
|
-
"sourcesContent": ["//\n// Copyright 2024 DXOS.org\n//\n\nimport React, { useCallback, useMemo, useState } from 'react';\n\nimport { useOperationInvoker } from '@dxos/app-framework/ui';\nimport { getObjectPathFromObject, LayoutOperation } from '@dxos/app-toolkit';\nimport { type AppSurface } from '@dxos/app-toolkit/ui';\nimport { useLayout } from '@dxos/app-toolkit/ui';\nimport { Entity, Filter, Obj, Query } from '@dxos/echo';\nimport { useQuery } from '@dxos/react-client/echo';\nimport { Dialog, useTranslation } from '@dxos/react-ui';\nimport { SearchList } from '@dxos/react-ui-search';\nimport { Text } from '@dxos/schema';\n\nimport { useGlobalSearch, useGlobalSearchResults } from '#hooks';\nimport { meta } from '#meta';\nimport { type SearchResult } from '#types';\n\nexport type SearchDialogProps = AppSurface.SpaceArticleProps<{\n pivotId?: string;\n}>;\n\nexport const SearchDialog = ({ space, pivotId: pivotIdProp }: SearchDialogProps) => {\n const { t } = useTranslation(meta.id);\n const { invokePromise } = useOperationInvoker();\n const { setMatch } = useGlobalSearch();\n const layout = useLayout();\n const pivotId = pivotIdProp ?? layout.active[layout.active.length - 1];\n const [query, setQuery] = useState<string>();\n\n // TODO(burdon): Re-enable full-text search when indexer is available in all environments.\n const objects = useQuery(\n space?.db,\n query === undefined ? Query.select(Filter.nothing()) : Query.select(Filter.not(Filter.type(Text.Text))),\n );\n\n const results = useGlobalSearchResults(objects);\n const allResults = useMemo(() => results.filter(({ object }) => object && Entity.getLabel(object)), [results]);\n\n const handleSearch = useCallback(\n (text: string) => {\n setQuery(text);\n setMatch?.(text);\n },\n [setMatch],\n );\n\n const handleSelect = useCallback(\n async (result: SearchResult) => {\n if (!result.object || !Obj.isObject(result.object)) {\n return;\n }\n\n const qualifiedPath = getObjectPathFromObject(result.object);\n await invokePromise(LayoutOperation.UpdateDialog, { state: false });\n await invokePromise(LayoutOperation.Open, {\n subject: [qualifiedPath],\n pivotId,\n positioning: 'end',\n });\n },\n [pivotId, invokePromise],\n );\n\n return (\n <Dialog.Content>\n <Dialog.Header>\n <Dialog.Title>{t('search-dialog.title')}</Dialog.Title>\n <Dialog.Close asChild>\n <Dialog.ActionIconButton action='close' />\n </Dialog.Close>\n </Dialog.Header>\n <SearchList.Root onSearch={handleSearch}>\n <SearchList.Input classNames='px-0' autoFocus placeholder={t('search.placeholder')} />\n <SearchList.Viewport classNames='max-h-[24rem]'>\n {allResults.map((result) => (\n <SearchList.Item\n key={result.id}\n classNames='flex gap-2 items-center'\n value={result.id}\n label={result.label ?? (result.object ? Entity.getLabel(result.object) : undefined) ?? result.id}\n icon={result.icon}\n onSelect={() => void handleSelect(result)}\n />\n ))}\n {query && allResults.length === 0 && <SearchList.Empty />}\n </SearchList.Viewport>\n </SearchList.Root>\n </Dialog.Content>\n );\n};\n"],
|
|
5
|
-
"mappings": ";;;AAIA,OAAOA,SAASC,aAAaC,SAASC,gBAAgB;AAEtD,SAASC,2BAA2B;AACpC,SAASC,yBAAyBC,uBAAuB;AAEzD,SAASC,iBAAiB;AAC1B,SAASC,QAAQC,QAAQC,KAAKC,aAAa;AAC3C,SAASC,gBAAgB;AACzB,SAASC,QAAQC,sBAAsB;AACvC,SAASC,kBAAkB;AAC3B,SAASC,YAAY;AAErB,SAASC,iBAAiBC,8BAA8B;AACxD,SAASC,YAAY;AAOd,IAAMC,eAAe,CAAC,EAAEC,OAAOC,SAASC,YAAW,MAAqB;AAC7E,QAAM,EAAEC,EAAC,IAAKV,eAAeK,KAAKM,EAAE;AACpC,QAAM,EAAEC,cAAa,IAAKtB,oBAAAA;AAC1B,QAAM,EAAEuB,SAAQ,IAAKV,gBAAAA;AACrB,QAAMW,SAASrB,UAAAA;AACf,QAAMe,UAAUC,eAAeK,OAAOC,OAAOD,OAAOC,OAAOC,SAAS,CAAA;AACpE,QAAM,CAACC,OAAOC,QAAAA,IAAY7B,SAAAA;AAG1B,QAAM8B,UAAUrB,SACdS,OAAOa,IACPH,UAAUI,SAAYxB,MAAMyB,OAAO3B,OAAO4B,QAAO,CAAA,IAAM1B,MAAMyB,OAAO3B,OAAO6B,IAAI7B,OAAO8B,KAAKvB,KAAKA,IAAI,CAAA,CAAA,CAAA;AAGtG,QAAMwB,UAAUtB,uBAAuBe,OAAAA;AACvC,QAAMQ,aAAavC,QAAQ,MAAMsC,QAAQE,OAAO,CAAC,EAAEC,OAAM,MAAOA,UAAUnC,OAAOoC,SAASD,MAAAA,CAAAA,GAAU;IAACH;GAAQ;AAE7G,QAAMK,eAAe5C,YACnB,CAAC6C,SAAAA;AACCd,aAASc,IAAAA;AACTnB,eAAWmB,IAAAA;EACb,GACA;IAACnB;GAAS;AAGZ,QAAMoB,eAAe9C,YACnB,OAAO+C,WAAAA;AACL,QAAI,CAACA,OAAOL,UAAU,CAACjC,IAAIuC,SAASD,OAAOL,MAAM,GAAG;AAClD;IACF;AAEA,UAAMO,gBAAgB7C,wBAAwB2C,OAAOL,MAAM;AAC3D,UAAMjB,cAAcpB,gBAAgB6C,cAAc;MAAEC,OAAO;IAAM,CAAA;AACjE,UAAM1B,cAAcpB,gBAAgB+C,MAAM;MACxCC,SAAS;QAACJ;;MACV5B;MACAiC,aAAa;IACf,CAAA;EACF,GACA;IAACjC;IAASI;GAAc;AAG1B,SACE,sBAAA,cAACb,OAAO2C,SAAO,MACb,sBAAA,cAAC3C,OAAO4C,QAAM,MACZ,sBAAA,cAAC5C,OAAO6C,OAAK,MAAElC,EAAE,qBAAA,CAAA,GACjB,sBAAA,cAACX,OAAO8C,OAAK;IAACC,SAAAA;KACZ,sBAAA,cAAC/C,OAAOgD,kBAAgB;IAACC,QAAO;QAGpC,sBAAA,cAAC/C,WAAWgD,MAAI;IAACC,UAAUnB;KACzB,sBAAA,cAAC9B,WAAWkD,OAAK;IAACC,YAAW;IAAOC,WAAAA;IAAUC,aAAa5C,EAAE,oBAAA;MAC7D,sBAAA,cAACT,WAAWsD,UAAQ;IAACH,YAAW;KAC7BzB,WAAW6B,IAAI,CAACtB,WACf,sBAAA,cAACjC,WAAWwD,MAAI;IACdC,KAAKxB,OAAOvB;IACZyC,YAAW;IACXO,OAAOzB,OAAOvB;IACdiD,OAAO1B,OAAO0B,UAAU1B,OAAOL,SAASnC,OAAOoC,SAASI,OAAOL,MAAM,IAAIR,WAAca,OAAOvB;IAC9FkD,MAAM3B,OAAO2B;IACbC,UAAU,MAAM,KAAK7B,aAAaC,MAAAA;OAGrCjB,SAASU,WAAWX,WAAW,KAAK,sBAAA,cAACf,WAAW8D,OAAK,IAAA,CAAA,CAAA,CAAA;AAKhE;",
|
|
6
|
-
"names": ["React", "useCallback", "useMemo", "useState", "useOperationInvoker", "getObjectPathFromObject", "LayoutOperation", "useLayout", "Entity", "Filter", "Obj", "Query", "useQuery", "Dialog", "useTranslation", "SearchList", "Text", "useGlobalSearch", "useGlobalSearchResults", "meta", "SearchDialog", "space", "pivotId", "pivotIdProp", "t", "id", "invokePromise", "setMatch", "layout", "active", "length", "query", "setQuery", "objects", "db", "undefined", "select", "nothing", "not", "type", "results", "allResults", "filter", "object", "getLabel", "handleSearch", "text", "handleSelect", "result", "isObject", "qualifiedPath", "UpdateDialog", "state", "Open", "subject", "positioning", "Content", "Header", "Title", "Close", "asChild", "ActionIconButton", "action", "Root", "onSearch", "Input", "classNames", "autoFocus", "placeholder", "Viewport", "map", "Item", "key", "value", "label", "icon", "onSelect", "Empty"]
|
|
7
|
-
}
|
|
@@ -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 * as Effect from 'effect/Effect';\n\nimport { Capability } from '@dxos/app-framework';\nimport { AppCapabilities, AppNode, getSpaceIdFromPath } from '@dxos/app-toolkit';\nimport { Operation } from '@dxos/compute';\nimport { ClientCapabilities } from '@dxos/plugin-client';\nimport { GraphBuilder, NodeMatcher } from '@dxos/plugin-graph';\nimport { linkedSegment } from '@dxos/react-ui-attention';\n\nimport { meta } from '#meta';\nimport { SearchOperation } from '#types';\n\nexport default Capability.makeModule(\n Effect.fnUntraced(function* () {\n const extensions = yield* Effect.all([\n GraphBuilder.createExtension({\n id: 'spaceSearch',\n match: NodeMatcher.whenRoot,\n connector: Effect.fnUntraced(function* (node, get) {\n const client = yield* Capability.get(ClientCapabilities.Client);\n const layoutAtom = get(yield* Capability.atom(AppCapabilities.Layout))[0];\n const layout = layoutAtom ? get(layoutAtom) : undefined;\n const spaceId = layout?.workspace ? getSpaceIdFromPath(layout.workspace) : undefined;\n const space = spaceId ? client.spaces.get(spaceId) : null;\n\n return [\n AppNode.makeDeckCompanion({\n id: linkedSegment('search'),\n label: ['search.label', { ns: meta.id }],\n icon: 'ph--magnifying-glass--regular',\n data: space,\n }),\n ];\n }),\n }),\n GraphBuilder.createExtension({\n id: 'root',\n match: NodeMatcher.whenRoot,\n actions: () =>\n Effect.succeed([\n {\n id: SearchOperation.OpenSearch.meta.key,\n data: Effect.fnUntraced(function* () {\n yield* Operation.invoke(SearchOperation.OpenSearch);\n return false;\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 ]);\n\n return Capability.contributes(AppCapabilities.AppGraphBuilder, extensions);\n }),\n);\n"],
|
|
5
|
-
"mappings": ";;;AAIA,YAAYA,YAAY;AAExB,SAASC,kBAAkB;AAC3B,SAASC,iBAAiBC,SAASC,0BAA0B;AAC7D,SAASC,iBAAiB;AAC1B,SAASC,0BAA0B;AACnC,SAASC,cAAcC,mBAAmB;AAC1C,SAASC,qBAAqB;AAE9B,SAASC,YAAY;AACrB,SAASC,uBAAuB;AAEhC,IAAA,4BAAeV,WAAWW,WACjBC,kBAAW,aAAA;AAChB,QAAMC,aAAa,OAAcC,WAAI;IACnCR,aAAaS,gBAAgB;MAC3BC,IAAI;MACJC,OAAOV,YAAYW;MACnBC,WAAkBP,kBAAW,WAAWQ,MAAMC,KAAG;AAC/C,cAAMC,SAAS,OAAOtB,WAAWqB,IAAIhB,mBAAmBkB,MAAM;AAC9D,cAAMC,aAAaH,IAAI,OAAOrB,WAAWyB,KAAKxB,gBAAgByB,MAAM,CAAA,EAAG,CAAA;AACvE,cAAMC,SAASH,aAAaH,IAAIG,UAAAA,IAAcI;AAC9C,cAAMC,UAAUF,QAAQG,YAAY3B,mBAAmBwB,OAAOG,SAAS,IAAIF;AAC3E,cAAMG,QAAQF,UAAUP,OAAOU,OAAOX,IAAIQ,OAAAA,IAAW;AAErD,eAAO;UACL3B,QAAQ+B,kBAAkB;YACxBjB,IAAIR,cAAc,QAAA;YAClB0B,OAAO;cAAC;cAAgB;gBAAEC,IAAI1B,KAAKO;cAAG;;YACtCoB,MAAM;YACNC,MAAMN;UACR,CAAA;;MAEJ,CAAA;IACF,CAAA;IACAzB,aAAaS,gBAAgB;MAC3BC,IAAI;MACJC,OAAOV,YAAYW;MACnBoB,SAAS,MACAC,eAAQ;QACb;UACEvB,IAAIN,gBAAgB8B,WAAW/B,KAAKgC;UACpCJ,MAAazB,kBAAW,aAAA;AACtB,mBAAOR,UAAUsC,OAAOhC,gBAAgB8B,UAAU;AAClD,mBAAO;UACT,CAAA;UACAG,YAAY;YACVT,OAAO;cAAC;cAAuB;gBAAEC,IAAI1B,KAAKO;cAAG;;YAC7CoB,MAAM;YACNQ,YAAY;cACVC,OAAO;cACPC,SAAS;YACX;UACF;QACF;OACD;IACL,CAAA;GACD;AAED,SAAO9C,WAAW+C,YAAY9C,gBAAgB+C,iBAAiBnC,UAAAA;AACjE,CAAA,CAAA;",
|
|
6
|
-
"names": ["Effect", "Capability", "AppCapabilities", "AppNode", "getSpaceIdFromPath", "Operation", "ClientCapabilities", "GraphBuilder", "NodeMatcher", "linkedSegment", "meta", "SearchOperation", "makeModule", "fnUntraced", "extensions", "all", "createExtension", "id", "match", "whenRoot", "connector", "node", "get", "client", "Client", "layoutAtom", "atom", "Layout", "layout", "undefined", "spaceId", "workspace", "space", "spaces", "makeDeckCompanion", "label", "ns", "icon", "data", "actions", "succeed", "OpenSearch", "key", "invoke", "properties", "keyBinding", "macos", "windows", "contributes", "AppGraphBuilder"]
|
|
7
|
-
}
|
|
@@ -1,7 +0,0 @@
|
|
|
1
|
-
{
|
|
2
|
-
"version": 3,
|
|
3
|
-
"sources": ["../../../src/SearchPlugin.tsx", "raw-loader:/__w/dxos/dxos/packages/plugins/plugin-search/PLUGIN.mdl?raw"],
|
|
4
|
-
"sourcesContent": ["//\n// Copyright 2023 DXOS.org\n//\n\nimport { Plugin } from '@dxos/app-framework';\nimport { AppPlugin } from '@dxos/app-toolkit';\n\nimport { AppGraphBuilder, OperationHandler, ReactSurface } from '#capabilities';\nimport { meta } from '#meta';\nimport { translations } from '#translations';\n\n// eslint-disable-next-line import/no-relative-packages\nimport pluginSpec from '../PLUGIN.mdl?raw';\n\nexport const SearchPlugin = Plugin.define(meta).pipe(\n AppPlugin.addAppGraphModule({ activate: AppGraphBuilder }),\n AppPlugin.addOperationHandlerModule({ activate: OperationHandler }),\n AppPlugin.addSurfaceModule({ activate: ReactSurface }),\n AppPlugin.addTranslationsModule({ translations }),\n AppPlugin.addPluginAssetModule({\n asset: { pluginId: meta.id, path: 'PLUGIN.mdl', content: pluginSpec, mimeType: 'application/x-mdl' },\n }),\n Plugin.make,\n);\n\nexport default SearchPlugin;\n", "---\nid: org.dxos.plugin.search\nname: SearchPlugin\nversion: 0.1.0\n---\n\nA full-text search and web-search plugin for `DXOS` Composer that lets users locate objects\nacross all spaces and pull in structured data from the web.\n\n## Extensions\n\nThe following extension dialects are used in this document.\nEach extension is defined in the Appendix or resolved via its URI.\n\n| Term | URI |\n|-------------|--------------------------------|\n| `type` | `org.dxos.mdl.type@1.0` |\n| `feat` | `org.dxos.mdl.feat@1.0` |\n| `test` | `org.dxos.mdl.test@1.0` |\n| `component` | `org.dxos.mdl.component@1.0` |\n| `op` | `org.dxos.mdl.op@1.0` |\n\n## Types\n\n```mdl\ntype SearchQuery\n fields:\n text: string # raw query string entered by the user\n spaceId?: string # optional scope; omit to search all spaces\n```\n\n```mdl\ntype MatchField\n fields:\n key: string # field name that matched (e.g. \"title\", \"body\")\n value: string # full field value containing the match\n```\n\n```mdl\ntype SearchResult\n fields:\n objectId: string # ECHO object DXN\n typeName: string # schema typename of the matched object\n fields: MatchField[] # list of fields where the query matched\n```\n\n```mdl\ntype WebSearchResult\n fields:\n url: string\n title: string\n snippet: string\n publishedDate?: string\n```\n\n## Components\n\n```mdl\ncomponent SearchDialog\n desc: |\n Modal command-palette style dialog invoked globally via the OpenSearch operation.\n Renders a search input at the top; results populate below in real time.\n props:\n space: Space # current active space to scope the search\n state:\n query: string # live query text\n results: SearchResult[] # objects matching the current query\n pending: boolean # true while debounced search is in-flight\n slots:\n empty?: ReactNode # shown when query is non-empty but results are empty\n actions:\n submitQuery(text: string)\n clearQuery()\n selectResult(result: SearchResult)\n emits:\n onSelect(result: SearchResult)\n layout: |\n \u250C\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2510\n \u2502 \uD83D\uDD0D [search input] \u2502\n \u251C\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2524\n \u2502 result row \u2502\n \u2502 result row \u2502\n \u2502 result row \u2502\n \u2502 [empty slot] \u2502\n \u2514\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2518\n```\n\n```mdl\ncomponent SearchArticle\n desc: |\n Inline search panel mounted in the deck companion (sidebar) and in the\n search-input role. Shares the same SearchContextProvider as SearchDialog\n so the active query filters objects across the whole Composer deck.\n props:\n space: Space\n state:\n query: string\n results: SearchResult[]\n actions:\n submitQuery(text: string)\n clearQuery()\n layout: |\n \u250C\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2510\n \u2502 [search input] \u2502\n \u251C\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2524\n \u2502 result list \u2502\n \u2514\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2518\n```\n\n## Operations\n\n```mdl\nop OpenSearch\n desc: |\n Opens the global SearchDialog by dispatching a LayoutOperation.UpdateDialog\n event. No input parameters required; the dialog manages its own query state.\n input: void\n output: void\n effects: [layout:dialog]\n note: Registered as SearchOperation.OpenSearch; triggered from the command palette.\n```\n\n## Features\n\n```mdl\nfeat F-1: Local Object Search\n\n req F-1.1: User can open SearchDialog from anywhere in Composer via the OpenSearch operation.\n\n req F-1.2:\n when: user types into the search input\n then: query is debounced (400 ms) then matched against all ECHO objects in the active space\n\n req F-1.3:\n when: an object's field value matches the query regex\n then: result entry shown with the object type, matched field key, and field value snippet\n\n req F-1.4:\n when: query is empty or cleared\n then: results list is empty; no search is executed\n```\n\n```mdl\nfeat F-2: Global Filter Integration\n\n req F-2.1:\n when: SearchContextProvider is mounted\n then: active query is propagated to GlobalFilterProvider so all views using\n useGlobalFilteredObjects automatically show only matching objects\n\n req F-2.2:\n when: query is cleared\n then: GlobalFilterProvider returns all objects unfiltered\n```\n\n```mdl\nfeat F-3: Deck Companion Search Panel\n\n req F-3.1:\n when: user opens the deck companion panel with role deck-companion--search\n then: SearchArticle is rendered scoped to the active Space\n\n req F-3.2:\n when: user types in SearchArticle\n then: results update in real time using the same debounced filter as SearchDialog\n```\n\n```mdl\nfeat F-4: Web Search (Exa)\n\n req F-4.1:\n when: the Exa API key is configured\n then: external web-search is available and returns WebSearchResult objects\n\n req F-4.2:\n when: web search returns results\n then: results are ranked by relevance and returned with url, title, and snippet\n```\n\n## Acceptance\n\n```mdl\ntest T-1: OpenSearch operation opens dialog\n given: user is in Composer with an active space\n when: user triggers the OpenSearch operation (e.g. \u2318K)\n then:\n - SearchDialog is visible\n - search input has focus\n```\n\n```mdl\ntest T-2: Query returns matching objects\n given: space contains a document with title \"Meeting Notes\"\n when: user types \"meeting\" into SearchDialog\n then:\n - result row for the document appears\n - matched field key is \"title\"\n - field value contains \"Meeting Notes\"\n```\n\n```mdl\ntest T-3: Empty query shows no results\n given: SearchDialog is open\n when: user clears the query string\n then: results list is empty; pending is false\n```\n\n```mdl\ntest T-4: GlobalFilter propagation\n given: SearchContextProvider is mounted in the deck\n when: user types \"budget\" in SearchArticle\n then: all views using useGlobalFilteredObjects show only objects matching \"budget\"\n```\n\n```mdl\ntest T-5: Non-matching query shows empty state\n given: space has no objects matching \"xyzzy\"\n when: user types \"xyzzy\"\n then:\n - results list is empty\n - empty slot is rendered\n```\n\n---\n\n## Appendix: Extension Definitions\n\nExtension block types used in this document are defined below using\nthe core `ext` primitive \u2014 the only construct the base language provides.\n\n```mdl\next type\n uri: org.dxos.mdl.type@1.0\n desc: A named data structure with typed fields and optional literals.\n fields:\n desc?: Prose\n fields?: FieldMap # name[?]: TypeExpr (# inline comment)\n literals?: UnionList # a | b | c\n extends?: TypeRef[]\n```\n\n```mdl\next feat\n uri: org.dxos.mdl.feat@1.0\n desc: A named feature grouping one or more requirements.\n fields:\n desc?: Prose\n req: RequirementList\n nesting: self # feat blocks may contain feat blocks\n```\n\n```mdl\next test\n uri: org.dxos.mdl.test@1.0\n desc: An acceptance scenario expressed as given / when / then steps.\n fields:\n given?: Step | Step[]\n when?: Step | Step[]\n then: Step | Step[]\n tags?: TagList\n```\n\n```mdl\next component\n uri: org.dxos.mdl.component@1.0\n desc: A UI component with props, internal state, slots, actions, and events.\n fields:\n desc?: Prose\n props?: FieldMap # external inputs (immutable inside component)\n state?: FieldMap # internal reactive state\n slots?: FieldMap # named ReactNode injection points\n actions?: ActionMap # methods the component exposes or handles\n emits?: EventMap # events the component raises to its parent\n layout?: CodeBlock # ASCII sketch of visual structure (non-normative)\n```\n\n```mdl\next op\n uri: org.dxos.mdl.op@1.0\n desc: |\n A named operation with typed inputs, outputs, and declared errors.\n Pure ops have no effects or requires. Effectful ops declare both.\n fields:\n desc?: Prose\n input?: FieldMap # named input parameters\n output?: TypeExpr # return type\n errors?: ErrorMap # name: Prose (when this error occurs)\n effects?: EffectList # echo:read | echo:write | http | fs | ...\n requires?: ServiceList # injected service dependencies\n note?: Prose # implementation guidance (non-normative)\n```\n"],
|
|
5
|
-
"mappings": ";AAIA,SAASA,cAAc;AACvB,SAASC,iBAAiB;AAE1B,SAASC,iBAAiBC,kBAAkBC,oBAAoB;AAChE,SAASC,YAAY;AACrB,SAASC,oBAAoB;;;ACT7B;;;ADcO,IAAMC,eAAeC,OAAOC,OAAOC,IAAAA,EAAMC,KAC9CC,UAAUC,kBAAkB;EAAEC,UAAUC;AAAgB,CAAA,GACxDH,UAAUI,0BAA0B;EAAEF,UAAUG;AAAiB,CAAA,GACjEL,UAAUM,iBAAiB;EAAEJ,UAAUK;AAAa,CAAA,GACpDP,UAAUQ,sBAAsB;EAAEC;AAAa,CAAA,GAC/CT,UAAUU,qBAAqB;EAC7BC,OAAO;IAAEC,UAAUd,KAAKe;IAAIC,MAAM;IAAcC,SAASC;IAAYC,UAAU;EAAoB;AACrG,CAAA,GACArB,OAAOsB,IAAI;AAGb,IAAA,uBAAevB;",
|
|
6
|
-
"names": ["Plugin", "AppPlugin", "AppGraphBuilder", "OperationHandler", "ReactSurface", "meta", "translations", "SearchPlugin", "Plugin", "define", "meta", "pipe", "AppPlugin", "addAppGraphModule", "activate", "AppGraphBuilder", "addOperationHandlerModule", "OperationHandler", "addSurfaceModule", "ReactSurface", "addTranslationsModule", "translations", "addPluginAssetModule", "asset", "pluginId", "id", "path", "content", "pluginSpec", "mimeType", "make"]
|
|
7
|
-
}
|
|
@@ -1,7 +0,0 @@
|
|
|
1
|
-
{
|
|
2
|
-
"version": 3,
|
|
3
|
-
"sources": ["../../../src/types/SearchOperation.ts"],
|
|
4
|
-
"sourcesContent": ["//\n// Copyright 2025 DXOS.org\n//\n\n// @import-as-namespace\n\nimport * as Schema from 'effect/Schema';\n\nimport { Operation } from '@dxos/compute';\nimport { DXN } from '@dxos/keys';\n\nimport { meta } from '#meta';\n\nconst makeKey = (name: string) => DXN.make(`${meta.id}.operation.${name}`);\n\nexport const OpenSearch = Operation.make({\n meta: { key: makeKey('openSearch'), name: 'Open Search', icon: 'ph--magnifying-glass--regular' },\n input: Schema.Void,\n output: Schema.Void,\n});\n"],
|
|
5
|
-
"mappings": ";;;;;AAAA;;;;AAMA,YAAYA,YAAY;AAExB,SAASC,iBAAiB;AAC1B,SAASC,WAAW;AAEpB,SAASC,YAAY;AAErB,IAAMC,UAAU,CAACC,SAAiBH,IAAII,KAAK,GAAGH,KAAKI,EAAE,cAAcF,IAAAA,EAAM;AAElE,IAAMG,aAAaP,UAAUK,KAAK;EACvCH,MAAM;IAAEM,KAAKL,QAAQ,YAAA;IAAeC,MAAM;IAAeK,MAAM;EAAgC;EAC/FC,OAAcC;EACdC,QAAeD;AACjB,CAAA;",
|
|
6
|
-
"names": ["Schema", "Operation", "DXN", "meta", "makeKey", "name", "make", "id", "OpenSearch", "key", "icon", "input", "Void", "output"]
|
|
7
|
-
}
|
|
@@ -1,41 +0,0 @@
|
|
|
1
|
-
// src/meta.ts
|
|
2
|
-
import { Plugin } from "@dxos/app-framework";
|
|
3
|
-
import { DXN } from "@dxos/keys";
|
|
4
|
-
import { trim } from "@dxos/util";
|
|
5
|
-
var meta = Plugin.makeMeta({
|
|
6
|
-
key: DXN.make("org.dxos.plugin.search"),
|
|
7
|
-
name: "Search",
|
|
8
|
-
author: "DXOS",
|
|
9
|
-
description: trim`
|
|
10
|
-
Full-text search engine for finding content across all spaces and object types in DXOS Composer.
|
|
11
|
-
The plugin provides a global command-palette style dialog (invoked via the OpenSearch operation)
|
|
12
|
-
that debounces user input and matches it against every field of every ECHO object in the active
|
|
13
|
-
space, returning ranked results with field-level match context.
|
|
14
|
-
|
|
15
|
-
A persistent SearchArticle panel can be pinned in the deck companion sidebar so the query stays
|
|
16
|
-
visible while navigating documents. Both surfaces share a SearchContextProvider that drives the
|
|
17
|
-
GlobalFilterProvider, allowing any view that uses useGlobalFilteredObjects to automatically show
|
|
18
|
-
only the objects matching the current query.
|
|
19
|
-
|
|
20
|
-
Web search is available through the Exa integration: when an API key is configured, the plugin
|
|
21
|
-
can fetch and rank external web results alongside local objects. The results are structured with
|
|
22
|
-
URL, title, and snippet fields ready for use in Composer documents.
|
|
23
|
-
|
|
24
|
-
All search operations are registered through the standard DXOS operations system and can be
|
|
25
|
-
wired into keyboard shortcuts, command palettes, and AI assistants via the OperationHandlerSet.
|
|
26
|
-
`,
|
|
27
|
-
icon: "ph--magnifying-glass--regular",
|
|
28
|
-
iconHue: "rose",
|
|
29
|
-
source: "https://github.com/dxos/dxos/tree/main/packages/plugins/plugin-search",
|
|
30
|
-
spec: "PLUGIN.mdl",
|
|
31
|
-
tags: [
|
|
32
|
-
"labs"
|
|
33
|
-
]
|
|
34
|
-
});
|
|
35
|
-
var SEARCH_RESULT = `${meta.id}.result`;
|
|
36
|
-
|
|
37
|
-
export {
|
|
38
|
-
meta,
|
|
39
|
-
SEARCH_RESULT
|
|
40
|
-
};
|
|
41
|
-
//# sourceMappingURL=chunk-Q2F6YOOZ.mjs.map
|
|
@@ -1,7 +0,0 @@
|
|
|
1
|
-
{
|
|
2
|
-
"version": 3,
|
|
3
|
-
"sources": ["../../../src/meta.ts"],
|
|
4
|
-
"sourcesContent": ["//\n// Copyright 2023 DXOS.org\n//\n\nimport { Plugin } from '@dxos/app-framework';\nimport { DXN } from '@dxos/keys';\nimport { trim } from '@dxos/util';\n\nexport const meta = Plugin.makeMeta({\n key: DXN.make('org.dxos.plugin.search'),\n name: 'Search',\n author: 'DXOS',\n description: trim`\n Full-text search engine for finding content across all spaces and object types in DXOS Composer.\n The plugin provides a global command-palette style dialog (invoked via the OpenSearch operation)\n that debounces user input and matches it against every field of every ECHO object in the active\n space, returning ranked results with field-level match context.\n\n A persistent SearchArticle panel can be pinned in the deck companion sidebar so the query stays\n visible while navigating documents. Both surfaces share a SearchContextProvider that drives the\n GlobalFilterProvider, allowing any view that uses useGlobalFilteredObjects to automatically show\n only the objects matching the current query.\n\n Web search is available through the Exa integration: when an API key is configured, the plugin\n can fetch and rank external web results alongside local objects. The results are structured with\n URL, title, and snippet fields ready for use in Composer documents.\n\n All search operations are registered through the standard DXOS operations system and can be\n wired into keyboard shortcuts, command palettes, and AI assistants via the OperationHandlerSet.\n `,\n icon: 'ph--magnifying-glass--regular',\n iconHue: 'rose',\n source: 'https://github.com/dxos/dxos/tree/main/packages/plugins/plugin-search',\n spec: 'PLUGIN.mdl',\n tags: ['labs'],\n});\n\nexport const SEARCH_RESULT = `${meta.id}.result`;\n"],
|
|
5
|
-
"mappings": ";AAIA,SAASA,cAAc;AACvB,SAASC,WAAW;AACpB,SAASC,YAAY;AAEd,IAAMC,OAAOH,OAAOI,SAAS;EAClCC,KAAKJ,IAAIK,KAAK,wBAAA;EACdC,MAAM;EACNC,QAAQ;EACRC,aAAaP;;;;;;;;;;;;;;;;;;EAkBbQ,MAAM;EACNC,SAAS;EACTC,QAAQ;EACRC,MAAM;EACNC,MAAM;IAAC;;AACT,CAAA;AAEO,IAAMC,gBAAgB,GAAGZ,KAAKa,EAAE;",
|
|
6
|
-
"names": ["Plugin", "DXN", "trim", "meta", "makeMeta", "key", "make", "name", "author", "description", "icon", "iconHue", "source", "spec", "tags", "SEARCH_RESULT", "id"]
|
|
7
|
-
}
|
|
@@ -1,7 +0,0 @@
|
|
|
1
|
-
{
|
|
2
|
-
"version": 3,
|
|
3
|
-
"sources": ["../../../src/capabilities/react-surface.tsx"],
|
|
4
|
-
"sourcesContent": ["//\n// Copyright 2025 DXOS.org\n//\n\nimport * as Effect from 'effect/Effect';\nimport React, { type ComponentProps } from 'react';\n\nimport { Capabilities, Capability } from '@dxos/app-framework';\nimport { Surface } from '@dxos/app-framework/ui';\nimport { AppSurface, useActiveSpace } from '@dxos/app-toolkit/ui';\nimport { type Space, isSpace } from '@dxos/react-client/echo';\n\nimport { SearchArticle, SearchDialog } from '#containers';\nimport { SearchContextProvider } from '#hooks';\n\nimport { SEARCH_DIALOG } from '../constants';\n\nexport default Capability.makeModule(() =>\n Effect.succeed(\n Capability.contributes(Capabilities.ReactSurface, [\n Surface.create({\n id: SEARCH_DIALOG,\n filter: AppSurface.component<ComponentProps<typeof SearchDialog>>(AppSurface.Dialog, SEARCH_DIALOG),\n component: ({ data }) => {\n const space = useActiveSpace();\n if (!space) {\n return null;\n }\n\n return (\n <SearchContextProvider>\n <SearchDialog {...data.props} space={space} />\n </SearchContextProvider>\n );\n },\n }),\n Surface.create({\n id: `${SEARCH_DIALOG}.searchInput`,\n role: 'search-input',\n component: () => {\n const space = useActiveSpace();\n if (!space) {\n return null;\n }\n\n return (\n <SearchContextProvider>\n <SearchArticle space={space} />\n </SearchContextProvider>\n );\n },\n }),\n Surface.create({\n id: `${SEARCH_DIALOG}.search`,\n role: 'deck-companion--search',\n filter: (data): data is { subject: Space } => isSpace(data.subject),\n component: ({ data }) => {\n const space = data.subject;\n if (!space) {\n return null;\n }\n\n return (\n <SearchContextProvider>\n <SearchArticle space={space} />\n </SearchContextProvider>\n );\n },\n }),\n ]),\n ),\n);\n"],
|
|
5
|
-
"mappings": ";;;;;;AAIA,YAAYA,YAAY;AACxB,OAAOC,WAAoC;AAE3C,SAASC,cAAcC,kBAAkB;AACzC,SAASC,eAAe;AACxB,SAASC,YAAYC,sBAAsB;AAC3C,SAAqBC,eAAe;AAEpC,SAASC,eAAeC,oBAAoB;AAC5C,SAASC,6BAA6B;AAItC,IAAA,wBAAeC,WAAWC,WAAW,MAC5BC,eACLF,WAAWG,YAAYC,aAAaC,cAAc;EAChDC,QAAQC,OAAO;IACbC,IAAIC;IACJC,QAAQC,WAAWC,UAA+CD,WAAWE,QAAQJ,aAAAA;IACrFG,WAAW,CAAC,EAAEE,KAAI,MAAE;AAClB,YAAMC,QAAQC,eAAAA;AACd,UAAI,CAACD,OAAO;AACV,eAAO;MACT;AAEA,aACE,sBAAA,cAACE,uBAAAA,MACC,sBAAA,cAACC,cAAAA;QAAc,GAAGJ,KAAKK;QAAOJ;;IAGpC;EACF,CAAA;EACAT,QAAQC,OAAO;IACbC,IAAI,GAAGC,aAAAA;IACPW,MAAM;IACNR,WAAW,MAAA;AACT,YAAMG,QAAQC,eAAAA;AACd,UAAI,CAACD,OAAO;AACV,eAAO;MACT;AAEA,aACE,sBAAA,cAACE,uBAAAA,MACC,sBAAA,cAACI,eAAAA;QAAcN;;IAGrB;EACF,CAAA;EACAT,QAAQC,OAAO;IACbC,IAAI,GAAGC,aAAAA;IACPW,MAAM;IACNV,QAAQ,CAACI,SAAqCQ,QAAQR,KAAKS,OAAO;IAClEX,WAAW,CAAC,EAAEE,KAAI,MAAE;AAClB,YAAMC,QAAQD,KAAKS;AACnB,UAAI,CAACR,OAAO;AACV,eAAO;MACT;AAEA,aACE,sBAAA,cAACE,uBAAAA,MACC,sBAAA,cAACI,eAAAA;QAAcN;;IAGrB;EACF,CAAA;CACD,CAAA,CAAA;",
|
|
6
|
-
"names": ["Effect", "React", "Capabilities", "Capability", "Surface", "AppSurface", "useActiveSpace", "isSpace", "SearchArticle", "SearchDialog", "SearchContextProvider", "Capability", "makeModule", "succeed", "contributes", "Capabilities", "ReactSurface", "Surface", "create", "id", "SEARCH_DIALOG", "filter", "AppSurface", "component", "Dialog", "data", "space", "useActiveSpace", "SearchContextProvider", "SearchDialog", "props", "role", "SearchArticle", "isSpace", "subject"]
|
|
7
|
-
}
|
|
File without changes
|
|
File without changes
|