@dxos/plugin-automation 0.8.4-main.406dc2a → 0.8.4-main.43cb759274

package/src/containers/TriggerSettings/TriggerSettings.tsx

@@ -0,0 +1,48 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import React from 'react';
+
+import { type ComputeEnvironment } from '@dxos/client-protocol';
+import { useObject } from '@dxos/echo-react';
+import { type Space } from '@dxos/react-client/echo';
+import { DropdownMenu, IconButton, useTranslation } from '@dxos/react-ui';
+import { Settings } from '@dxos/react-ui-form';
+
+import { meta } from '#meta';
+
+export const TriggersSettings = ({ space }: { space: Space }) => {
+  const { t } = useTranslation(meta.id);
+  const [properties, changeProperties] = useObject(space.properties);
+  const selected = properties.computeEnvironment ?? 'local';
+
+  const handleUpdate = (option: ComputeEnvironment) => {
+    changeProperties((draft) => {
+      draft.computeEnvironment = option;
+    });
+  };
+
+  return (
+    <div className='grid grid-cols-1 md:grid-cols-[1fr_min-content]'>
+      <Settings.Item title={t('runtime.label')} description={t('runtime.description')}>
+        <DropdownMenu.Root>
+          <DropdownMenu.Trigger asChild>
+            <IconButton iconEnd icon='ph--caret-down--regular' size={4} label={t(`runtime.${selected}.label`)} />
+          </DropdownMenu.Trigger>
+          <DropdownMenu.Portal>
+            <DropdownMenu.Content side='bottom'>
+              <DropdownMenu.Viewport>
+                <DropdownMenu.Item onClick={() => handleUpdate('disabled')}>
+                  {t(`runtime.disabled.label`)}
+                </DropdownMenu.Item>
+                <DropdownMenu.Item onClick={() => handleUpdate('local')}>{t(`runtime.local.label`)}</DropdownMenu.Item>
+                <DropdownMenu.Item onClick={() => handleUpdate('edge')}>{t(`runtime.edge.label`)}</DropdownMenu.Item>
+              </DropdownMenu.Viewport>
+            </DropdownMenu.Content>
+          </DropdownMenu.Portal>
+        </DropdownMenu.Root>
+      </Settings.Item>
+    </div>
+  );
+};

package/src/containers/TriggerSettings/index.ts

@@ -0,0 +1,6 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+export { TriggersSettings } from './TriggerSettings';
+export { TriggersSettings as default } from './TriggerSettings';

package/src/containers/index.ts

@@ -0,0 +1,9 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import { type ComponentType, lazy } from 'react';
+
+export const AutomationSettings: ComponentType<any> = lazy(() => import('./AutomationSettings'));
+export const FunctionsContainer: ComponentType<any> = lazy(() => import('./FunctionsContainer'));
+export const TriggerSettings: ComponentType<any> = lazy(() => import('./TriggerSettings'));

package/src/hooks/index.ts

@@ -2,5 +2,6 @@
 // Copyright 2025 DXOS.org
 //
 
-export * from './useComputeRuntimeCallback';
+// TODO(wittjosiah): Factor out.
+export * from './useEdgeTriggersDispatcherStatus';
 export * from './useTriggerRuntimeControls';

package/src/hooks/useEdgeTriggersDispatcherStatus.ts

@@ -0,0 +1,78 @@
+//
+// Copyright 2026 DXOS.org
+//
+
+import { useEffect, useMemo, useState } from 'react';
+
+import { Context } from '@dxos/context';
+import { type TriggersDispatcherStatus } from '@dxos/edge-client';
+import { FunctionsServiceClient } from '@dxos/functions-runtime/edge';
+import { type SpaceId } from '@dxos/keys';
+import { log } from '@dxos/log';
+import { useClient } from '@dxos/react-client';
+import { useIdentity } from '@dxos/react-client/halo';
+
+const POLL_INTERVAL_MS = 5_000;
+
+export type EdgeTriggersDispatcherStatusState = {
+  status: TriggersDispatcherStatus | undefined;
+  error: boolean;
+  loading: boolean;
+};
+
+/**
+ * Polls Edge TriggersDispatcher status for a space while enabled.
+ * Uses {@link FunctionsServiceClient} so requests are authenticated like other edge trigger calls.
+ */
+export const useEdgeTriggersDispatcherStatus = (
+  spaceId: SpaceId | undefined,
+  enabled: boolean,
+): EdgeTriggersDispatcherStatusState => {
+  const client = useClient();
+  const identity = useIdentity();
+  const functionsServiceClient = useMemo(() => FunctionsServiceClient.fromClient(client), [client]);
+  const [status, setStatus] = useState<TriggersDispatcherStatus | undefined>();
+  const [error, setError] = useState(false);
+  const [loading, setLoading] = useState(false);
+
+  useEffect(() => {
+    if (!enabled || !spaceId || !identity) {
+      setStatus(undefined);
+      setError(false);
+      setLoading(false);
+      return;
+    }
+
+    let cancelled = false;
+
+    const fetchStatus = async () => {
+      try {
+        setLoading(true);
+        const result = await functionsServiceClient.getTriggersDispatcherStatus(Context.default(), spaceId);
+        if (!cancelled) {
+          setStatus(result);
+          setError(false);
+        }
+      } catch (err) {
+        log.catch(err);
+        if (!cancelled) {
+          setError(true);
+        }
+      } finally {
+        if (!cancelled) {
+          setLoading(false);
+        }
+      }
+    };
+
+    void fetchStatus();
+    const interval = setInterval(() => void fetchStatus(), POLL_INTERVAL_MS);
+
+    return () => {
+      cancelled = true;
+      clearInterval(interval);
+    };
+  }, [enabled, functionsServiceClient, identity, spaceId]);
+
+  return { status, error, loading };
+};

package/src/hooks/useTriggerRuntimeControls.ts

@@ -2,50 +2,70 @@
 // Copyright 2025 DXOS.org
 //
 
+import { Atom, useAtomValue } from '@effect-atom/atom-react';
+import type * as Context from 'effect/Context';
 import * as Effect from 'effect/Effect';
+import { useEffect, useState } from 'react';
 
-import { Filter } from '@dxos/echo';
-import { FunctionTrigger, TriggerDispatcher } from '@dxos/functions';
-import { type Space, useQuery } from '@dxos/react-client/echo';
-import { useAsyncState } from '@dxos/react-ui';
-
-import { useComputeRuntimeCallback } from './useComputeRuntimeCallback';
+import { useSpaceCallback } from '@dxos/app-framework/ui';
+import { Trigger } from '@dxos/compute';
+import { type Database, Filter, Query } from '@dxos/echo';
+import { TriggerDispatcher, type TriggerDispatcherState } from '@dxos/functions-runtime';
+import { useQuery } from '@dxos/react-client/echo';
 
 interface TriggerRuntimeControls {
-  triggers: FunctionTrigger[];
-  isRunning: boolean;
+  triggers: Trigger.Trigger[];
+
+  state: TriggerDispatcherState | undefined;
+
   start: () => void;
   stop: () => void;
 }
 
-export const useTriggerRuntimeControls = (space: Space | undefined): TriggerRuntimeControls => {
-  const triggers = useQuery(space, Filter.type(FunctionTrigger));
+export const useTriggerRuntimeControls = (db: Database.Database | undefined): TriggerRuntimeControls => {
+  const triggers = useQuery(
+    db,
+    Query.select(Filter.type(Trigger.Trigger)).debugLabel('plugin-automation.useTriggerRuntimeControls'),
+  );
+
+  const [dispatcher, setDispatcher] = useState<Context.Tag.Service<TriggerDispatcher> | undefined>(undefined);
 
-  const [isRunningState, setIsRunningState] = useAsyncState(
-    useComputeRuntimeCallback(space, () => TriggerDispatcher.pipe(Effect.map((t) => t.running))),
+  const init = useSpaceCallback(
+    db?.spaceId,
+    [TriggerDispatcher],
+    Effect.fnUntraced(function* () {
+      const dispatcher = yield* TriggerDispatcher;
+      setDispatcher(dispatcher);
+    }),
   );
 
-  const start = useComputeRuntimeCallback(
-    space,
+  useEffect(() => {
+    void init();
+  }, []);
+
+  const state = useAtomValue(dispatcher?.state ?? Atom.make(undefined));
+
+  const start = useSpaceCallback(
+    db?.spaceId,
+    [TriggerDispatcher],
     Effect.fnUntraced(function* () {
       const dispatcher = yield* TriggerDispatcher;
       yield* dispatcher.start();
-      setIsRunningState(true);
     }),
   );
 
-  const stop = useComputeRuntimeCallback(
-    space,
+  const stop = useSpaceCallback(
+    db?.spaceId,
+    [TriggerDispatcher],
     Effect.fnUntraced(function* () {
       const dispatcher = yield* TriggerDispatcher;
       yield* dispatcher.stop();
-      setIsRunningState(false);
     }),
   );
 
   return {
     triggers,
-    isRunning: isRunningState ?? false,
+    state,
     start: () => void start(),
     stop: () => void stop(),
   };

package/src/index.ts

@@ -2,9 +2,5 @@
 // Copyright 2023 DXOS.org
 //
 
-export { AutomationCapabilities } from './capabilities';
-export * from './components';
 export * from './meta';
-export * from './events';
-
-export * from './AutomationPlugin';
+export * from './types';

package/src/meta.ts

@@ -2,13 +2,36 @@
 // Copyright 2023 DXOS.org
 //
 
-import { type PluginMeta } from '@dxos/app-framework';
+import { Plugin } from '@dxos/app-framework';
+import { DXN } from '@dxos/keys';
+import { trim } from '@dxos/util';
 
-export const meta: PluginMeta = {
-  id: 'dxos.org/plugin/automation',
+export const meta = Plugin.makeMeta({
+  key: DXN.make('org.dxos.plugin.automation'),
   name: 'Automation',
-  description:
-    'The Automation tab allows you to trigger pre-defined workflows related to the element you are interacting with inside of Composer.',
-  icon: 'ph--robot--regular',
+  author: 'DXOS',
+  description: trim`
+    Event-driven workflow automation engine for DXOS Composer.
+    Triggers connect ECHO objects, timer schedules, incoming feeds (email, webhook), and data
+    subscriptions to persistent compute functions — enabling automated pipelines that react to
+    changes in real time without manual intervention.
+
+    Each trigger references a PersistentOperation (a compiled function derived from a Script or
+    a visual ComputeGraph workflow) and carries optional structured input forwarded at invocation.
+    A per-space TriggerDispatcher manages execution: running locally in the browser when
+    computeEnvironment is "local", or delegating to the DXOS edge for server-side reliability.
+
+    The AutomationPanel settings surface lets users create, configure, enable, disable, and
+    force-run triggers from within any space. The TriggerEditor form supports all spec kinds —
+    timer (cron), feed, subscription, email, and webhook — with a query builder for
+    subscription-type triggers and a structured input editor for passing data to functions.
+
+    Operation handlers and blueprints contributed by any plugin in the application are
+    automatically merged and made available to every space's OperationRegistry, so new
+    capabilities registered by other plugins become instantly invocable from automation triggers.
+  `,
+  icon: 'ph--atom--regular',
   source: 'https://github.com/dxos/dxos/tree/main/packages/plugins/plugin-automation',
-};
+  spec: 'PLUGIN.mdl',
+  tags: ['system'],
+});

package/src/operations/create-trigger-from-template.ts

@@ -0,0 +1,70 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import * as Effect from 'effect/Effect';
+
+import { LayoutOperation, getSpacePath } from '@dxos/app-toolkit';
+import { Operation, Script, Trigger } from '@dxos/compute';
+import { type Feed, Filter, Obj, Ref } from '@dxos/echo';
+import { SpaceOperation } from '@dxos/plugin-space';
+
+import { meta } from '#meta';
+
+import { AutomationOperation } from '../types';
+
+const handler: Operation.WithHandler<typeof AutomationOperation.CreateTriggerFromTemplate> =
+  AutomationOperation.CreateTriggerFromTemplate.pipe(
+    Operation.withHandler(
+      Effect.fnUntraced(function* ({ db, template, enabled = false, scriptName, input }) {
+        const trigger = Trigger.make({ enabled, input });
+
+        // TODO(wittjosiah): Factor out function lookup by script name?
+        if (scriptName) {
+          const scripts = yield* Effect.promise(() => db.query(Filter.type(Script.Script, { name: scriptName })).run());
+          const [script] = scripts;
+          if (script) {
+            const functions = yield* Effect.promise(() =>
+              db.query(Filter.type(Operation.PersistentOperation, { source: Ref.make(script) })).run(),
+            );
+            const [fn] = functions;
+            if (fn) {
+              Obj.update(trigger, (trigger) => {
+                trigger.function = Ref.make(fn);
+              });
+            }
+          }
+        }
+
+        switch (template.type) {
+          case 'timer': {
+            Obj.update(trigger, (trigger) => {
+              trigger.spec = Trigger.specTimer(template.cron);
+            });
+            break;
+          }
+          case 'feed': {
+            Obj.update(trigger, (trigger) => {
+              trigger.spec = Trigger.specFeed(template.feed as Feed.Feed);
+            });
+            break;
+          }
+          default: {
+            break;
+          }
+        }
+
+        yield* Operation.invoke(SpaceOperation.AddObject, {
+          object: trigger,
+          target: db,
+          hidden: true,
+        });
+        yield* Operation.invoke(LayoutOperation.Open, {
+          subject: [`${getSpacePath(db.spaceId)}/settings/${meta.id}.automations`],
+          workspace: getSpacePath(db.spaceId),
+        });
+      }),
+    ),
+  );
+
+export default handler;

package/src/operations/index.ts

@@ -0,0 +1,7 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import { OperationHandlerSet } from '@dxos/compute';
+
+export const AutomationOperationHandlerSet = OperationHandlerSet.lazy(() => import('./create-trigger-from-template'));

package/src/plugin.ts

@@ -0,0 +1,11 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import { Plugin } from '@dxos/app-framework';
+
+import { meta } from './meta';
+
+export const AutomationPlugin = Plugin.lazy(meta, () => import('#plugin'));
+
+export { AutomationOperationHandlerSet } from './operations';

package/src/testing/test-functions.ts

@@ -4,14 +4,18 @@
 
 import * as Schema from 'effect/Schema';
 
-import { ContactType } from '@dxos/client/testing';
-import { Type } from '@dxos/echo';
+import { TestSchema } from '@dxos/client/testing';
+import { JsonSchema, Ref, DXN } from '@dxos/echo';
 
+/**
+ * Operations seeded into the local space in stories.
+ */
 export const functions = [
   {
-    name: 'example.com/function/chess',
+    key: DXN.make('com.example.function.chess'),
+    name: 'com.example.function.chess',
     version: '0.1.0',
-    inputSchema: Type.toJsonSchema(
+    inputSchema: JsonSchema.toJsonSchema(
       Schema.Struct({
         level: Schema.Number.annotations({
           title: 'Level',
@@ -20,10 +24,11 @@ export const functions = [
     ),
   },
   {
-    name: 'example.com/function/forex',
+    key: DXN.make('com.example.function.forex'),
+    name: 'com.example.function.forex',
     version: '0.1.0',
     binding: 'FOREX',
-    inputSchema: Type.toJsonSchema(
+    inputSchema: JsonSchema.toJsonSchema(
       Schema.Struct({
         from: Schema.String.annotations({ title: 'Currency from' }),
         to: Schema.String.annotations({ title: 'Currency to' }),
@@ -31,11 +36,40 @@ export const functions = [
     ),
   },
   {
-    name: 'example.com/function/ping-contact',
+    key: DXN.make('com.example.function.pingContact'),
+    name: 'com.example.function.ping-contact',
     version: '0.0.1',
-    inputSchema: Type.toJsonSchema(
+    inputSchema: JsonSchema.toJsonSchema(
       Schema.Struct({
-        contact: Type.Ref(ContactType).annotations({ title: 'Contact' }),
+        contact: Ref.Ref(TestSchema.ContactType).annotations({ title: 'Contact' }),
+      }),
+    ),
+  },
+];
+
+/**
+ * Operations seeded into the registry (not the local space) in stories.
+ * Simulates built-in or plugin-provided operations available globally.
+ */
+export const registryFunctions = [
+  {
+    key: 'com.example.function.translate',
+    name: 'com.example.function.translate',
+    version: '0.1.0',
+    inputSchema: JsonSchema.toJsonSchema(
+      Schema.Struct({
+        text: Schema.String.annotations({ title: 'Text' }),
+        targetLanguage: Schema.String.annotations({ title: 'Target language' }),
+      }),
+    ),
+  },
+  {
+    key: 'com.example.function.summarize',
+    name: 'com.example.function.summarize',
+    version: '0.1.0',
+    inputSchema: JsonSchema.toJsonSchema(
+      Schema.Struct({
+        content: Schema.String.annotations({ title: 'Content' }),
       }),
     ),
   },

package/src/testing.ts

@@ -0,0 +1,7 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+// Eager re-export of `AutomationPlugin`. See `@dxos/plugin-testing/src/core.ts`
+// for the rationale.
+export * from './AutomationPlugin';

package/src/translations.ts

@@ -4,44 +4,64 @@
 
 import { type Resource } from '@dxos/react-ui';
 
-import { meta } from './meta';
+import { meta } from '#meta';
 
 export const translations = [
   {
     'en-US': {
       [meta.id]: {
-        'plugin name': 'Automation',
-        'automation panel label': 'Automations',
-        'script automation label': 'Automation',
-        'automation verbose label': 'Manage automations',
-        'automation description': 'You can manage all the triggers which automate your space here.',
-
-        'runtime label': 'Enable Local Runtime',
-        'runtime description':
-          'This will start a trigger dispatcher locally for this space to run triggers on your device while Composer is running.',
-
-        'functions panel label': 'Functions',
-        'functions verbose label': 'Manage deployed functions',
-        'functions description': 'You can manage all the functions deployed from your space on EDGE here.',
-        'function copy id': 'Copy Function ID',
-        'no functions found': 'No functions found',
-        'go to function source button label': 'Show function source',
-
-        'trigger editor title': 'Configure Trigger',
-        'new trigger label': 'Add Trigger',
-        'trigger type timer': 'Timer',
-        'trigger type webhook': 'Webhook',
-        'trigger type websocket': 'Websocket',
-        'trigger type subscription': 'Subscription',
-        'trigger type email': 'Email',
-        'trigger type queue': 'Queue',
-
-        'trigger copy url': 'Copy URL',
-        'trigger copy email': 'Copy Email',
-
-        'trigger payload add': 'Add',
-        'trigger payload remove': 'Remove',
-        'trigger payload prop name placeholder': 'New payload property name',
+        'plugin.name': 'Automation',
+        'automation-panel.label': 'Automations',
+        'script-automation.label': 'Automation',
+        'automation-verbose.label': 'Manage automations',
+        'automation.description': 'Triggers that automate this space.',
+
+        'runtime.label': 'Trigger runtime location',
+        'runtime.description': 'Determines where the triggers in this space will execute.',
+        'runtime.disabled.label': 'Triggers disabled',
+        'runtime.local.label': 'Local',
+        'runtime.edge.label': 'EDGE (experimental)',
+
+        'functions-panel.label': 'Functions',
+        'functions-verbose.label': 'Manage deployed functions',
+        'functions-registry-verbose.label': 'Functions registry',
+        'functions-registry.description': 'Import functions from the registry',
+        'functions.description': 'Functions deployed from this space on EDGE.',
+        'show-source-button.label': 'Show source',
+        'delete-function-button.label': 'Delete function',
+
+        'function-parameters.label': 'Function parameters',
+
+        'trigger-editor.title': 'Configure Trigger',
+        'trigger-editor.description':
+          'Triggers are used to run functions at specific times or when specific events occur.',
+        'new-trigger.label': 'Add Trigger',
+
+        'trigger-type.timer.label': 'Timer',
+        'trigger-type.webhook.label': 'Webhook',
+        'trigger-type.websocket.label': 'Websocket',
+        'trigger-type.subscription.label': 'Subscription',
+        'trigger-type.email.label': 'Email',
+        'trigger-type.feed.label': 'Feed',
+
+        'trigger-payload-prop-name.placeholder': 'New payload property name',
+        'import-function-button.label': 'Loading...',
+        'update-function-button.label': 'Update',
+        'loading-functions.message': 'Loading functions...',
+
+        'edge.trigger.status.loading.message': 'Loading edge trigger status…',
+        'edge.trigger.status.unavailable.message': 'Edge trigger status unavailable',
+        'edge.trigger.status.dispatcher.label': 'Edge dispatcher: {{state}}',
+        'edge.trigger.status.active.label': 'active',
+        'edge.trigger.status.inactive.label': 'inactive',
+        'edge.trigger.status.next.cron.label': 'Next cron run: {{time}}',
+        'edge.trigger.status.next.alarm.label': 'Next alarm: {{time}}',
+        'edge.trigger.status.inactivity.label': 'Inactivity timeout: {{remaining}} remaining',
+        'edge.trigger.status.registered.label': 'Edge: registered',
+        'edge.trigger.status.not.registered.label': 'Edge: not registered',
+        'edge.trigger.status.registered.count.label': 'Enabled cron triggers on edge: {{registered}} / {{total}}',
+        'edge.trigger.status.cron.na.label': 'Edge: cron registration n/a',
+        'edge.trigger.status.disabled.detail.label': 'disabled',
       },
     },
   },

package/src/types/AutomationOperation.ts

@@ -0,0 +1,39 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+// @import-as-namespace
+
+import * as Schema from 'effect/Schema';
+
+import { Capability } from '@dxos/app-framework';
+import { Operation } from '@dxos/compute';
+import { Database, DXN } from '@dxos/echo';
+// Value-side `EID` import keeps TS declaration emit portable — `TriggerTemplate`
+// references `EID.Schema` and the inferred `CreateTriggerFromTemplate` type
+// otherwise needs a transitive `@dxos/keys` import that's hard for d.ts emit to surface.
+import { EID as _EchoURIReference } from '@dxos/keys';
+
+import { meta } from '#meta';
+
+import { TriggerTemplate } from './schema';
+export { _EchoURIReference };
+
+const makeKey = (name: string) => DXN.make(`${meta.id}.operation.${name}`);
+
+export const CreateTriggerFromTemplate = Operation.make({
+  meta: {
+    key: makeKey('createTriggerFromTemplate'),
+    name: 'Create Trigger From Template',
+    icon: 'ph--lightning--regular',
+  },
+  services: [Capability.Service],
+  input: Schema.Struct({
+    db: Database.Database,
+    template: TriggerTemplate,
+    enabled: Schema.optional(Schema.Boolean),
+    scriptName: Schema.optional(Schema.String),
+    input: Schema.optional(Schema.Record({ key: Schema.String, value: Schema.Any })),
+  }),
+  output: Schema.Void,
+});

package/src/types/index.ts

@@ -3,3 +3,5 @@
 //
 
 export * from './schema';
+
+export * as AutomationOperation from './AutomationOperation';

package/src/types/schema.ts

@@ -4,21 +4,21 @@
 
 import * as Schema from 'effect/Schema';
 
-import { SpaceSchema } from '@dxos/react-client/echo';
+import { Database } from '@dxos/echo';
 
-import { meta } from '../meta';
+import { meta } from '#meta';
 
-const TriggerTemplate = Schema.Union(
+export const TriggerTemplate = Schema.Union(
   Schema.Struct({ type: Schema.Literal('timer'), cron: Schema.String }),
-  Schema.Struct({ type: Schema.Literal('queue'), queueDXN: Schema.Any }),
+  Schema.Struct({ type: Schema.Literal('feed'), feed: Schema.Any }),
 );
 
 export namespace AutomationAction {
   export class CreateTriggerFromTemplate extends Schema.TaggedClass<CreateTriggerFromTemplate>()(
-    `${meta.id}/action/create-trigger-from-template`,
+    `${meta.id}.action.create-trigger-from-template`,
     {
       input: Schema.Struct({
-        space: SpaceSchema,
+        db: Database.Database,
         template: TriggerTemplate,
         enabled: Schema.optional(Schema.Boolean),
         // TODO(wittjosiah): Improve how this lookup is done.