@dxos/app-framework 0.8.4-main.c4373fc → 0.8.4-main.cb12b3f963

package/src/react/Surface.tsx

@@ -1,86 +0,0 @@
-//
-// Copyright 2025 DXOS.org
-//
-
-import React, {
-  Fragment,
-  type NamedExoticComponent,
-  type RefAttributes,
-  Suspense,
-  forwardRef,
-  memo,
-  useMemo,
-} from 'react';
-
-import { useDefaultValue } from '@dxos/react-hooks';
-import { byPosition } from '@dxos/util';
-
-import { Capabilities, type SurfaceDefinition, type SurfaceProps } from '../common';
-import { type PluginContext } from '../core';
-
-import { ErrorBoundary } from './ErrorBoundary';
-import { useCapabilities } from './useCapabilities';
-
-const DEFAULT_PLACEHOLDER = <Fragment />;
-
-/**
- * @internal
- */
-export const useSurfaces = () => {
-  const surfaces = useCapabilities(Capabilities.ReactSurface);
-  return useMemo(() => surfaces.flat(), [surfaces]);
-};
-
-const findCandidates = (surfaces: SurfaceDefinition[], { role, data }: Pick<SurfaceProps, 'role' | 'data'>) => {
-  return Object.values(surfaces)
-    .filter((definition) =>
-      Array.isArray(definition.role) ? definition.role.includes(role) : definition.role === role,
-    )
-    .filter(({ filter }) => (filter ? filter(data ?? {}) : true))
-    .toSorted(byPosition);
-};
-
-/**
- * @returns `true` if there is a contributed surface which matches the specified role & data, `false` otherwise.
- */
-export const isSurfaceAvailable = (context: PluginContext, { role, data }: Pick<SurfaceProps, 'role' | 'data'>) => {
-  const surfaces = context.getCapabilities(Capabilities.ReactSurface);
-  const candidates = findCandidates(surfaces.flat(), { role, data });
-  return candidates.length > 0;
-};
-
-/**
- * A surface is a named region of the screen that can be populated by plugins.
- */
-export const Surface: NamedExoticComponent<SurfaceProps & RefAttributes<HTMLElement>> = memo(
-  forwardRef(
-    ({ id: _id, role, data: _data, limit, fallback, placeholder = DEFAULT_PLACEHOLDER, ...rest }, forwardedRef) => {
-      // TODO(wittjosiah): This will make all surfaces depend on a single signal.
-      //   This isn't ideal because it means that any change to the data will cause all surfaces to re-render.
-      //   This effectively means that plugin modules which contribute surfaces need to all be activated at startup.
-      //   This should be fine for now because it's how it worked prior to capabilities api anyways.
-      //   In the future, it would be nice to be able to bucket the surface contributions by role.
-      const surfaces = useSurfaces();
-      const data = useDefaultValue(_data, () => ({}));
-
-      // NOTE: Memoizing the candidates makes the surface not re-render based on reactivity within data.
-      const definitions = findCandidates(surfaces, { role, data });
-      const candidates = limit ? definitions.slice(0, limit) : definitions;
-      const nodes = candidates.map(({ component: Component, id }) => (
-        <Component ref={forwardedRef} key={id} id={id} role={role} data={data} limit={limit} {...rest} />
-      ));
-
-      const suspense = <Suspense fallback={placeholder}>{nodes}</Suspense>;
-
-      return fallback ? (
-        <ErrorBoundary data={data} fallback={fallback}>
-          {suspense}
-        </ErrorBoundary>
-      ) : (
-        suspense
-      );
-    },
-  ),
-);
-
-Surface.displayName = 'Surface';

package/src/react/common.ts

@@ -1,13 +0,0 @@
-//
-// Copyright 2025 DXOS.org
-//
-
-import { Capabilities } from '../common';
-
-import { useCapability } from './useCapabilities';
-
-export const useIntentDispatcher = () => useCapability(Capabilities.IntentDispatcher);
-
-export const useAppGraph = () => useCapability(Capabilities.AppGraph);
-
-export const useLayout = () => useCapability(Capabilities.Layout);

package/src/react/index.ts

@@ -1,10 +0,0 @@
-//
-// Copyright 2023 DXOS.org
-//
-
-export * from './common';
-export * from './ErrorBoundary';
-export * from './PluginManagerProvider';
-export * from './Surface';
-export * from './useCapabilities';
-export * from './useIntentResolver';

package/src/react/useCapabilities.ts

@@ -1,31 +0,0 @@
-//
-// Copyright 2025 DXOS.org
-//
-
-import { useRxValue } from '@effect-rx/rx-react';
-
-import { invariant } from '@dxos/invariant';
-
-import { type InterfaceDef } from '../core';
-
-import { usePluginManager } from './PluginManagerProvider';
-
-/**
- * Hook to request capabilities from the plugin context.
- * @returns An array of capabilities.
- */
-export const useCapabilities = <T>(interfaceDef: InterfaceDef<T>) => {
-  const manager = usePluginManager();
-  return useRxValue(manager.context.capabilities(interfaceDef));
-};
-
-/**
- * Hook to request a capability from the plugin context.
- * @returns The capability.
- * @throws If no capability is found.
- */
-export const useCapability = <T>(interfaceDef: InterfaceDef<T>) => {
-  const capabilities = useCapabilities(interfaceDef);
-  invariant(capabilities.length > 0, `No capability found for ${interfaceDef.identifier}`);
-  return capabilities[0];
-};

package/src/react/useIntentResolver.ts

@@ -1,22 +0,0 @@
-//
-// Copyright 2023 DXOS.org
-//
-
-import { useEffect } from 'react';
-
-import { Capabilities } from '../common';
-import { type AnyIntentResolver } from '../plugin-intent';
-import { usePluginManager } from '../react';
-
-export const useIntentResolver = (module: string, resolver: AnyIntentResolver) => {
-  const manager = usePluginManager();
-  useEffect(() => {
-    manager.context.contributeCapability({
-      module,
-      interface: Capabilities.IntentResolver,
-      implementation: resolver,
-    });
-
-    return () => manager.context.removeCapability(Capabilities.IntentResolver, resolver);
-  }, [module, resolver]);
-};

package/src/worker.ts

@@ -1,11 +0,0 @@
-//
-// Copyright 2025 DXOS.org
-//
-
-// Entrypoint for using plugins in workers runtimes (e.g. Cloudflare Workers, etc.)
-// Excludes all frontend code & dependencies (e.g. localStorage, React, etc.)
-
-export * from './core';
-// NOTE: Common includes browser capabilities but they are types only.
-export * from './common';
-export * from './plugin-intent';