@dxos/app-framework 0.8.4-main.84f28bd → 0.8.4-main.937b3ca

package/moon.yml

@@ -5,10 +5,18 @@ tags:
   - ts-build
   - ts-test
   - typedoc
+  - storybook
 tasks:
   compile:
     args:
       - '--entryPoint=src/index.ts'
+      - '--entryPoint=src/common/index.ts'
+      - '--entryPoint=src/core/activation-event.ts'
+      - '--entryPoint=src/core/capability.ts'
+      - '--entryPoint=src/core/plugin.ts'
+      - '--entryPoint=src/core/plugin-manager.ts'
+      - '--entryPoint=src/react/index.ts'
       - '--entryPoint=src/testing/index.ts'
-      - '--entryPoint=src/worker.ts'
-      - '--preactSignalTracking'
+  test:
+    inputs:
+      - .storybook/*

package/package.json

@@ -1,79 +1,140 @@
 {
   "name": "@dxos/app-framework",
-  "version": "0.8.4-main.84f28bd",
+  "version": "0.8.4-main.937b3ca",
   "description": "A framework for building applications from composible plugins.",
   "homepage": "https://dxos.org",
   "bugs": "https://github.com/dxos/dxos/issues",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/dxos/dxos"
+  },
   "license": "MIT",
   "author": "DXOS.org",
-  "sideEffects": true,
+  "sideEffects": false,
   "type": "module",
   "exports": {
     ".": {
+      "source": "./src/index.ts",
       "types": "./dist/types/src/index.d.ts",
       "browser": "./dist/lib/browser/index.mjs",
       "node": "./dist/lib/node-esm/index.mjs"
     },
+    "./ActivationEvent": {
+      "source": "./src/core/activation-event.ts",
+      "types": "./dist/types/src/activation-event/index.d.ts",
+      "browser": "./dist/lib/browser/activation-event/index.mjs",
+      "node": "./dist/lib/node-esm/activation-event/index.mjs"
+    },
+    "./Capability": {
+      "source": "./src/core/capability.ts",
+      "types": "./dist/types/src/capability/index.d.ts",
+      "browser": "./dist/lib/browser/capability/index.mjs",
+      "node": "./dist/lib/node-esm/capability/index.mjs"
+    },
+    "./Common": {
+      "source": "./src/common/index.ts",
+      "types": "./dist/types/src/common/index.d.ts",
+      "browser": "./dist/lib/browser/common/index.mjs",
+      "node": "./dist/lib/node-esm/common/index.mjs"
+    },
+    "./Plugin": {
+      "source": "./src/core/plugin.ts",
+      "types": "./dist/types/src/plugin/index.d.ts",
+      "browser": "./dist/lib/browser/plugin/index.mjs",
+      "node": "./dist/lib/node-esm/plugin/index.mjs"
+    },
+    "./PluginManager": {
+      "source": "./src/core/plugin-manager.ts",
+      "types": "./dist/types/src/plugin-manager/index.d.ts",
+      "browser": "./dist/lib/browser/plugin-manager/index.mjs",
+      "node": "./dist/lib/node-esm/plugin-manager/index.mjs"
+    },
+    "./react": {
+      "source": "./src/react/index.ts",
+      "types": "./dist/types/src/react/index.d.ts",
+      "browser": "./dist/lib/browser/react/index.mjs",
+      "node": "./dist/lib/node-esm/react/index.mjs"
+    },
     "./testing": {
+      "source": "./src/testing/index.ts",
       "types": "./dist/types/src/testing/index.d.ts",
       "browser": "./dist/lib/browser/testing/index.mjs",
       "node": "./dist/lib/node-esm/testing/index.mjs"
-    },
-    "./worker": {
-      "types": "./dist/types/src/worker.d.ts",
-      "browser": "./dist/lib/browser/worker.mjs",
-      "node": "./dist/lib/node-esm/worker.mjs"
     }
   },
   "types": "dist/types/src/index.d.ts",
   "typesVersions": {
     "*": {
+      "ActivationEvent": [
+        "dist/types/src/activation-event/index.d.ts"
+      ],
+      "Capability": [
+        "dist/types/src/capability/index.d.ts"
+      ],
+      "Common": [
+        "dist/types/src/common/index.d.ts"
+      ],
+      "Plugin": [
+        "dist/types/src/plugin/index.d.ts"
+      ],
+      "PluginManager": [
+        "dist/types/src/plugin-manager/index.d.ts"
+      ],
+      "react": [
+        "dist/types/src/react/index.d.ts"
+      ],
       "testing": [
         "dist/types/src/testing/index.d.ts"
-      ],
-      "worker": [
-        "dist/types/src/worker.d.ts"
       ]
     }
   },
   "dependencies": {
-    "@preact-signals/safe-react": "^0.9.0",
-    "@preact/signals-core": "^1.9.0",
-    "@dxos/ai": "0.8.4-main.84f28bd",
-    "@dxos/app-graph": "0.8.4-main.84f28bd",
-    "@dxos/async": "0.8.4-main.84f28bd",
-    "@dxos/artifact": "0.8.4-main.84f28bd",
-    "@dxos/client-protocol": "0.8.4-main.84f28bd",
-    "@dxos/debug": "0.8.4-main.84f28bd",
-    "@dxos/echo-schema": "0.8.4-main.84f28bd",
-    "@dxos/invariant": "0.8.4-main.84f28bd",
-    "@dxos/keys": "0.8.4-main.84f28bd",
-    "@dxos/live-object": "0.8.4-main.84f28bd",
-    "@dxos/local-storage": "0.8.4-main.84f28bd",
-    "@dxos/react-hooks": "0.8.4-main.84f28bd",
-    "@dxos/schema": "0.8.4-main.84f28bd",
-    "@dxos/log": "0.8.4-main.84f28bd",
-    "@dxos/util": "0.8.4-main.84f28bd"
+    "@effect/ai": "0.32.1",
+    "@effect/cli": "0.72.1",
+    "@dxos/ai": "0.8.4-main.937b3ca",
+    "@dxos/app-graph": "0.8.4-main.937b3ca",
+    "@dxos/assistant": "0.8.4-main.937b3ca",
+    "@dxos/blueprints": "0.8.4-main.937b3ca",
+    "@dxos/client-protocol": "0.8.4-main.937b3ca",
+    "@dxos/async": "0.8.4-main.937b3ca",
+    "@dxos/debug": "0.8.4-main.937b3ca",
+    "@dxos/echo": "0.8.4-main.937b3ca",
+    "@dxos/effect": "0.8.4-main.937b3ca",
+    "@dxos/functions": "0.8.4-main.937b3ca",
+    "@dxos/invariant": "0.8.4-main.937b3ca",
+    "@dxos/keys": "0.8.4-main.937b3ca",
+    "@dxos/log": "0.8.4-main.937b3ca",
+    "@dxos/operation": "0.8.4-main.937b3ca",
+    "@dxos/react-hooks": "0.8.4-main.937b3ca",
+    "@dxos/types": "0.8.4-main.937b3ca",
+    "@dxos/schema": "0.8.4-main.937b3ca",
+    "@dxos/util": "0.8.4-main.937b3ca",
+    "@dxos/web-context": "0.8.4-main.937b3ca",
+    "@dxos/web-context-react": "0.8.4-main.937b3ca"
   },
   "devDependencies": {
-    "@effect-rx/rx-react": "0.38.0",
-    "@effect/platform": "0.88.0",
-    "@phosphor-icons/react": "^2.1.5",
-    "@types/react": "~18.2.0",
-    "effect": "3.16.13",
-    "react": "~18.2.0",
+    "@effect-atom/atom-react": "^0.4.6",
+    "@effect/platform": "0.93.6",
+    "@effect/vitest": "0.27.0",
+    "@types/react": "~19.2.7",
+    "effect": "3.19.11",
+    "react": "~19.2.3",
+    "react-dom": "~19.2.3",
     "typedoc": "0.28.1",
-    "@dxos/echo-signals": "0.8.4-main.84f28bd",
-    "@dxos/random": "0.8.4-main.84f28bd",
-    "@dxos/react-ui": "0.8.4-main.84f28bd",
-    "@dxos/storybook-utils": "0.8.4-main.84f28bd",
-    "@dxos/react-ui-syntax-highlighter": "0.8.4-main.84f28bd"
+    "@dxos/echo-db": "0.8.4-main.937b3ca",
+    "@dxos/random": "0.8.4-main.937b3ca",
+    "@dxos/react-ui": "0.8.4-main.937b3ca",
+    "@dxos/react-ui-syntax-highlighter": "0.8.4-main.937b3ca",
+    "@dxos/storybook-utils": "0.8.4-main.937b3ca",
+    "@dxos/test-utils": "0.8.4-main.937b3ca",
+    "@dxos/ui-theme": "0.8.4-main.937b3ca"
   },
   "peerDependencies": {
-    "@effect-rx/rx-react": "^0.34.1",
-    "@effect/platform": "^0.80.12",
-    "effect": "^3.13.3",
-    "react": "~18.2.0"
+    "@effect-atom/atom-react": "^0.4.6",
+    "@effect/platform": "0.93.6",
+    "effect": "3.19.11",
+    "react": "~19.2.3",
+    "react-dom": "~19.2.3"
   },
   "publishConfig": {
     "access": "public"

package/src/cli.ts

@@ -0,0 +1,107 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import * as Command from '@effect/cli/Command';
+import * as Effect from 'effect/Effect';
+import * as Layer from 'effect/Layer';
+
+import { invariant } from '@dxos/invariant';
+
+import * as Common from './common';
+import { Capability, Plugin, PluginManager } from './core';
+
+const defaultPluginLoader =
+  (plugins: Plugin.Plugin[]): PluginManager.ManagerOptions['pluginLoader'] =>
+  (id: string) =>
+    Effect.sync(() => {
+      const plugin = plugins.find((plugin) => plugin.meta.id === id);
+      invariant(plugin, `Plugin not found: ${id}`);
+      return plugin;
+    });
+
+type SubCommands = [Command.Command<any, any, any, any>, ...Array<Command.Command<any, any, any, any>>];
+
+export type CreateCliAppOptions = {
+  rootCommand: Command.Command<any, any, any, any>;
+  subCommands?: SubCommands;
+  pluginManager?: PluginManager.PluginManager;
+  pluginLoader?: PluginManager.ManagerOptions['pluginLoader'];
+  plugins?: Plugin.Plugin[];
+  core?: string[];
+  enabled?: string[];
+  safeMode?: boolean;
+};
+
+/**
+ * Creates a CLI application with plugin support.
+ * Similar to useApp but for CLI environments.
+ *
+ * @example
+ * const plugins = [ClientPluginCLI()];
+ * const manager = await createCliApp({ plugins });
+ * const commands = manager.capabilities.getAll(Common.Capability.Command);
+ *
+ * @param options.pluginManager Optional existing PluginManager instance.
+ * @param options.pluginLoader Function to load plugins by ID.
+ * @param options.plugins All plugins available to the application.
+ * @param options.core Core plugins which will always be enabled.
+ * @param options.enabled Enabled plugins.
+ * @param options.safeMode Whether to enable safe mode, which disables optional plugins.
+ */
+export const createCliApp = Effect.fn(function* ({
+  rootCommand,
+  subCommands: subCommandsProp,
+  pluginManager: pluginManagerProp,
+  pluginLoader: pluginLoaderProp,
+  plugins: pluginsProp = [],
+  core: coreProp,
+  enabled: enabledProp = [],
+  safeMode = false,
+}: CreateCliAppOptions) {
+  const plugins = pluginsProp;
+  const core = coreProp ?? plugins.map(({ meta }) => meta.id);
+  const pluginLoader = pluginLoaderProp ?? defaultPluginLoader(plugins);
+  const enabled = safeMode ? [] : enabledProp;
+  const manager =
+    pluginManagerProp ??
+    PluginManager.make({
+      pluginLoader,
+      plugins,
+      core,
+      enabled,
+    });
+
+  manager.capabilities.contribute({
+    interface: Common.Capability.PluginManager,
+    implementation: manager,
+    module: 'dxos.org/app-framework/plugin-manager',
+  });
+
+  manager.capabilities.contribute({
+    interface: Common.Capability.AtomRegistry,
+    implementation: manager.registry,
+    module: 'dxos.org/app-framework/atom-registry',
+  });
+
+  // Activate startup event to load CLI commands and Effect layers.
+  yield* manager.activate(Common.ActivationEvent.Startup);
+
+  // Gather all layers and merge them into a single layer.
+  const layers = manager.capabilities.getAll(Common.Capability.Layer);
+  const capabilityServiceLayer = Layer.succeed(Capability.Service, manager.capabilities);
+  const pluginServiceLayer = Layer.succeed(Plugin.Service, manager);
+  const layer = (Layer.mergeAll as (...args: Layer.Layer<any, any, any>[]) => Layer.Layer<any, any, never>)(
+    capabilityServiceLayer,
+    pluginServiceLayer,
+    ...layers,
+  );
+
+  // Gather all commands and provide them to the root command.
+  const pluginCommands = manager.capabilities.getAll(Common.Capability.Command);
+  const subCommands = subCommandsProp ? [...subCommandsProp, ...pluginCommands] : pluginCommands;
+  invariant(subCommands.length > 0, 'No subcommands provided');
+  const command = rootCommand.pipe(Command.withSubcommands(subCommands as SubCommands));
+
+  return { command, layer };
+});

package/src/common/activation-event.ts

@@ -0,0 +1,99 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import { ActivationEvent as ActivationEvent$ } from '../core';
+
+import { Capability } from './capability';
+
+export namespace ActivationEvent {
+  /**
+   * Fired when the app is started.
+   */
+  export const Startup = ActivationEvent$.make('dxos.org/app-framework/event/startup');
+
+  //
+  // Dependent Events
+  //
+
+  /**
+   * Fired to load any newly available surfaces.
+   */
+  export const SetupReactSurface = ActivationEvent$.make('dxos.org/app-framework/event/setup-react-surface');
+
+  /**
+   * Fired to load any newly available metadata.
+   */
+  export const SetupMetadata = ActivationEvent$.make('dxos.org/app-framework/event/setup-metadata');
+
+  /**
+   * Fired before the operation invoker is activated.
+   */
+  export const SetupOperationResolver = ActivationEvent$.make('dxos.org/app-framework/event/setup-operation-resolver');
+
+  /**
+   * Fired before the managed runtime is created.
+   * Plugins should contribute their Layer capabilities before this event.
+   */
+  export const SetupLayer = ActivationEvent$.make('dxos.org/app-framework/event/setup-layer');
+
+  /**
+   * Fired before the settings store is activated.
+   */
+  export const SetupSettings = ActivationEvent$.make('dxos.org/app-framework/event/setup-settings');
+
+  /**
+   * Fired before the graph is created.
+   */
+  export const SetupAppGraph = ActivationEvent$.make('dxos.org/app-framework/event/setup-graph');
+
+  /**
+   * Fired before the translations provider is created.
+   */
+  export const SetupTranslations = ActivationEvent$.make('dxos.org/app-framework/event/setup-translations');
+
+  /**
+   * Fired before the schema is created.
+   */
+  export const SetupSchema = ActivationEvent$.make('dxos.org/app-framework/event/setup-schema');
+
+  /**
+   * Fired to load any newly available artifacts definitions.
+   */
+  // TODO(burdon): Rename.
+  export const SetupArtifactDefinition = ActivationEvent$.make(
+    'dxos.org/app-framework/event/setup-artifact-definition',
+  );
+
+  //
+  // Triggered Events
+  //
+
+  /**
+   * Fired after the operation invoker is ready.
+   */
+  export const OperationInvokerReady = ActivationEvent$.make('dxos.org/app-framework/event/operation-invoker-ready');
+
+  /**
+   * Fired after the managed runtime is ready.
+   */
+  export const ManagedRuntimeReady = ActivationEvent$.make('dxos.org/app-framework/event/managed-runtime-ready');
+
+  /**
+   * Fired when the graph is ready.
+   */
+  export const AppGraphReady = ActivationEvent$.make('dxos.org/app-framework/event/graph-ready');
+
+  /**
+   * Fired when plugin state is ready.
+   */
+  export const createStateEvent = (specifier: string) =>
+    ActivationEvent$.make('dxos.org/app-framework/event/state', specifier);
+  export const LayoutReady = createStateEvent(Capability.Layout.identifier);
+
+  /**
+   * Fired when a specific settings capability is ready.
+   */
+  export const createSettingsEvent = (specifier: string) =>
+    ActivationEvent$.make('dxos.org/app-framework/event/settings', specifier);
+}