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

package/src/playground/generator/Main.tsx

@@ -1,71 +0,0 @@
-//
-// Copyright 2025 DXOS.org
-//
-
-import React, { useCallback } from 'react';
-
-import { IconButton, List, ListItem } from '@dxos/react-ui';
-
-import { Capabilities } from '../../common';
-import { contributes } from '../../core';
-import { usePluginManager } from '../../react';
-
-const Item = ({
-  id,
-  disabled,
-  onRemove,
-}: {
-  id: string;
-  disabled: boolean;
-  onRemove: (id: string) => Promise<void>;
-}) => {
-  const handleRemove = useCallback(() => onRemove(id), [onRemove]);
-
-  return (
-    <ListItem.Root key={id} id={id}>
-      <ListItem.Heading classNames='grow pbs-2'>{id}</ListItem.Heading>
-      <ListItem.Endcap>
-        <IconButton
-          iconOnly
-          variant='ghost'
-          icon='ph--x--regular'
-          label='Remove'
-          size={5}
-          disabled={disabled}
-          onClick={handleRemove}
-        />
-      </ListItem.Endcap>
-    </ListItem.Root>
-  );
-};
-
-export const Main = () => {
-  const manager = usePluginManager();
-
-  const handleRemove = useCallback(
-    async (id: string) => {
-      await manager.remove(id);
-    },
-    [manager],
-  );
-
-  return (
-    <List itemSizes='one'>
-      {manager.plugins.map((plugin) => (
-        <Item
-          key={plugin.meta.id}
-          id={plugin.meta.id}
-          disabled={manager.core.includes(plugin.meta.id)}
-          onRemove={handleRemove}
-        />
-      ))}
-    </List>
-  );
-};
-
-export default () =>
-  contributes(Capabilities.ReactSurface, {
-    id: 'dxos.org/test/generator/main',
-    role: 'primary',
-    component: Main,
-  });

package/src/playground/generator/Toolbar.tsx

@@ -1,47 +0,0 @@
-//
-// Copyright 2025 DXOS.org
-//
-
-import React, { useCallback } from 'react';
-
-import { Button } from '@dxos/react-ui';
-
-import { Capabilities } from '../../common';
-import { contributes } from '../../core';
-import { createIntent } from '../../plugin-intent';
-import { useCapabilities, useIntentDispatcher, usePluginManager } from '../../react';
-
-import { Number, createGeneratorIntent, createPluginId } from './generator';
-
-export const Toolbar = () => {
-  const manager = usePluginManager();
-  const { dispatchPromise: dispatch } = useIntentDispatcher();
-
-  const handleAdd = useCallback(async () => {
-    const id = createPluginId(Math.random().toString(16).substring(2, 8));
-    await manager.add(id);
-  }, [manager]);
-
-  const count = useCapabilities(Number).reduce((acc, curr) => acc + curr, 0);
-
-  const generatorPlugins = manager.plugins.filter((plugin) => plugin.meta.id.startsWith('dxos.org/test/generator/'));
-
-  return (
-    <>
-      <Button onClick={handleAdd}>Add</Button>
-      <div className='flex items-center'>Count: {count}</div>
-      {generatorPlugins.map((plugin) => (
-        <Button key={plugin.meta.id} onClick={() => dispatch(createIntent(createGeneratorIntent(plugin.meta.id)))}>
-          {plugin.meta.id.replace('dxos.org/test/generator/', '')}
-        </Button>
-      ))}
-    </>
-  );
-};
-
-export default () =>
-  contributes(Capabilities.ReactSurface, {
-    id: 'dxos.org/test/generator/toolbar',
-    role: 'toolbar',
-    component: Toolbar,
-  });

package/src/playground/generator/generator.ts

@@ -1,48 +0,0 @@
-//
-// Copyright 2025 DXOS.org
-//
-
-import * as Schema from 'effect/Schema';
-
-import { Capabilities, Events } from '../../common';
-import { contributes, defineCapability, defineEvent, defineModule, definePlugin } from '../../core';
-import { type IntentSchema, createResolver } from '../../plugin-intent';
-
-export const Number = defineCapability<number>('dxos.org/test/generator/number');
-
-export const CountEvent = defineEvent('dxos.org/test/generator/count');
-
-export const createPluginId = (id: string) => `dxos.org/test/generator/${id}`;
-
-export const createGeneratorIntent = (id: string) => {
-  class Alert extends Schema.TaggedClass<Alert>()(`${createPluginId(id)}/action/alert`, {
-    input: Schema.Void,
-    output: Schema.Void,
-  }) {}
-
-  return Alert as unknown as IntentSchema<any, any>;
-};
-
-export const createNumberPlugin = (id: string) => {
-  const number = Math.floor(Math.random() * 100);
-
-  return definePlugin({ id, name: `Plugin ${id}` }, () => [
-    defineModule({
-      id: `${id}/main`,
-      activatesOn: CountEvent,
-      activate: () => contributes(Number, number),
-    }),
-    defineModule({
-      id: `${id}/intent-resolver`,
-      activatesOn: Events.SetupIntentResolver,
-      activate: () =>
-        contributes(
-          Capabilities.IntentResolver,
-          createResolver({
-            intent: createGeneratorIntent(id),
-            resolve: () => window.alert(JSON.stringify({ number })),
-          }),
-        ),
-    }),
-  ]);
-};

package/src/playground/generator/index.ts

@@ -1,6 +0,0 @@
-//
-// Copyright 2025 DXOS.org
-//
-
-export * from './plugin';
-export * from './generator';

package/src/playground/generator/plugin.ts

@@ -1,22 +0,0 @@
-//
-// Copyright 2025 DXOS.org
-//
-
-import { Events } from '../../common';
-import { defineModule, definePlugin, lazy } from '../../core';
-
-const Main = lazy(() => import('./Main'));
-const Toolbar = lazy(() => import('./Toolbar'));
-
-export const GeneratorPlugin = definePlugin({ id: 'dxos.org/test/generator', name: 'Generator' }, () => [
-  defineModule({
-    id: 'dxos.org/test/generator/main',
-    activatesOn: Events.Startup,
-    activate: Main,
-  }),
-  defineModule({
-    id: 'dxos.org/test/generator/toolbar',
-    activatesOn: Events.Startup,
-    activate: Toolbar,
-  }),
-]);

package/src/playground/layout/Layout.tsx

@@ -1,33 +0,0 @@
-//
-// Copyright 2025 DXOS.org
-//
-
-import React from 'react';
-
-import { Capabilities } from '../../common';
-import { contributes } from '../../core';
-import { Surface } from '../../react';
-
-export const Layout = () => {
-  return (
-    <div className='flex flex-col gap-2'>
-      <div className='flex gap-2'>
-        <Surface role='toolbar' />
-      </div>
-      <div className='flex gap-2'>
-        <div className='flex-1'>
-          <Surface role='primary' limit={1} />
-        </div>
-        <div className='flex-1'>
-          <Surface role='secondary' limit={1} />
-        </div>
-      </div>
-    </div>
-  );
-};
-
-export default () =>
-  contributes(Capabilities.ReactRoot, {
-    id: 'dxos.org/test/layout/root',
-    root: Layout,
-  });

package/src/playground/layout/index.ts

@@ -1,5 +0,0 @@
-//
-// Copyright 2025 DXOS.org
-//
-
-export * from './plugin';

package/src/playground/layout/plugin.ts

@@ -1,18 +0,0 @@
-//
-// Copyright 2025 DXOS.org
-//
-
-import { Events } from '../../common';
-import { defineModule, definePlugin, lazy } from '../../core';
-
-const Layout = lazy(() => import('./Layout'));
-
-const meta = { id: 'dxos.org/test/layout', name: 'Layout' };
-
-export const LayoutPlugin = definePlugin(meta, () => [
-  defineModule({
-    id: 'dxos.org/test/layout/root',
-    activatesOn: Events.Startup,
-    activate: Layout,
-  }),
-]);

package/src/playground/logger/Toolbar.tsx

@@ -1,30 +0,0 @@
-//
-// Copyright 2025 DXOS.org
-//
-
-import React, { useCallback } from 'react';
-
-import { Button } from '@dxos/react-ui';
-
-import { Capabilities, createSurface } from '../../common';
-import { contributes } from '../../core';
-import { createIntent } from '../../plugin-intent';
-import { useIntentDispatcher } from '../../react';
-
-import { Log } from './schema';
-
-export const Logger = () => {
-  const { dispatchPromise } = useIntentDispatcher();
-  const handleClick = useCallback(() => dispatchPromise(createIntent(Log, { message: 'Hello, world!' })), []);
-  return <Button onClick={handleClick}>Log</Button>;
-};
-
-export default () =>
-  contributes(
-    Capabilities.ReactSurface,
-    createSurface({
-      id: 'dxos.org/test/logger/action',
-      role: 'toolbar',
-      component: Logger,
-    }),
-  );

package/src/playground/logger/plugin.ts

@@ -1,41 +0,0 @@
-//
-// Copyright 2025 DXOS.org
-//
-
-import { log } from '@dxos/log';
-
-import { Capabilities, Events } from '../../common';
-import { contributes, defineModule, definePlugin, lazy } from '../../core';
-import { createResolver } from '../../plugin-intent';
-
-import { Log } from './schema';
-
-const Toolbar = lazy(() => import('./Toolbar'));
-
-const meta = {
-  id: 'dxos.org/test/logger',
-  name: 'Logger',
-};
-
-export const LoggerPlugin = definePlugin(meta, () => [
-  defineModule({
-    id: 'dxos.org/test/logger/intents',
-    activatesOn: Events.SetupIntentResolver,
-    activate: () => [
-      contributes(
-        Capabilities.IntentResolver,
-        createResolver({
-          intent: Log,
-          resolve: ({ message }) => {
-            log.info(message);
-          },
-        }),
-      ),
-    ],
-  }),
-  defineModule({
-    id: 'dxos.org/test/logger/surfaces',
-    activatesOn: Events.Startup,
-    activate: Toolbar,
-  }),
-]);

package/src/playground/logger/schema.ts

@@ -1,12 +0,0 @@
-//
-// Copyright 2025 DXOS.org
-//
-
-import * as Schema from 'effect/Schema';
-
-export class Log extends Schema.TaggedClass<Log>()('dxos.org/test/logger/log', {
-  input: Schema.Struct({
-    message: Schema.String,
-  }),
-  output: Schema.Void,
-}) {}

package/src/playground/playground.stories.tsx

@@ -1,46 +0,0 @@
-//
-// Copyright 2025 DXOS.org
-//
-
-import { type Meta, type StoryObj } from '@storybook/react-vite';
-import React from 'react';
-
-import { withTheme } from '@dxos/react-ui/testing';
-
-import { useApp } from '../components';
-import { IntentPlugin } from '../plugin-intent';
-
-import { DebugPlugin } from './debug';
-import { GeneratorPlugin, createNumberPlugin } from './generator';
-import { LayoutPlugin } from './layout';
-import { LoggerPlugin } from './logger';
-
-const pluginFactories = [IntentPlugin, LayoutPlugin, DebugPlugin(), LoggerPlugin(), GeneratorPlugin()];
-const plugins = pluginFactories.map((factory) => (typeof factory === 'function' ? factory() : factory));
-
-const Placeholder = () => {
-  return <div>Loading...</div>;
-};
-
-const DefaultStory = () => {
-  const App = useApp({
-    pluginLoader: (id) => createNumberPlugin(id)(),
-    plugins,
-    core: plugins.map((plugin) => plugin.meta.id),
-    placeholder: Placeholder,
-  });
-
-  return <App />;
-};
-
-const meta = {
-  title: 'sdk/app-framework/playground',
-  render: DefaultStory,
-  decorators: [withTheme],
-} satisfies Meta<typeof DefaultStory>;
-
-export default meta;
-
-type Story = StoryObj<typeof meta>;
-
-export const Playground: Story = {};

package/src/plugin-intent/IntentPlugin.ts

@@ -1,20 +0,0 @@
-//
-// Copyright 2025 DXOS.org
-//
-
-import { Events } from '../common';
-import { defineModule, definePlugin, lazy } from '../core';
-
-import { meta } from './meta';
-
-export const IntentPlugin = definePlugin(meta, () => [
-  defineModule({
-    id: `${meta.id}/module/dispatcher`,
-    // TODO(wittjosiah): This will mean that startup needs to be reset when intents are added or removed.
-    //   This is fine for now because it's how it worked prior to capabilities api anyways.
-    //   In the future, the intent dispatcher should be able to be reset without resetting the entire app.
-    activatesOn: Events.Startup,
-    activatesAfter: [Events.DispatcherReady],
-    activate: lazy(() => import('./intent-dispatcher')),
-  }),
-]);

package/src/plugin-intent/actions.ts

@@ -1,31 +0,0 @@
-//
-// Copyright 2025 DXOS.org
-//
-
-import * as Schema from 'effect/Schema';
-
-import { Label } from './intent';
-import { meta } from './meta';
-
-export namespace IntentAction {
-  /**
-   * Log an intent.
-   */
-  export class Track extends Schema.TaggedClass<Track>()(`${meta.id}/action/track`, {
-    input: Schema.Struct({
-      intents: Schema.Array(Schema.String),
-      error: Schema.optional(Schema.String),
-    }),
-    output: Schema.Void,
-  }) {}
-
-  /**
-   * Fired after an intent is dispatched if the intent is undoable.
-   */
-  export class ShowUndo extends Schema.TaggedClass<ShowUndo>()(`${meta.id}/action/show-undo`, {
-    input: Schema.Struct({
-      message: Label,
-    }),
-    output: Schema.Void,
-  }) {}
-}

package/src/plugin-intent/errors.ts

@@ -1,40 +0,0 @@
-//
-// Copyright 2025 DXOS.org
-//
-
-// TODO(wittjosiah): Reconcile with @dxos/protocols. Factor out errors.
-
-/**
- * NOTE: Messages should be sentences (Start with a capital letter and end with a period).
- * Errors can optionally include a JSON context object.
- */
-export class BaseError extends Error {
-  constructor(
-    readonly code: string,
-    message?: string,
-    readonly context?: Record<string, any>,
-  ) {
-    // TODO(dmaretskyi): Error.cause.
-    super(message ?? code, { cause: context });
-    this.name = code;
-    // NOTE: Restores prototype chain (https://stackoverflow.com/a/48342359).
-    Object.setPrototypeOf(this, new.target.prototype);
-  }
-}
-
-export class NoResolversError extends BaseError {
-  constructor(action: string) {
-    super('NO_RESOLVERS', 'No resolvers were found for the action', { action });
-  }
-}
-
-// TODO(burdon): Detect loops.
-export class CycleDetectedError extends BaseError {
-  constructor(context?: Record<string, any>) {
-    super(
-      'CYCLE_DETECTED',
-      'Intent execution limit exceeded. This is likely due to an infinite loop within intent resolvers.',
-      context,
-    );
-  }
-}

package/src/plugin-intent/index.ts

@@ -1,9 +0,0 @@
-//
-// Copyright 2023 DXOS.org
-//
-
-export * from './actions';
-export * from './errors';
-export * from './intent';
-export * from './intent-dispatcher';
-export * from './IntentPlugin';