@dxos/app-framework 0.7.5-main.9cb18ac → 0.7.5-main.9d2a38b

package/src/plugins/plugin-surface/Surface.tsx

@@ -1,62 +0,0 @@
-//
-// Copyright 2022 DXOS.org
-//
-
-import React, { Suspense, forwardRef, memo, useEffect, useId, useMemo } from 'react';
-
-import { useDefaultValue } from '@dxos/react-hooks';
-
-import { ErrorBoundary } from './ErrorBoundary';
-import { type SurfaceProps, useSurfaceRoot } from './SurfaceContext';
-
-/**
- * A surface is a named region of the screen that can be populated by plugins.
- */
-export const Surface = memo(
-  forwardRef<HTMLElement, SurfaceProps>(
-    ({ id: _id, role, data: _data, limit, fallback, placeholder, ...rest }, forwardedRef) => {
-      const { surfaces, debugInfo } = useSurfaceRoot();
-      const data = useDefaultValue(_data, () => ({}));
-
-      // Track debug info.
-      const reactId = useId();
-      const id = _id ?? reactId;
-      useEffect(() => {
-        debugInfo?.set(id, { id, created: Date.now(), role, renderCount: 0 });
-        return () => {
-          debugInfo?.delete(id);
-        };
-      }, [id]);
-
-      if (debugInfo?.get(id)) {
-        debugInfo.get(id)!.renderCount++;
-      }
-
-      const candidates = useMemo(() => {
-        const definitions = Object.values(surfaces)
-          .filter((definition) =>
-            Array.isArray(definition.role) ? definition.role.includes(role) : definition.role === role,
-          )
-          .filter(({ filter }) => (filter ? filter(data) : true))
-          .toSorted(({ disposition: a = 'static' }, { disposition: b = 'static' }) => {
-            return a === b ? 0 : a === 'hoist' || b === 'fallback' ? -1 : b === 'hoist' || a === 'fallback' ? 1 : 0;
-          });
-        return limit ? definitions.slice(0, limit) : definitions;
-      }, [surfaces, role, data, limit]);
-
-      const nodes = candidates.map(({ component: Component, id }) => (
-        <Component ref={forwardedRef} key={id} id={id} role={role} data={data} limit={limit} {...rest} />
-      ));
-
-      const suspense = placeholder ? <Suspense fallback={placeholder}>{nodes}</Suspense> : nodes;
-
-      return fallback ? (
-        <ErrorBoundary data={data} fallback={fallback}>
-          {suspense}
-        </ErrorBoundary>
-      ) : (
-        suspense
-      );
-    },
-  ),
-);

package/src/plugins/plugin-surface/SurfacePlugin.tsx

@@ -1,45 +0,0 @@
-//
-// Copyright 2023 DXOS.org
-//
-
-import React from 'react';
-
-import { create } from '@dxos/live-object';
-
-import { SurfaceProvider, type SurfaceContextValue } from './SurfaceContext';
-import SurfaceMeta from './meta';
-import { parseSurfacePlugin, type SurfacePluginProvides, type SurfaceDefinitions } from './provides';
-import { filterPlugins } from '../helpers';
-import { type PluginDefinition } from '../plugin-host';
-
-/**
- * Provides a registry of surface components.
- */
-export const SurfacePlugin = (): PluginDefinition<SurfacePluginProvides> => {
-  const state = create<SurfaceContextValue>({ surfaces: {}, debugInfo: new Map() });
-
-  return {
-    meta: SurfaceMeta,
-    ready: async (context) => {
-      state.surfaces = filterPlugins(context.plugins, parseSurfacePlugin).reduce(
-        (acc, plugin) => reduceSurfaces(plugin.provides.surface.definitions(context), acc),
-        {},
-      );
-    },
-    provides: {
-      surface: state,
-      context: ({ children }) => <SurfaceProvider value={state}>{children}</SurfaceProvider>,
-    },
-  };
-};
-
-const reduceSurfaces = (
-  definitions: SurfaceDefinitions,
-  surfaces: SurfaceContextValue['surfaces'] = {},
-): SurfaceContextValue['surfaces'] => {
-  if (Array.isArray(definitions)) {
-    return definitions.reduce((acc, definition) => reduceSurfaces(definition, acc), surfaces);
-  }
-
-  return { ...surfaces, [definitions.id]: definitions };
-};

package/src/plugins/plugin-surface/helpers.ts

@@ -1,22 +0,0 @@
-//
-// Copyright 2023 DXOS.org
-//
-
-/**
- * Checks if the given data is an object and not null.
- *
- * Useful inside surface component resolvers as a type guard.
- *
- * @example
- * ```ts
- *  const old =
- *    data.content &&
- *      typeof data.content === 'object' &&
- *      'id' in data.content &&
- *      typeof data.content.id === 'string';
- *
- *  // becomes
- *  const new = isObject(data.content) && typeof data.content.id === 'string';
- * ```
- */
-export const isObject = (data: unknown): data is { [key: string]: unknown } => !!data && typeof data === 'object';

package/src/plugins/plugin-surface/index.ts

@@ -1,14 +0,0 @@
-//
-// Copyright 2023 DXOS.org
-//
-
-import { SurfacePlugin } from './SurfacePlugin';
-
-export * from './helpers';
-export * from './provides';
-
-export * from './ErrorBoundary';
-export * from './Surface';
-export * from './SurfaceContext';
-
-export default SurfacePlugin;

package/src/plugins/plugin-surface/meta.ts

@@ -1,9 +0,0 @@
-//
-// Copyright 2023 DXOS.org
-//
-
-const SurfaceMeta = {
-  id: 'dxos.org/plugin/surface',
-};
-
-export default SurfaceMeta;

package/src/plugins/plugin-surface/provides.ts

@@ -1,27 +0,0 @@
-//
-// Copyright 2023 DXOS.org
-//
-
-import { type SurfaceDefinition, type SurfaceContextValue } from './SurfaceContext';
-import { type HostContext, type Plugin } from '../plugin-host';
-
-export type SurfaceDefinitions = SurfaceDefinition | SurfaceDefinition[] | SurfaceDefinitions[];
-
-export type SurfaceProvides = {
-  surface: {
-    /**
-     * Used by the `Surface` resolver to find a component to render.
-     */
-    definitions: (context: HostContext) => SurfaceDefinitions;
-  };
-};
-
-export type SurfacePluginProvides = {
-  surface: SurfaceContextValue;
-};
-
-export const parseRootSurfacePlugin = (plugin?: Plugin) =>
-  (plugin?.provides as any)?.surface?.surfaces ? (plugin as Plugin<SurfacePluginProvides>) : undefined;
-
-export const parseSurfacePlugin = (plugin?: Plugin) =>
-  (plugin?.provides as any)?.surface?.definitions ? (plugin as Plugin<SurfaceProvides>) : undefined;