@dxos/plugin-debug 0.7.5-main.9cb18ac → 0.7.5-main.9d2a38b

package/src/capabilities/react-surface.tsx

@@ -0,0 +1,138 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import React, { useCallback } from 'react';
+
+import {
+  Capabilities,
+  contributes,
+  createIntent,
+  createSurface,
+  useCapability,
+  type PluginsContext,
+} from '@dxos/app-framework';
+import { Devtools } from '@dxos/devtools';
+import { Graph } from '@dxos/plugin-graph';
+import { SpaceAction, CollectionType } from '@dxos/plugin-space/types';
+import {
+  SpaceState,
+  isSpace,
+  isEchoObject,
+  type ReactiveEchoObject,
+  type ReactiveObject,
+  type Space,
+} from '@dxos/react-client/echo';
+
+import {
+  DebugApp,
+  DebugObjectPanel,
+  DebugSettings,
+  DebugSpace,
+  DebugStatus,
+  SpaceGenerator,
+  Wireframe,
+} from '../components';
+import { DEBUG_PLUGIN } from '../meta';
+import { type DebugSettingsProps } from '../types';
+
+type SpaceDebug = {
+  type: string;
+  space: Space;
+};
+
+type GraphDebug = {
+  graph: Graph;
+};
+
+const isSpaceDebug = (data: any): data is SpaceDebug => data.type === `${DEBUG_PLUGIN}/space` && isSpace(data.space);
+const isGraphDebug = (data: any): data is GraphDebug => data.graph instanceof Graph;
+
+export default (context: PluginsContext) =>
+  contributes(Capabilities.ReactSurface, [
+    createSurface({
+      id: `${DEBUG_PLUGIN}/settings`,
+      role: 'settings',
+      filter: (data): data is any => data.subject === DEBUG_PLUGIN,
+      component: () => {
+        const settings = useCapability(Capabilities.SettingsStore).getStore<DebugSettingsProps>(DEBUG_PLUGIN)!.value;
+        return <DebugSettings settings={settings} />;
+      },
+    }),
+    createSurface({
+      id: `${DEBUG_PLUGIN}/status`,
+      role: 'status',
+      component: () => <DebugStatus />,
+    }),
+    createSurface({
+      id: `${DEBUG_PLUGIN}/complementary`,
+      role: 'complementary--debug',
+      filter: (data): data is { subject: ReactiveEchoObject<any> } => isEchoObject(data.subject),
+      component: ({ data }) => <DebugObjectPanel object={data.subject} />,
+    }),
+    createSurface({
+      id: `${DEBUG_PLUGIN}/devtools`,
+      role: 'article',
+      filter: (data): data is any => {
+        const settings = context
+          .requestCapability(Capabilities.SettingsStore)
+          .getStore<DebugSettingsProps>(DEBUG_PLUGIN)!.value;
+        return data.subject === 'devtools' && !!settings.devtools;
+      },
+      component: () => <Devtools />,
+    }),
+    createSurface({
+      id: `${DEBUG_PLUGIN}/space`,
+      role: 'article',
+      filter: (data): data is { subject: SpaceDebug } => isSpaceDebug(data.subject),
+      component: ({ data }) => {
+        const handleCreateObject = useCallback(
+          (objects: ReactiveObject<any>[]) => {
+            if (!isSpace(data.subject.space)) {
+              return;
+            }
+
+            const collection =
+              data.subject.space.state.get() === SpaceState.SPACE_READY &&
+              data.subject.space.properties[CollectionType.typename]?.target;
+            if (!(collection instanceof CollectionType)) {
+              return;
+            }
+
+            const { dispatchPromise: dispatch } = context.requestCapability(Capabilities.IntentDispatcher);
+            objects.forEach((object) => {
+              void dispatch(createIntent(SpaceAction.AddObject, { target: collection, object }));
+            });
+          },
+          [data.subject.space],
+        );
+
+        const deprecated = false;
+        return deprecated ? (
+          <DebugSpace space={data.subject.space} onAddObjects={handleCreateObject} />
+        ) : (
+          <SpaceGenerator space={data.subject.space} onCreateObjects={handleCreateObject} />
+        );
+      },
+    }),
+    createSurface({
+      id: `${DEBUG_PLUGIN}/graph`,
+      role: 'article',
+      filter: (data): data is { subject: GraphDebug } => isGraphDebug(data.subject),
+      component: ({ data }) => <DebugApp graph={data.subject.graph} />,
+    }),
+    createSurface({
+      id: `${DEBUG_PLUGIN}/wireframe`,
+      role: ['article', 'section'],
+      disposition: 'hoist',
+      filter: (data): data is { subject: ReactiveEchoObject<any> } => {
+        const settings = context
+          .requestCapability(Capabilities.SettingsStore)
+          .getStore<DebugSettingsProps>(DEBUG_PLUGIN)!.value;
+        return isEchoObject(data.subject) && !!settings.wireframe;
+      },
+      component: ({ data, role }) => (
+        <Wireframe label={`${role}:${name}`} object={data.subject} classNames='row-span-2 overflow-hidden' />
+      ),
+    }),
+  ]);

package/src/capabilities/settings.ts

@@ -0,0 +1,18 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import { Capabilities, contributes } from '@dxos/app-framework';
+import { create } from '@dxos/react-client/echo';
+
+import { DEBUG_PLUGIN } from '../meta';
+import { type DebugSettingsProps, DebugSettingsSchema } from '../types';
+
+export default () => {
+  const settings = create<DebugSettingsProps>({
+    debug: true,
+    devtools: true,
+  });
+
+  return contributes(Capabilities.Settings, { schema: DebugSettingsSchema, prefix: DEBUG_PLUGIN, value: settings });
+};

package/src/components/DebugApp/DebugApp.tsx

@@ -59,7 +59,7 @@ export const DebugApp: FC<{ graph: Graph }> = ({ graph }) => {
             </ToggleGroupItem>
           </ToggleGroup>
 
-          <Toolbar.Expander />
+          <Toolbar.Separator variant='gap' />
           <Button onClick={(event) => handleResetClient(event.shiftKey)} title='Reset client'>
             <Warning className={mx(getSize(5), 'text-red-700')} />
           </Button>

package/src/components/DebugSettings.tsx

@@ -5,7 +5,7 @@
 import { Gift, DownloadSimple, FirstAidKit } from '@phosphor-icons/react';
 import React, { useEffect, useState } from 'react';
 
-import { parseFileManagerPlugin, useResolvePlugin } from '@dxos/app-framework';
+import { Capabilities, useCapabilities } from '@dxos/app-framework';
 import { type ConfigProto, defs, SaveConfig, Storage } from '@dxos/config';
 import { log } from '@dxos/log';
 import { useClient } from '@dxos/react-client';
@@ -34,7 +34,7 @@ export const DebugSettings = ({ settings }: { settings: DebugSettingsProps }) =>
   const download = useFileDownload();
   // TODO(mykola): Get updates from other places that change Config.
   const [storageConfig, setStorageConfig] = useState<ConfigProto>({});
-  const fileManagerPlugin = useResolvePlugin(parseFileManagerPlugin);
+  const [upload] = useCapabilities(Capabilities.FileUploader);
 
   useEffect(() => {
     void Storage().then((config) => setStorageConfig(config));
@@ -52,8 +52,8 @@ export const DebugSettings = ({ settings }: { settings: DebugSettingsProps }) =>
     const fileName = `composer-${new Date().toISOString().replace(/\W/g, '-')}.json`;
     download(file, fileName);
 
-    if (fileManagerPlugin?.provides.file.upload) {
-      const info = await fileManagerPlugin.provides.file.upload(new File([file], fileName), client.spaces.default);
+    if (upload) {
+      const info = await upload(new File([file], fileName), client.spaces.default);
       if (!info) {
         log.error('diagnostics failed to upload to IPFS');
         return;

package/src/components/DebugSpace/DebugSpace.tsx

@@ -158,7 +158,7 @@ export const DebugSpace: FC<{
           <IconButton icon='ph--arrow-clockwise--regular' iconOnly label='Refresh' size={5} onClick={handleUpdate} />
           <IconButton icon='ph--download-simple--regular' iconOnly label='Download' size={5} onClick={handleDownload} />
 
-          <Toolbar.Expander />
+          <Toolbar.Separator variant='gap' />
           <IconButton
             icon='ph--flag-pennant--regular'
             iconOnly

package/src/components/DebugStatus.tsx

@@ -4,10 +4,9 @@
 
 import React, { useEffect, useRef, useState } from 'react';
 
-import { firstIdInPart, parseGraphPlugin, parseNavigationPlugin, useResolvePlugin } from '@dxos/app-framework';
+import { Capabilities, firstIdInPart, useCapability } from '@dxos/app-framework';
 import { TimeoutError } from '@dxos/async';
 import { StatsPanel, useStats } from '@dxos/devtools';
-import { log } from '@dxos/log';
 import { getActiveSpace } from '@dxos/plugin-space';
 import { StatusBar } from '@dxos/plugin-status-bar';
 import { ConnectionState } from '@dxos/protocols/proto/dxos/client/services';
@@ -67,10 +66,7 @@ const ErrorIndicator = () => {
   useEffect(() => {
     const errorListener = (event: any) => {
       const error: Error = event.error ?? event.reason;
-      // event.preventDefault();
       if (errorRef.current !== error) {
-        // eslint-disable-next-line no-console
-        log.error('onError', { event });
         errorRef.current = error;
         forceUpdate({});
       }
@@ -140,10 +136,8 @@ const SwarmIndicator = () => {
 // TODO(burdon): Merge with SaveStatus.
 const SavingIndicator = () => {
   const [state, _setState] = useState(0);
-  const navigationPlugin = useResolvePlugin(parseNavigationPlugin);
-  const graphPlugin = useResolvePlugin(parseGraphPlugin);
-  const location = navigationPlugin?.provides.location;
-  const graph = graphPlugin?.provides.graph;
+  const location = useCapability(Capabilities.Location);
+  const { graph } = useCapability(Capabilities.AppGraph);
   const _space = location && graph ? getActiveSpace(graph, firstIdInPart(location.active, 'main')) : undefined;
   // TODO(dmaretskyi): Fix this when we have save status for automerge.
   // useEffect(() => {

package/src/components/SpaceGenerator/ObjectGenerator.tsx

@@ -5,14 +5,14 @@
 import { addressToA1Notation } from '@dxos/compute';
 import { type BaseObject, type TypedObject } from '@dxos/echo-schema';
 import { create, makeRef, type ReactiveObject } from '@dxos/live-object';
-import { DocumentType, TextType } from '@dxos/plugin-markdown/types';
-import { createSheet } from '@dxos/plugin-sheet';
+import { DocumentType } from '@dxos/plugin-markdown/types';
+import { createSheet } from '@dxos/plugin-sheet/types';
 import { SheetType, type CellValue } from '@dxos/plugin-sheet/types';
 import { CanvasType, DiagramType } from '@dxos/plugin-sketch/types';
 import { faker } from '@dxos/random';
 import { Filter, type Space } from '@dxos/react-client/echo';
 import { TableType } from '@dxos/react-ui-table';
-import { createView } from '@dxos/schema';
+import { createView, TextType } from '@dxos/schema';
 import { createAsyncGenerator, type ValueGenerator } from '@dxos/schema/testing';
 import { range } from '@dxos/util';
 

package/src/components/SpaceGenerator/SpaceGenerator.tsx

@@ -86,7 +86,7 @@ export const SpaceGenerator = ({ space, onCreateObjects }: SpaceGeneratorProps)
     <div role='none' className='flex flex-col divide-y divide-separator'>
       <Toolbar.Root classNames='p-1'>
         <IconButton icon='ph--arrow-clockwise--regular' iconOnly label='Refresh' onClick={updateInfo} />
-        <Toolbar.Expander />
+        <Toolbar.Separator variant='gap' />
         <div className='flex'>
           <Input.Root>
             <Input.TextInput

package/src/index.ts

@@ -2,8 +2,5 @@
 // Copyright 2023 DXOS.org
 //
 
-import { DebugPlugin } from './DebugPlugin';
-
 export * from './DebugPlugin';
-
-export default DebugPlugin;
+export * from './meta';

package/src/meta.ts

@@ -6,7 +6,7 @@ import { type PluginMeta } from '@dxos/app-framework';
 
 export const DEBUG_PLUGIN = 'dxos.org/plugin/debug';
 
-export default {
+export const meta = {
   id: DEBUG_PLUGIN,
   name: 'Debug',
   description: 'DXOS debugging tools.',

package/src/types.ts

@@ -4,15 +4,8 @@
 
 import { type Context, createContext } from 'react';
 
-import type {
-  GraphBuilderProvides,
-  SettingsProvides,
-  SurfaceProvides,
-  TranslationsProvides,
-} from '@dxos/app-framework';
 import type { TimerCallback, TimerOptions } from '@dxos/async';
 import { S } from '@dxos/echo-schema';
-import { type PanelProvides } from '@dxos/plugin-deck/types';
 
 export type DebugContextType = {
   running: boolean;
@@ -35,9 +28,3 @@ export const DebugSettingsSchema = S.mutable(
 );
 
 export interface DebugSettingsProps extends S.Schema.Type<typeof DebugSettingsSchema> {}
-
-export type DebugPluginProvides = SurfaceProvides &
-  GraphBuilderProvides &
-  SettingsProvides<DebugSettingsProps> &
-  TranslationsProvides &
-  PanelProvides;

package/dist/lib/browser/chunk-6CGQHKET.mjs.map

@@ -1,7 +0,0 @@
-{
-  "version": 3,
-  "sources": ["../../../src/types.ts"],
-  "sourcesContent": ["//\n// Copyright 2023 DXOS.org\n//\n\nimport { type Context, createContext } from 'react';\n\nimport type {\n  GraphBuilderProvides,\n  SettingsProvides,\n  SurfaceProvides,\n  TranslationsProvides,\n} from '@dxos/app-framework';\nimport type { TimerCallback, TimerOptions } from '@dxos/async';\nimport { S } from '@dxos/echo-schema';\nimport { type PanelProvides } from '@dxos/plugin-deck/types';\n\nexport type DebugContextType = {\n  running: boolean;\n  start: (cb: TimerCallback, options: TimerOptions) => void;\n  stop: () => void;\n};\n\nexport const DebugContext: Context<DebugContextType> = createContext<DebugContextType>({\n  running: false,\n  start: () => {},\n  stop: () => {},\n});\n\nexport const DebugSettingsSchema = S.mutable(\n  S.Struct({\n    devtools: S.optional(S.Boolean),\n    debug: S.optional(S.Boolean),\n    wireframe: S.optional(S.Boolean),\n  }),\n);\n\nexport interface DebugSettingsProps extends S.Schema.Type<typeof DebugSettingsSchema> {}\n\nexport type DebugPluginProvides = SurfaceProvides &\n  GraphBuilderProvides &\n  SettingsProvides<DebugSettingsProps> &\n  TranslationsProvides &\n  PanelProvides;\n"],
-  "mappings": ";AAIA,SAAuBA,qBAAqB;AAS5C,SAASC,SAAS;AASX,IAAMC,eAA0CC,cAAgC;EACrFC,SAAS;EACTC,OAAO,MAAA;EAAO;EACdC,MAAM,MAAA;EAAO;AACf,CAAA;AAEO,IAAMC,sBAAsBC,EAAEC,QACnCD,EAAEE,OAAO;EACPC,UAAUH,EAAEI,SAASJ,EAAEK,OAAO;EAC9BC,OAAON,EAAEI,SAASJ,EAAEK,OAAO;EAC3BE,WAAWP,EAAEI,SAASJ,EAAEK,OAAO;AACjC,CAAA,CAAA;",
-  "names": ["createContext", "S", "DebugContext", "createContext", "running", "start", "stop", "DebugSettingsSchema", "S", "mutable", "Struct", "devtools", "optional", "Boolean", "debug", "wireframe"]
-}

package/dist/lib/browser/chunk-CAENAAHY.mjs.map

@@ -1,7 +0,0 @@
-{
-  "version": 3,
-  "sources": ["../../../src/meta.ts"],
-  "sourcesContent": ["//\n// Copyright 2023 DXOS.org\n//\n\nimport { type PluginMeta } from '@dxos/app-framework';\n\nexport const DEBUG_PLUGIN = 'dxos.org/plugin/debug';\n\nexport default {\n  id: DEBUG_PLUGIN,\n  name: 'Debug',\n  description: 'DXOS debugging tools.',\n  icon: 'ph--bug--regular',\n  source: 'https://github.com/dxos/dxos/tree/main/packages/plugins/plugin-debug',\n  tags: ['experimental'],\n} satisfies PluginMeta;\n"],
-  "mappings": ";AAMO,IAAMA,eAAe;AAE5B,IAAA,eAAe;EACbC,IAAID;EACJE,MAAM;EACNC,aAAa;EACbC,MAAM;EACNC,QAAQ;EACRC,MAAM;IAAC;;AACT;",
-  "names": ["DEBUG_PLUGIN", "id", "name", "description", "icon", "source", "tags"]
-}

package/dist/lib/browser/meta.mjs

@@ -1,9 +0,0 @@
-import {
-  DEBUG_PLUGIN,
-  meta_default
-} from "./chunk-CAENAAHY.mjs";
-export {
-  DEBUG_PLUGIN,
-  meta_default as default
-};
-//# sourceMappingURL=meta.mjs.map

package/dist/lib/browser/meta.mjs.map

@@ -1,7 +0,0 @@
-{
-  "version": 3,
-  "sources": [],
-  "sourcesContent": [],
-  "mappings": "",
-  "names": []
-}

package/dist/types/src/components/DebugSurface.d.ts

@@ -1,9 +0,0 @@
-import React from 'react';
-import { type ThemedClassName } from '@dxos/react-ui';
-export type SurfaceDebugProps = ThemedClassName<{}>;
-/**
- * Show surface info.
- * NOTE: Remove from @dxos/app-framework if removing this.
- */
-export declare const DebugSurface: ({ classNames }: SurfaceDebugProps) => React.JSX.Element;
-//# sourceMappingURL=DebugSurface.d.ts.map

package/dist/types/src/components/DebugSurface.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"DebugSurface.d.ts","sourceRoot":"","sources":["../../../../src/components/DebugSurface.tsx"],"names":[],"mappings":"AAIA,OAAO,KAA4B,MAAM,OAAO,CAAC;AAGjD,OAAO,EAAgB,KAAK,eAAe,EAAE,MAAM,gBAAgB,CAAC;AAKpE,MAAM,MAAM,iBAAiB,GAAG,eAAe,CAAC,EAAE,CAAC,CAAC;AAEpD;;;GAGG;AACH,eAAO,MAAM,YAAY,mBAAoB,iBAAiB,sBAoC7D,CAAC"}

package/src/components/DebugSurface.tsx

@@ -1,55 +0,0 @@
-//
-// Copyright 2024 DXOS.org
-//
-
-import React, { useMemo, useState } from 'react';
-
-import { type DebugInfo, useSurfaceRoot } from '@dxos/app-framework';
-import { Button, Icon, type ThemedClassName } from '@dxos/react-ui';
-import { mx } from '@dxos/react-ui-theme';
-
-// TODO(burdon): Move to debug panel.
-
-export type SurfaceDebugProps = ThemedClassName<{}>;
-
-/**
- * Show surface info.
- * NOTE: Remove from @dxos/app-framework if removing this.
- */
-export const DebugSurface = ({ classNames }: SurfaceDebugProps) => {
-  const context = useSurfaceRoot();
-  const [surfaces, setSurfaces] = useState<DebugInfo[]>([]);
-  const renderMap = useMemo(() => new Map<string, { last: number; delta: number }>(), []);
-  const handleRefresh = () => {
-    if (context.debugInfo) {
-      setSurfaces(
-        Array.from(context.debugInfo.values())
-          .sort(({ created: a }, { created: b }) => a - b)
-          .map((surface) => {
-            const state = renderMap.get(surface.id) ?? { last: 0, delta: 0 };
-            renderMap.set(surface.id, { last: surface.renderCount, delta: surface.renderCount - state.last });
-            return surface;
-          }),
-      );
-    }
-  };
-
-  return (
-    <div className={mx('flex flex-col border border-separator overflow-hidden bg-modalSurface', classNames)}>
-      <div className='flex flex-col h-full w-full p-2'>
-        {surfaces.map(({ id, role, renderCount }) => (
-          <div key={id} className='grid grid-cols-[1fr_3rem_3rem] items-center text-xs font-mono whitespace-nowrap'>
-            <span className='px-1 truncate'>{role}</span>
-            <span className='px-1 text-right'>{renderCount}</span>
-            <span className='px-1 text-right'>{renderMap.get(id)?.delta}</span>
-          </div>
-        ))}
-      </div>
-      <div className='flex justify-center text-sm items-center'>
-        <Button onClick={handleRefresh}>
-          <Icon icon='ph--arrow-clockwise--regular' size={4} />
-        </Button>
-      </div>
-    </div>
-  );
-};