@dxos/app-framework 0.8.4-main.ef1bc66f44 → 0.8.4-main.effb148878

package/dist/types/src/ui/components/surface/types.d.ts

@@ -1,94 +0,0 @@
-import type { PropsWithChildren, ReactNode, RefCallback } from 'react';
-import type { MakeOptional, Position } from '@dxos/util';
-import type { ErrorBoundary } from '..';
-/**
- * Props that are passed to the Surface component.
- */
-export type Props<T extends Record<string, any> = Record<string, unknown>> = {
-    /**
-     * If specified, the Surface will be wrapped in an error boundary.
-     * The fallback component will be rendered if an error occurs.
-     */
-    fallback?: ErrorBoundary['props']['fallback'];
-    /**
-     * If specified, the Surface will be wrapped in a suspense boundary.
-     * The placeholder component will be rendered while the surface component is loading.
-     */
-    placeholder?: ReactNode;
-} & MakeOptional<CoreProps<T>, 'id' | 'data'> & 
-/**
- * Additional props to pass to the component.
- * These props are not used by Surface itself but may be used by components which resolve the surface.
- * Exclude known prop names to prevent overriding well-defined props.
- */
-{
-    [K in keyof Record<string, any>]: K extends keyof CoreProps<T> | 'fallback' | 'placeholder' ? never : any;
-};
-/**
- * NOTE: If `[key: string]: unknown` is included in shared types, when re-used other fields become unknown as well.
- */
-export type CoreProps<T extends Record<string, any> = Record<string, unknown>> = PropsWithChildren<{
-    /**
-     * ID for debugging.
-     */
-    id: string;
-    /**
-     * Role defines how the data should be rendered.
-     */
-    role: string;
-    /**
-     * The data to be rendered by the surface.
-     * NOTE: This must be a stable value.
-     */
-    data: T;
-    /**
-     * If more than one component is resolved, the limit determines how many are rendered.
-     */
-    limit?: number | undefined;
-}>;
-export type ComponentProps<T extends Record<string, any> = Record<string, any>> = CoreProps<T> & {
-    ref?: RefCallback<HTMLElement>;
-} & Record<string, any>;
-/**
- * React component used to render a surface once is has matched.
- */
-export type ComponentFunction<T extends Record<string, any> = Record<string, any>> = (props: ComponentProps<T>) => ReactNode;
-/**
- * Definition of when a React component surface should be rendered.
- */
-export type ReactDefinition<T extends Record<string, any> = any> = Readonly<{
-    kind: 'react';
-    id: string;
-    role: string | string[];
-    position?: Position;
-    component: ComponentFunction<T>;
-    filter?: (data: Record<string, unknown>) => data is T;
-}>;
-/**
- * Definition of when a Web Component surface should be rendered.
- */
-export type WebComponentDefinition<T extends Record<string, any> = any> = Readonly<{
-    kind: 'web-component';
-    id: string;
-    role: string | string[];
-    position?: Position;
-    /**
-     * The tag name of the Web Component to render.
-     * The Web Component will receive the same props as React surfaces via properties/attributes.
-     */
-    tagName: string;
-    filter?: (data: Record<string, unknown>) => data is T;
-}>;
-/**
- * Definition of when a surface (React or Web Component) should be rendered.
- */
-export type Definition<T extends Record<string, any> = any> = ReactDefinition<T> | WebComponentDefinition<T>;
-/**
- * Creates a React surface definition.
- */
-export declare const create: <T extends Record<string, any> = any>(definition: Omit<ReactDefinition<T>, "kind">) => ReactDefinition<T>;
-/**
- * Creates a Web Component surface definition.
- */
-export declare const createWeb: <T extends Record<string, any> = any>(definition: Omit<WebComponentDefinition<T>, "kind">) => WebComponentDefinition<T>;
-//# sourceMappingURL=types.d.ts.map

package/dist/types/src/ui/components/surface/types.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../../../../src/ui/components/surface/types.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAE,iBAAiB,EAAE,SAAS,EAAE,WAAW,EAAE,MAAM,OAAO,CAAC;AAEvE,OAAO,KAAK,EAAE,YAAY,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAEzD,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,IAAI,CAAC;AAExC;;GAEG;AACH,MAAM,MAAM,KAAK,CAAC,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,IAAI;IAC3E;;;OAGG;IACH,QAAQ,CAAC,EAAE,aAAa,CAAC,OAAO,CAAC,CAAC,UAAU,CAAC,CAAC;IAE9C;;;OAGG;IACH,WAAW,CAAC,EAAE,SAAS,CAAC;CACzB,GAAG,YAAY,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,IAAI,GAAG,MAAM,CAAC;AAC3C;;;;GAIG;AACH;KACG,CAAC,IAAI,MAAM,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,CAAC,SAAS,MAAM,SAAS,CAAC,CAAC,CAAC,GAAG,UAAU,GAAG,aAAa,GAAG,KAAK,GAAG,GAAG;CAC1G,CAAC;AAEJ;;GAEG;AACH,MAAM,MAAM,SAAS,CAAC,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,IAAI,iBAAiB,CAAC;IACjG;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;;OAGG;IACH,IAAI,EAAE,CAAC,CAAC;IAER;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;CAC5B,CAAC,CAAC;AAGH,MAAM,MAAM,cAAc,CAAC,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,IAAI,SAAS,CAAC,CAAC,CAAC,GAAG;IAC/F,GAAG,CAAC,EAAE,WAAW,CAAC,WAAW,CAAC,CAAC;CAChC,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;AAExB;;GAEG;AACH,MAAM,MAAM,iBAAiB,CAAC,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,IAAI,CACnF,KAAK,EAAE,cAAc,CAAC,CAAC,CAAC,KACrB,SAAS,CAAC;AAEf;;GAEG;AACH,MAAM,MAAM,eAAe,CAAC,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,GAAG,IAAI,QAAQ,CAAC;IAC1E,IAAI,EAAE,OAAO,CAAC;IACd,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,GAAG,MAAM,EAAE,CAAC;IACxB,QAAQ,CAAC,EAAE,QAAQ,CAAC;IACpB,SAAS,EAAE,iBAAiB,CAAC,CAAC,CAAC,CAAC;IAChC,MAAM,CAAC,EAAE,CAAC,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,KAAK,IAAI,IAAI,CAAC,CAAC;CACvD,CAAC,CAAC;AAEH;;GAEG;AACH,MAAM,MAAM,sBAAsB,CAAC,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,GAAG,IAAI,QAAQ,CAAC;IACjF,IAAI,EAAE,eAAe,CAAC;IACtB,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,GAAG,MAAM,EAAE,CAAC;IACxB,QAAQ,CAAC,EAAE,QAAQ,CAAC;IACpB;;;OAGG;IACH,OAAO,EAAE,MAAM,CAAC;IAChB,MAAM,CAAC,EAAE,CAAC,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,KAAK,IAAI,IAAI,CAAC,CAAC;CACvD,CAAC,CAAC;AAEH;;GAEG;AACH,MAAM,MAAM,UAAU,CAAC,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,GAAG,IAAI,eAAe,CAAC,CAAC,CAAC,GAAG,sBAAsB,CAAC,CAAC,CAAC,CAAC;AAE7G;;GAEG;AACH,eAAO,MAAM,MAAM,GAAI,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,GAAG,EACxD,YAAY,IAAI,CAAC,eAAe,CAAC,CAAC,CAAC,EAAE,MAAM,CAAC,KAC3C,eAAe,CAAC,CAAC,CAAuC,CAAC;AAE5D;;GAEG;AACH,eAAO,MAAM,SAAS,GAAI,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,GAAG,EAC3D,YAAY,IAAI,CAAC,sBAAsB,CAAC,CAAC,CAAC,EAAE,MAAM,CAAC,KAClD,sBAAsB,CAAC,CAAC,CAA+C,CAAC"}

package/dist/types/src/ui/hooks/useOperationResolver.d.ts

@@ -1,19 +0,0 @@
-import { Capabilities } from '../../common';
-/**
- * Hook to dynamically register an operation resolver (handler) within a React component.
- * The resolver is added when the component mounts and removed when it unmounts.
- *
- * @example
- * ```tsx
- * const scrollHandler = useMemo(() => OperationResolver.make({
- *   operation: LayoutOperation.ScrollIntoView,
- *   handler: (input) => Effect.sync(() => {
- *     // Handle scroll
- *   }),
- * }), [deps]);
- *
- * useOperationResolver(meta.id, scrollHandler);
- * ```
- */
-export declare const useOperationResolver: (module: string, resolver: Capabilities.OperationResolver) => void;
-//# sourceMappingURL=useOperationResolver.d.ts.map

package/dist/types/src/ui/hooks/useOperationResolver.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"useOperationResolver.d.ts","sourceRoot":"","sources":["../../../../../src/ui/hooks/useOperationResolver.ts"],"names":[],"mappings":"AAMA,OAAO,EAAE,YAAY,EAAE,MAAM,cAAc,CAAC;AAG5C;;;;;;;;;;;;;;;GAeG;AACH,eAAO,MAAM,oBAAoB,GAAI,QAAQ,MAAM,EAAE,UAAU,YAAY,CAAC,iBAAiB,SAc5F,CAAC"}

package/src/plugin-operation/OperationPlugin.ts

@@ -1,25 +0,0 @@
-//
-// Copyright 2025 DXOS.org
-//
-
-import { ActivationEvents } from '../common';
-import { Capability, Plugin } from '../core';
-
-import { meta } from './meta';
-
-const OperationInvoker = Capability.lazy('OperationInvoker', () => import('./invoker-capability'));
-const HistoryCapabilities = Capability.lazy('HistoryCapabilities', () => import('./history/capability'));
-
-export const OperationPlugin = Plugin.define(meta).pipe(
-  Plugin.addModule({
-    activatesOn: ActivationEvents.ManagedRuntimeReady,
-    activatesBefore: [ActivationEvents.SetupOperationResolver],
-    activatesAfter: [ActivationEvents.OperationInvokerReady],
-    activate: OperationInvoker,
-  }),
-  Plugin.addModule({
-    activatesOn: ActivationEvents.OperationInvokerReady,
-    activate: HistoryCapabilities,
-  }),
-  Plugin.make,
-);

package/src/plugin-operation/history/errors.ts

@@ -1,11 +0,0 @@
-//
-// Copyright 2025 DXOS.org
-//
-
-import { OperationError } from '@dxos/operation';
-
-export class EmptyHistoryError extends OperationError {
-  constructor() {
-    super('EMPTY_HISTORY', 'Cannot undo: history is empty.');
-  }
-}

package/src/plugin-operation/invoker-capability.ts

@@ -1,40 +0,0 @@
-//
-// Copyright 2025 DXOS.org
-//
-
-import * as Effect from 'effect/Effect';
-
-import { OperationInvoker } from '@dxos/operation';
-
-import { ActivationEvents, Capabilities } from '../common';
-import { Capability, Plugin } from '../core';
-
-//
-// Capability Module
-//
-
-export default Capability.makeModule(
-  Effect.fnUntraced(function* () {
-    // Get the services for synchronous access in callbacks.
-    const capabilityManager = yield* Capability.Service;
-    const pluginManager = yield* Plugin.Service;
-
-    // Get the ManagedRuntime capability (should be available since we activate after ManagedRuntimeReady).
-    const managedRuntimes = yield* Capability.getAll(Capabilities.ManagedRuntime);
-    const managedRuntime = managedRuntimes.length > 0 ? managedRuntimes[0] : undefined;
-
-    const invoker = OperationInvoker.make(
-      () =>
-        Effect.gen(function* () {
-          yield* Plugin.activate(ActivationEvents.SetupOperationResolver);
-          return (yield* Capability.getAll(Capabilities.OperationResolver)).flat();
-        }).pipe(
-          Effect.provideService(Capability.Service, capabilityManager),
-          Effect.provideService(Plugin.Service, pluginManager),
-        ),
-      managedRuntime,
-    );
-
-    return Capability.contributes(Capabilities.OperationInvoker, invoker);
-  }),
-);

package/src/plugin-operation/meta.ts

@@ -1,11 +0,0 @@
-//
-// Copyright 2025 DXOS.org
-//
-
-import { type Plugin } from '../core';
-
-export const meta: Plugin.Meta = {
-  id: 'dxos.org/plugin/operation',
-  name: 'Operation Plugin',
-  description: 'Provides operation invocation, undo registry, and history tracking.',
-};

package/src/plugin-runtime/RuntimePlugin.ts

@@ -1,20 +0,0 @@
-//
-// Copyright 2025 DXOS.org
-//
-
-import { ActivationEvents } from '../common';
-import { Capability, Plugin } from '../core';
-
-import { meta } from './meta';
-
-const ManagedRuntimeCapability = Capability.lazy('ManagedRuntime', () => import('./capability'));
-
-export const RuntimePlugin = Plugin.define(meta).pipe(
-  Plugin.addModule({
-    activatesOn: ActivationEvents.Startup,
-    activatesBefore: [ActivationEvents.SetupLayer],
-    activatesAfter: [ActivationEvents.ManagedRuntimeReady],
-    activate: ManagedRuntimeCapability,
-  }),
-  Plugin.make,
-);

package/src/plugin-runtime/capability.ts

@@ -1,53 +0,0 @@
-//
-// Copyright 2025 DXOS.org
-//
-
-import * as Effect from 'effect/Effect';
-import * as Layer from 'effect/Layer';
-import * as ManagedRuntime from 'effect/ManagedRuntime';
-
-import { ActivationEvents, Capabilities } from '../common';
-import { Capability, Plugin } from '../core';
-
-//
-// Capability Module
-//
-
-export default Capability.makeModule(
-  Effect.fnUntraced(function* () {
-    // Get the CapabilityManager to create a layer for it.
-    const capabilityManager = yield* Capability.Service;
-
-    // Get the PluginManager to create a layer for it.
-    const pluginManager = yield* Plugin.Service;
-
-    // Trigger setup event so plugins can contribute their layers.
-    yield* Plugin.activate(ActivationEvents.SetupLayer);
-
-    // Gather all contributed layers.
-    const layers = yield* Capability.getAll(Capabilities.Layer);
-
-    // Create layers that provide Capability.Service and Plugin.Service.
-    const capabilityServiceLayer = Layer.succeed(Capability.Service, capabilityManager);
-    const pluginServiceLayer = Layer.succeed(Plugin.Service, pluginManager);
-
-    // Merge all layers including service layers.
-    // Layer.mergeAll requires a tuple type, so we use a cast for dynamic arrays.
-    const composedLayer =
-      layers.length > 0
-        ? (Layer.mergeAll as (...args: Layer.Layer<any, any, any>[]) => Layer.Layer<any, any, never>)(
-            capabilityServiceLayer,
-            pluginServiceLayer,
-            ...layers,
-          )
-        : (Layer.mergeAll as (...args: Layer.Layer<any, any, any>[]) => Layer.Layer<any, any, never>)(
-            capabilityServiceLayer,
-            pluginServiceLayer,
-          );
-
-    // Create the managed runtime from the composed layer.
-    const runtime = ManagedRuntime.make(composedLayer) as Capabilities.ManagedRuntime;
-
-    return Capability.contributes(Capabilities.ManagedRuntime, runtime);
-  }),
-);

package/src/plugin-runtime/meta.ts

@@ -1,11 +0,0 @@
-//
-// Copyright 2025 DXOS.org
-//
-
-import { type Plugin } from '../core';
-
-export const meta: Plugin.Meta = {
-  id: 'dxos.org/plugin/runtime',
-  name: 'Runtime Plugin',
-  description: 'Provides a managed Effect runtime by composing contributed layers.',
-};

package/src/ui/components/App.stories.tsx

@@ -1,62 +0,0 @@
-//
-// Copyright 2022 DXOS.org
-//
-
-import { type Meta, type StoryObj } from '@storybook/react-vite';
-import * as Effect from 'effect/Effect';
-import React from 'react';
-
-import { withTheme } from '@dxos/react-ui/testing';
-
-import { ActivationEvents, Capabilities } from '../../common';
-import { Capability, Plugin } from '../../core';
-import { useApp } from '../hooks';
-
-// Minimal plugin that contributes a ReactRoot.
-const TestPlugin = Plugin.define({
-  id: 'dxos.org/plugin/test',
-  name: 'Test Plugin',
-}).pipe(
-  Plugin.addModule({
-    id: 'TestMain',
-    activatesOn: ActivationEvents.Startup,
-    activate: () =>
-      Effect.succeed([
-        Capability.contributes(Capabilities.ReactRoot, {
-          id: 'dxos.org/plugin/test/root',
-          root: () => (
-            <div className='fixed inset-0 flex items-center justify-center text-2xl'>App Started Successfully!</div>
-          ),
-        }),
-      ]),
-  }),
-  Plugin.make,
-);
-
-const plugins = [TestPlugin()];
-const core = [TestPlugin.meta.id];
-
-const DefaultStory = () => {
-  const App = useApp({
-    plugins,
-    core,
-    placeholder: () => <div className='fixed inset-0 flex items-center justify-center'>Loading...</div>,
-  });
-
-  return <App />;
-};
-
-const meta = {
-  title: 'sdk/app-framework/App',
-  render: DefaultStory,
-  decorators: [withTheme()],
-  parameters: {
-    layout: 'fullscreen',
-  },
-} satisfies Meta;
-
-export default meta;
-
-type Story = StoryObj<typeof meta>;
-
-export const Default: Story = {};

package/src/ui/components/App.tsx

@@ -1,57 +0,0 @@
-//
-// Copyright 2025 DXOS.org
-//
-
-import React, { type PropsWithChildren } from 'react';
-
-import { Capabilities } from '../../common';
-import { topologicalSort } from '../../helpers';
-import { LoadingState, type UseAppOptions, useCapabilities, useLoading } from '../hooks';
-
-export type AppProps = Pick<UseAppOptions, 'placeholder' | 'debounce'> & {
-  ready: boolean;
-  error: unknown;
-};
-
-export const App = ({ placeholder: Placeholder, ready, error, debounce }: AppProps) => {
-  const reactContexts = useCapabilities(Capabilities.ReactContext);
-  const reactRoots = useCapabilities(Capabilities.ReactRoot);
-  const stage = useLoading(ready, debounce);
-
-  if (error) {
-    // This triggers the error boundary to provide UI feedback for the startup error.
-    throw error;
-  }
-
-  // TODO(wittjosiah): Consider using Suspense instead.
-  if (stage < LoadingState.Done) {
-    if (!Placeholder) {
-      return null;
-    }
-
-    return <Placeholder stage={stage} />;
-  }
-
-  const ComposedContext = composeContexts(reactContexts);
-  return (
-    <ComposedContext>
-      {reactRoots.map(({ id, root: Component }) => (
-        <Component key={id} />
-      ))}
-    </ComposedContext>
-  );
-};
-
-const composeContexts = (contexts: Capabilities.ReactContext[]) => {
-  if (contexts.length === 0) {
-    return ({ children }: PropsWithChildren) => <>{children}</>;
-  }
-
-  return topologicalSort(contexts)
-    .map(({ context }) => context)
-    .reduce((Acc, Next) => ({ children }) => (
-      <Acc>
-        <Next>{children}</Next>
-      </Acc>
-    ));
-};

package/src/ui/components/DefaultFallback.tsx

@@ -1,26 +0,0 @@
-//
-// Copyright 2025 DXOS.org
-//
-
-import React from 'react';
-
-/**
- * NOTE: Default fallback should not use tailwind or theme.
- */
-export const DefaultFallback = ({ error }: { error: Error }) => {
-  return (
-    <div
-      style={{
-        margin: '1rem',
-        padding: '1rem',
-        overflow: 'hidden',
-        border: '4px solid teal',
-        borderRadius: '1rem',
-      }}
-    >
-      {/* TODO(wittjosiah): Link to docs for replacing default. */}
-      <h1 style={{ margin: '0.5rem 0', fontSize: '1.2rem' }}>ERROR: {error.message}</h1>
-      <pre style={{ overflow: 'auto', fontSize: '1rem', whiteSpace: 'pre-wrap', color: '#888888' }}>{error.stack}</pre>
-    </div>
-  );
-};

package/src/ui/components/ErrorBoundary.tsx

@@ -1,56 +0,0 @@
-//
-// Copyright 2023 DXOS.org
-//
-
-import React, { Component, type FC, type PropsWithChildren, type ReactNode } from 'react';
-
-type State = {
-  error: Error | undefined;
-};
-
-export type ErrorBoundaryProps = PropsWithChildren<{
-  data?: any;
-  fallback?: FC<{ data?: any; error: Error }>;
-}>;
-
-/**
- * Surface error boundary.
- * For basic usage prefer providing a fallback component to `Surface`.
- *
- * Ref: https://react.dev/reference/react/Component#catching-rendering-errors-with-an-error-boundary
- */
-export class ErrorBoundary extends Component<ErrorBoundaryProps, State> {
-  static getDerivedStateFromError(error: Error): { error: Error } {
-    return { error };
-  }
-
-  override state = { error: undefined };
-
-  override componentDidUpdate(prevProps: ErrorBoundaryProps): void {
-    if (prevProps.data !== this.props.data) {
-      this.resetError();
-    }
-  }
-
-  override render(): ReactNode {
-    if (this.state.error) {
-      const Fallback = this.props.fallback ?? DefaultFallback;
-      return <Fallback data={this.props.data} error={this.state.error} />;
-    }
-
-    return this.props.children;
-  }
-
-  private resetError(): void {
-    this.setState({ error: undefined });
-  }
-}
-
-const DefaultFallback: NonNullable<ErrorBoundaryProps['fallback']> = ({ data, error }) => {
-  return (
-    <div className='flex flex-col gap-2 overflow-hidden border border-red-500 rounded-sm'>
-      <h1 className='p-2'>ERROR: {error.message}</h1>
-      <pre className='p-2 overflow-y-auto text-sm text-subdued'>{JSON.stringify(data, null, 2)}</pre>
-    </div>
-  );
-};