@dxos/app-framework 0.8.4-main.b97322e → 0.8.4-main.bc674ce

package/src/plugin-operation/history/undo-registry.test.ts

@@ -0,0 +1,73 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import { describe, test } from 'vitest';
+
+import { Compute, HalveCompute } from '../testing';
+
+import * as UndoMapping from './undo-mapping';
+import * as UndoRegistry from './undo-registry';
+
+describe('UndoRegistry', () => {
+  test('looks up undo mapping by operation key', ({ expect }) => {
+    const undoMapping = UndoMapping.make({
+      operation: Compute,
+      inverse: HalveCompute,
+      deriveContext: (_input, output) => ({ value: output.value }),
+    });
+    const registry = UndoRegistry.make(() => [undoMapping]);
+
+    const result = registry.lookup(Compute);
+    expect(result).not.toBe(undefined);
+    expect(result?.inverse.meta.key).toBe('test.halve-compute');
+  });
+
+  test('returns undefined for unmapped operations', ({ expect }) => {
+    const registry = UndoRegistry.make(() => []);
+
+    const result = registry.lookup(Compute);
+    expect(result).toBe(undefined);
+  });
+
+  test('deriveContext extracts correct undo input', ({ expect }) => {
+    const undoMapping = UndoMapping.make({
+      operation: Compute,
+      inverse: HalveCompute,
+      // Note: This tests that input and output types are inferred correctly.
+      deriveContext: (input, output) => ({ value: output.value + input.value }),
+    });
+    const registry = UndoRegistry.make(() => [undoMapping]);
+
+    const result = registry.lookup(Compute);
+    const context = result?.deriveContext({ value: 5 }, { value: 10 });
+    expect(context).toEqual({ value: 15 });
+  });
+});
+
+describe('resolveMessage', () => {
+  test('returns undefined for undefined message', ({ expect }) => {
+    const result = UndoMapping.resolveMessage(undefined, { value: 1 }, { value: 2 });
+    expect(result).toBe(undefined);
+  });
+
+  test('returns static label as-is', ({ expect }) => {
+    const staticMessage: [string, { ns: string }] = ['test message', { ns: 'test' }];
+    const result = UndoMapping.resolveMessage(staticMessage, { value: 1 }, { value: 2 });
+    expect(result).toEqual(staticMessage);
+  });
+
+  test('calls function message with input and output', ({ expect }) => {
+    const messageFunc = (input: { value: number }, output: { value: number }): [string, { ns: string }] => [
+      `input: ${input.value}, output: ${output.value}`,
+      { ns: 'test' },
+    ];
+    const result = UndoMapping.resolveMessage(messageFunc, { value: 5 }, { value: 10 });
+    expect(result).toEqual(['input: 5, output: 10', { ns: 'test' }]);
+  });
+
+  test('returns string label as-is', ({ expect }) => {
+    const result = UndoMapping.resolveMessage('simple string', { value: 1 }, { value: 2 });
+    expect(result).toBe('simple string');
+  });
+});

package/src/plugin-operation/history/undo-registry.ts

@@ -0,0 +1,54 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import type { Operation } from '@dxos/operation';
+
+import type * as UndoMapping from './undo-mapping';
+
+//
+// Public Interface
+//
+
+/**
+ * Lookup result from UndoRegistry.
+ */
+export type UndoMappingResult = {
+  inverse: Operation.Definition<any, any>;
+  /** Returns undefined to indicate the operation is not undoable. */
+  deriveContext: (input: any, output: any) => any | undefined;
+  /** Message provider - may be a static Label or a function. */
+  message?: UndoMapping.MessageProvider<Operation.Definition<any, any>>;
+};
+
+/**
+ * UndoRegistry interface - looks up inverse operations.
+ */
+export interface UndoRegistry {
+  lookup: (operation: Operation.Definition<any, any>) => UndoMappingResult | undefined;
+}
+
+//
+// Factory
+//
+
+/**
+ * Creates an UndoRegistry that looks up inverse operations.
+ */
+export const make = (getMappings: () => UndoMapping.UndoMapping[]): UndoRegistry => {
+  const lookup = (operation: Operation.Definition<any, any>): UndoMappingResult | undefined => {
+    const mappings = getMappings();
+    const mapping = mappings.find((m) => m.operation.meta.key === operation.meta.key);
+    if (!mapping) {
+      return undefined;
+    }
+
+    return {
+      inverse: mapping.inverse,
+      deriveContext: mapping.deriveContext,
+      message: mapping.message,
+    };
+  };
+
+  return { lookup };
+};

package/src/plugin-operation/index.ts

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

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

@@ -0,0 +1,40 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import * as Effect from 'effect/Effect';
+
+import { OperationInvoker } from '@dxos/operation';
+
+import * as Common 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(Common.Capability.ManagedRuntime);
+    const managedRuntime = managedRuntimes.length > 0 ? managedRuntimes[0] : undefined;
+
+    const invoker = OperationInvoker.make(
+      () =>
+        Effect.gen(function* () {
+          yield* Plugin.activate(Common.ActivationEvent.SetupOperationResolver);
+          return (yield* Capability.getAll(Common.Capability.OperationResolver)).flat();
+        }).pipe(
+          Effect.provideService(Capability.Service, capabilityManager),
+          Effect.provideService(Plugin.Service, pluginManager),
+        ),
+      managedRuntime,
+    );
+
+    return Capability.contributes(Common.Capability.OperationInvoker, invoker);
+  }),
+);

package/src/plugin-operation/meta.ts

@@ -0,0 +1,11 @@
+//
+// 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-operation/testing.ts

@@ -0,0 +1,174 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import * as Deferred from 'effect/Deferred';
+import * as Effect from 'effect/Effect';
+import * as Fiber from 'effect/Fiber';
+import * as Ref from 'effect/Ref';
+import * as Schema from 'effect/Schema';
+import * as Stream from 'effect/Stream';
+
+import { Operation, type OperationInvoker, OperationResolver } from '@dxos/operation';
+
+//
+// Test Operations
+//
+
+export const Compute = Operation.make({
+  schema: {
+    input: Schema.Struct({ value: Schema.Number }),
+    output: Schema.Struct({ value: Schema.Number }),
+  },
+  meta: { key: 'test.compute' },
+});
+
+export const HalveCompute = Operation.make({
+  schema: {
+    input: Schema.Struct({ value: Schema.Number }),
+    output: Schema.Struct({ value: Schema.Number }),
+  },
+  meta: { key: 'test.halve-compute' },
+});
+
+export const ToString = Operation.make({
+  schema: {
+    input: Schema.Struct({ value: Schema.Number }),
+    output: Schema.Struct({ string: Schema.String }),
+  },
+  meta: { key: 'test.to-string' },
+});
+
+export const Add = Operation.make({
+  schema: {
+    input: Schema.Tuple(Schema.Number, Schema.Number),
+    output: Schema.Number,
+  },
+  meta: { key: 'test.add' },
+});
+
+export const SideEffect = Operation.make({
+  schema: {
+    input: Schema.Void,
+    output: Schema.Void,
+  },
+  meta: { key: 'test.side-effect' },
+});
+
+//
+// Test Handlers
+//
+
+export const computeHandler = OperationResolver.make({
+  operation: Compute,
+  handler: (data) =>
+    Effect.gen(function* () {
+      yield* Effect.sleep(data.value * 10);
+      return { value: data.value * 2 };
+    }),
+});
+
+export const halveComputeHandler = OperationResolver.make({
+  operation: HalveCompute,
+  handler: (data) => Effect.succeed({ value: data.value / 2 }),
+});
+
+export const toStringHandler = OperationResolver.make({
+  operation: ToString,
+  handler: (data) => Effect.succeed({ string: data.value.toString() }),
+});
+
+export const addHandler = OperationResolver.make({
+  operation: Add,
+  handler: (data) => Effect.succeed(data[0] + data[1]),
+});
+
+export const sideEffectHandler = OperationResolver.make({
+  operation: SideEffect,
+  handler: () => Effect.succeed(undefined),
+});
+
+//
+// Test Utilities
+//
+
+/**
+ * Event collector for testing - provides deterministic event collection using Effect primitives.
+ */
+export interface EventCollector {
+  /** All collected events. */
+  readonly events: OperationInvoker.InvocationEvent[];
+  /** Wait until N events have been collected. */
+  waitForEvents: (count: number) => Effect.Effect<void>;
+  /** Clean up the subscription fiber. */
+  dispose: Effect.Effect<void>;
+}
+
+/**
+ * Creates an event collector that subscribes to invoker events.
+ * Uses Effect primitives for synchronization.
+ */
+export const createEventCollector = (invoker: OperationInvoker.OperationInvoker): Effect.Effect<EventCollector> =>
+  Effect.gen(function* () {
+    const events: OperationInvoker.InvocationEvent[] = [];
+
+    // Ref to track current waiter (waiting for N events).
+    const waiterRef = yield* Ref.make<{ count: number; deferred: Deferred.Deferred<void> } | null>(null);
+
+    // Deferred to signal when subscription is ready.
+    const subscriptionReady = yield* Deferred.make<void>();
+
+    const checkWaiter = Effect.gen(function* () {
+      const waiter = yield* Ref.get(waiterRef);
+      if (waiter && events.length >= waiter.count) {
+        yield* Deferred.succeed(waiter.deferred, undefined);
+        yield* Ref.set(waiterRef, null);
+      }
+    });
+
+    // Fork a fiber to consume the invocation stream.
+    const fiber = yield* Effect.fork(
+      Effect.gen(function* () {
+        // Signal that subscription is about to start.
+        yield* Deferred.succeed(subscriptionReady, undefined);
+        yield* Stream.fromPubSub(invoker.invocations).pipe(
+          Stream.runForEach((event) =>
+            Effect.gen(function* () {
+              events.push(event);
+              yield* checkWaiter;
+            }),
+          ),
+        );
+      }),
+    );
+
+    // Wait for the subscription to be established.
+    yield* Deferred.await(subscriptionReady);
+    // Additional yield to ensure PubSub subscription is fully registered.
+    yield* Effect.yieldNow();
+
+    const waitForEvents = (count: number): Effect.Effect<void> =>
+      Effect.gen(function* () {
+        if (events.length >= count) {
+          return;
+        }
+        const deferred = yield* Deferred.make<void>();
+        yield* Ref.set(waiterRef, { count, deferred });
+        yield* Deferred.await(deferred);
+      });
+
+    const dispose = Fiber.interrupt(fiber);
+
+    return { events, waitForEvents, dispose };
+  });
+
+/**
+ * Waits until a condition is true, yielding to the JS event loop between checks.
+ * Uses setImmediate to allow other async work to complete.
+ */
+export const waitUntil = (condition: () => boolean): Effect.Effect<void> =>
+  Effect.gen(function* () {
+    while (!condition()) {
+      yield* Effect.promise(() => new Promise((r) => setImmediate(r)));
+    }
+  });

package/src/plugin-runtime/RuntimePlugin.ts

@@ -0,0 +1,20 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import * as Common 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: Common.ActivationEvent.Startup,
+    activatesBefore: [Common.ActivationEvent.SetupLayer],
+    activatesAfter: [Common.ActivationEvent.ManagedRuntimeReady],
+    activate: ManagedRuntimeCapability,
+  }),
+  Plugin.make,
+);

package/src/plugin-runtime/capability.ts

@@ -0,0 +1,53 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import * as Effect from 'effect/Effect';
+import * as Layer from 'effect/Layer';
+import * as ManagedRuntime from 'effect/ManagedRuntime';
+
+import * as Common 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(Common.ActivationEvent.SetupLayer);
+
+    // Gather all contributed layers.
+    const layers = yield* Capability.getAll(Common.Capability.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 Common.Capability.ManagedRuntime;
+
+    return Capability.contributes(Common.Capability.ManagedRuntime, runtime);
+  }),
+);

package/src/plugin-runtime/index.ts

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

package/src/plugin-runtime/meta.ts

@@ -0,0 +1,11 @@
+//
+// 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/plugin-settings/SettingsPlugin.ts

@@ -2,34 +2,18 @@
 // Copyright 2025 DXOS.org
 //
 
-import { SETTINGS_PLUGIN } from './actions';
+import * as Common from '../common';
+import { Capability, Plugin } from '../core';
+
+import { meta } from './meta';
 import { translations } from './translations';
-import { Capabilities, Events } from '../common';
-import { contributes, defineModule, definePlugin, lazy } from '../core';
 
-// TODO(wittjosiah): Add options to exclude some modules.
-export const SettingsPlugin = () =>
-  definePlugin({ id: SETTINGS_PLUGIN, name: 'Settings' }, [
-    defineModule({
-      id: `${SETTINGS_PLUGIN}/module/store`,
-      activatesOn: Events.Startup,
-      activatesBefore: [Events.SetupSettings],
-      activatesAfter: [Events.SettingsReady],
-      activate: lazy(() => import('./store')),
-    }),
-    defineModule({
-      id: `${SETTINGS_PLUGIN}/module/translations`,
-      activatesOn: Events.SetupTranslations,
-      activate: () => contributes(Capabilities.Translations, translations),
-    }),
-    defineModule({
-      id: `${SETTINGS_PLUGIN}/module/intent-resolver`,
-      activatesOn: Events.SetupIntentResolver,
-      activate: lazy(() => import('./intent-resolver')),
-    }),
-    defineModule({
-      id: `${SETTINGS_PLUGIN}/module/app-graph-builder`,
-      activatesOn: Events.SetupAppGraph,
-      activate: lazy(() => import('./app-graph-builder')),
-    }),
-  ]);
+const SettingsOperationResolver = Capability.lazy('SettingsOperationResolver', () => import('./operation-resolver'));
+const SettingsAppGraphBuilder = Capability.lazy('SettingsAppGraphBuilder', () => import('./app-graph-builder'));
+
+export const SettingsPlugin = Plugin.define(meta).pipe(
+  Common.Plugin.addTranslationsModule({ translations }),
+  Common.Plugin.addOperationResolverModule({ activate: SettingsOperationResolver }),
+  Common.Plugin.addAppGraphModule({ activate: SettingsAppGraphBuilder }),
+  Plugin.make,
+);

package/src/plugin-settings/actions.ts

@@ -2,28 +2,63 @@
 // Copyright 2023 DXOS.org
 //
 
-import { Schema } from 'effect';
+import * as Schema from 'effect/Schema';
 
-export const SETTINGS_PLUGIN = 'dxos.org/plugin/settings';
-export const SETTINGS_ACTION = `${SETTINGS_PLUGIN}/action`;
-// TODO(wittjosiah): This is a hack to prevent the previous deck from being set for pinned items.
-//  Ideally this should be worked into the data model in a generic way.
+import { Operation } from '@dxos/operation';
+
+import { Capability } from '../core';
+
+import { meta } from './meta';
+
+// TODO(burdon): Document.
 export const SETTINGS_ID = '!dxos:settings';
 export const SETTINGS_KEY = 'settings';
 
 export namespace SettingsAction {
-  export class Open extends Schema.TaggedClass<Open>()(`${SETTINGS_ACTION}/open`, {
+  export class Open extends Schema.TaggedClass<Open>()(`${meta.id}/open`, {
     input: Schema.Struct({
       plugin: Schema.optional(Schema.String),
     }),
     output: Schema.Void,
   }) {}
 
-  export class OpenPluginRegistry extends Schema.TaggedClass<OpenPluginRegistry>()(
-    `${SETTINGS_ACTION}/open-plugin-registry`,
-    {
+  export class OpenPluginRegistry extends Schema.TaggedClass<OpenPluginRegistry>()(`${meta.id}/open-plugin-registry`, {
+    input: Schema.Void,
+    output: Schema.Void,
+  }) {}
+}
+
+const SETTINGS_OPERATION = `${meta.id}/operation`;
+
+/**
+ * Operations for the Settings plugin.
+ */
+export namespace SettingsOperation {
+  export const Open = Operation.make({
+    meta: {
+      key: `${SETTINGS_OPERATION}/open`,
+      name: 'Open Settings',
+      description: 'Open the settings panel.',
+    },
+    services: [Capability.Service],
+    schema: {
+      input: Schema.Struct({
+        plugin: Schema.optional(Schema.String.annotations({ description: 'The plugin to open settings for.' })),
+      }),
+      output: Schema.Void,
+    },
+  });
+
+  export const OpenPluginRegistry = Operation.make({
+    meta: {
+      key: `${SETTINGS_OPERATION}/open-plugin-registry`,
+      name: 'Open Plugin Registry',
+      description: 'Open the plugin registry.',
+    },
+    services: [Capability.Service],
+    schema: {
       input: Schema.Void,
       output: Schema.Void,
     },
-  ) {}
+  });
 }