@dxos/app-framework 0.7.4 → 0.7.5-labs.071a3e2

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

@@ -1,60 +0,0 @@
-//
-// Copyright 2023 DXOS.org
-//
-
-import { createContext, useContext, type JSX, type ForwardedRef } from 'react';
-
-import { raise } from '@dxos/debug';
-
-import { type SurfaceProps } from './Surface';
-
-// TODO(wittjosiah): Factor out.
-type WithRequiredProperty<Type, Key extends keyof Type> = Type & {
-  [Property in Key]-?: Type[Property];
-};
-
-type SurfaceComponentProps = WithRequiredProperty<SurfaceProps, 'data'>;
-
-/**
- * Determines the priority of the surface when multiple components are resolved.
- */
-export type SurfaceDisposition = 'hoist' | 'fallback';
-
-/**
- * Surface debug info.
- * NOTE: Short-term measure to track perf issues.
- */
-export type DebugInfo = {
-  id: string;
-  created: number;
-  renderCount: number;
-} & Pick<SurfaceProps, 'role' | 'name'>;
-
-export type SurfaceResult = {
-  node: JSX.Element;
-  disposition?: SurfaceDisposition;
-};
-
-/**
- * Function that resolves a Surface.
- * If a null value is returned, the rendering is deferred to other plugins.
- */
-export type SurfaceComponent = (
-  props: SurfaceComponentProps,
-  forwardedRef: ForwardedRef<HTMLElement>,
-) => JSX.Element | SurfaceResult | null;
-
-export type SurfaceRootContext = {
-  components: Record<string, SurfaceComponent>;
-
-  /**
-   * Debug info.
-   */
-  debugInfo?: Map<string, DebugInfo>;
-};
-
-const SurfaceRootContext = createContext<SurfaceRootContext | undefined>(undefined);
-
-export const useSurfaceRoot = () => useContext(SurfaceRootContext) ?? raise(new Error('Missing SurfaceRootContext'));
-
-export const SurfaceProvider = SurfaceRootContext.Provider;

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 './SurfaceRootContext';
-
-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,26 +0,0 @@
-//
-// Copyright 2023 DXOS.org
-//
-
-import { type SurfaceComponent, type SurfaceRootContext } from './SurfaceRootContext';
-import { type Plugin } from '../plugin-host';
-
-// TODO(burdon): Predicate based providers?
-export type SurfaceProvides = {
-  surface: {
-    /**
-     * Used by the `Surface` resolver to find a component to render.
-     */
-    component: SurfaceComponent;
-  };
-};
-
-export type SurfacePluginProvides = {
-  surface: SurfaceRootContext;
-};
-
-export const parseRootSurfacePlugin = (plugin?: Plugin) =>
-  (plugin?.provides as any)?.surface?.components ? (plugin as Plugin<SurfacePluginProvides>) : undefined;
-
-export const parseSurfacePlugin = (plugin?: Plugin) =>
-  (plugin?.provides as any)?.surface?.component ? (plugin as Plugin<SurfaceProvides>) : undefined;