Class Routine

User-facing routine: a thin aggregate of an action (runnable) and the triggers that fire it. App-level only — EDGE stays unaware of it (triggers point directly at the runnable).

Hierarchy

{
    description?: string;
    name?: string;
    spec?:
        | {
            kind: "runnable";
            runnable: Ref<PersistentOperation & OfKind<Object> & Unknown>;
        }
        | {
            instructions: Ref<
                Instructions.Instructions & OfKind<Object> & Unknown,
            >;
            kind: "instructions";
        };
    triggers: readonly Ref<Trigger.Trigger & OfKind<Object> & Unknown>[];
} & OfKind<Object, this>
- Routine

Index

Constructors

constructor

Properties

~@dxos/echo/Kind description? id name? spec? triggers ~@dxos/echo/Kind ~@dxos/echo/SchemaKind ~@dxos/echo/Type.Instance? ~@dxos/echo/Type.StaticSchema fields id jsonSchema name?

Constructors

constructor

new Routine(_: never): Routine.Routine
Parameters
- _: never
Returns Routine.Routine
Inherited from Type.makeObject<Routine>(DXN.make('org.dxos.type.routine', '0.2.0'))( Schema.Struct({ name: Schema.String.pipe(Schema.optional), description: Format.Text.pipe(Schema.optional), /** * The action to run: either an Operation (`spec.runnable`, bound directly) or the routine's own owned * Instructions (`spec.instructions`). For an Operation action the trigger's `runnable` points at this * Operation. For an Instructions action `spec.instructions` is the owned Instructions object (the operation * is implicitly the static RunInstructions, so no separate operation ref is stored), and the trigger's * `runnable` is RunInstructions with this instructions bound as its input. */ // TODO(burdon): Change to Array? Or handle that case with a ComputeGraph runnable. spec: RoutineSpec.pipe(Schema.optional), /** * Explicit membership, bi-directional with `trigger.runnable → runnable`. Required (not derived by query) * because the runnable may be a shared registry operation referenced by multiple automations, which would * conflate triggers. MVP enforces length <= 1. */ triggers: Schema.Array(Ref.Ref(Trigger.Trigger)).pipe(Annotation.SetParent.set()), }).pipe( LabelAnnotation.set(['name']), Annotation.IconAnnotation.set({ icon: 'ph--lightning--regular', hue: 'amber' }), Annotation.UserType.set(), ), ).constructor
- Defined in packages/core/echo/echo/dist/types/src/Type.d.ts:72

Properties

`Readonly`~@dxos/echo/Kind

"~@dxos/echo/Kind": Object

Inherited from Type.makeObject<Routine>(DXN.make('org.dxos.type.routine', '0.2.0'))( Schema.Struct({ name: Schema.String.pipe(Schema.optional), description: Format.Text.pipe(Schema.optional), /** * The action to run: either an Operation (`spec.runnable`, bound directly) or the routine's own owned * Instructions (`spec.instructions`). For an Operation action the trigger's `runnable` points at this * Operation. For an Instructions action `spec.instructions` is the owned Instructions object (the operation * is implicitly the static RunInstructions, so no separate operation ref is stored), and the trigger's * `runnable` is RunInstructions with this instructions bound as its input. */ // TODO(burdon): Change to Array? Or handle that case with a ComputeGraph runnable. spec: RoutineSpec.pipe(Schema.optional), /** * Explicit membership, bi-directional with `trigger.runnable → runnable`. Required (not derived by query) * because the runnable may be a shared registry operation referenced by multiple automations, which would * conflate triggers. MVP enforces length <= 1. */ triggers: Schema.Array(Ref.Ref(Trigger.Trigger)).pipe(Annotation.SetParent.set()), }).pipe( LabelAnnotation.set(['name']), Annotation.IconAnnotation.set({ icon: 'ph--lightning--regular', hue: 'amber' }), Annotation.UserType.set(), ), ).~@dxos/echo/Kind

Defined in packages/core/echo/echo/dist/types/src/Entity.d.ts:20

`Optional` `Readonly`description

description?: string = ...

Defined in packages/core/compute/compute/src/types/Routine.ts:41

`Readonly`id

id: string

Defined in packages/core/echo/echo/dist/types/src/Entity.d.ts:21

`Optional` `Readonly`name

name?: string = ...

Defined in packages/core/compute/compute/src/types/Routine.ts:40

`Optional` `Readonly`spec

spec?:
    | {
        kind: "runnable";
        runnable: Ref<PersistentOperation & OfKind<Object> & Unknown>;
    }
    | {
        instructions: Ref<Instructions.Instructions & OfKind<Object> & Unknown>;
        kind: "instructions";
    } = ...

The action to run: either an Operation (spec.runnable, bound directly) or the routine's own owned Instructions (spec.instructions). For an Operation action the trigger's runnable points at this Operation. For an Instructions action spec.instructions is the owned Instructions object (the operation is implicitly the static RunInstructions, so no separate operation ref is stored), and the trigger's runnable is RunInstructions with this instructions bound as its input.

Type declaration

{
kind: "runnable";
runnable: Ref<PersistentOperation & OfKind<Object> & Unknown>;
}
{
instructions: Ref<Instructions.Instructions & OfKind<Object> & Unknown>;
kind: "instructions";
}
- Readonlyinstructions: Ref<Instructions.Instructions & OfKind<Object> & Unknown>
  Owned by the routine: SetParent cascades it.
- Readonlykind: "instructions"

Defined in packages/core/compute/compute/src/types/Routine.ts:51

`Readonly`triggers

triggers: readonly Ref<Trigger.Trigger & OfKind<Object> & Unknown>[] = ...

Explicit membership, bi-directional with trigger.runnable → runnable. Required (not derived by query) because the runnable may be a shared registry operation referenced by multiple automations, which would conflate triggers. MVP enforces length <= 1.

Defined in packages/core/compute/compute/src/types/Routine.ts:58

`Static` `Readonly`~@dxos/echo/Kind

"~@dxos/echo/Kind": Type

Entity-kind brand of the type-entity value itself — always EntityKind.Type. The kind of instance the type describes lives on [SchemaKindId] (Object / Relation / Type). Lets Obj.isObject / Relation.isRelation reject type entities by a single [KindId] check.

Defined in packages/core/echo/echo/dist/types/src/Type.d.ts:23

`Static` `Readonly`~@dxos/echo/SchemaKind

"~@dxos/echo/SchemaKind": Object

Schema-kind brand (object).

Defined in packages/core/echo/echo/dist/types/src/Type.d.ts:57

`Static` `Optional` `Readonly`~@dxos/echo/Type.Instance

"~@dxos/echo/Type.Instance"?: Routine.Routine & OfKind<Object>

Defined in packages/core/echo/echo/dist/types/src/Type.d.ts:34

`Static` `Readonly`~@dxos/echo/Type.StaticSchema

"~@dxos/echo/Type.StaticSchema": Codec<any, any>

Source Effect Schema — used internally by Type.getSchema(self).

Defined in packages/core/echo/echo/dist/types/src/Type.d.ts:59

`Static` `Readonly`fields

fields: {}

The fields defined in the original struct schema. Allows accessing field definitions for introspection.

Defined in packages/core/echo/echo/dist/types/src/Type.d.ts:64

`Static` `Readonly`id

id: string

Object id. Like all ECHO entities, type entities always carry an id — stamped at construction for in-memory (static) declarations and assigned by the database once persisted. The id does NOT determine the entity's URI: static types resolve to their typename DXN, persisted types to echo:///<id> (see getTypeURIFromSpecifier).

Defined in packages/core/echo/echo/dist/types/src/Type.d.ts:31

`Static` `Readonly`jsonSchema

jsonSchema: JsonSchemaType

Defined in packages/core/echo/echo/dist/types/src/Type.d.ts:33

`Static` `Optional` `Readonly`name

name?: string

Defined in packages/core/echo/echo/dist/types/src/Type.d.ts:32

Class Routine

Hierarchy

Index

Constructors

Properties

Constructors

constructor

Parameters

Returns Routine.Routine

Properties

`Readonly`~@dxos/echo/Kind

`Optional` `Readonly`description

`Readonly`id

`Optional` `Readonly`name

`Optional` `Readonly`spec

Type declaration

`Readonly`instructions: Ref<Instructions.Instructions & OfKind<Object> & Unknown>

`Readonly`kind: "instructions"

`Readonly`triggers

`Static` `Readonly`~@dxos/echo/Kind

`Static` `Readonly`~@dxos/echo/SchemaKind

`Static` `Optional` `Readonly`~@dxos/echo/Type.Instance

`Static` `Readonly`~@dxos/echo/Type.StaticSchema

`Static` `Readonly`fields

`Static` `Readonly`id

`Static` `Readonly`jsonSchema

`Static` `Optional` `Readonly`name

Settings

On This Page

Class Routine

Hierarchy

Index

Constructors

Properties

Constructors

constructor

Parameters

Returns Routine.Routine

Properties

Readonly~@dxos/echo/Kind

Optional Readonlydescription

Readonlyid

Optional Readonlyname

Optional Readonlyspec

Type declaration

Readonlyinstructions: Ref<Instructions.Instructions & OfKind<Object> & Unknown>

Readonlykind: "instructions"

Readonlytriggers

Static Readonly~@dxos/echo/Kind

Static Readonly~@dxos/echo/SchemaKind

Static Optional Readonly~@dxos/echo/Type.Instance

Static Readonly~@dxos/echo/Type.StaticSchema

Static Readonlyfields

Static Readonlyid

Static ReadonlyjsonSchema

Static Optional Readonlyname

Settings

On This Page

`Readonly`~@dxos/echo/Kind

`Optional` `Readonly`description

`Readonly`id

`Optional` `Readonly`name

`Optional` `Readonly`spec

`Readonly`instructions: Ref<Instructions.Instructions & OfKind<Object> & Unknown>

`Readonly`kind: "instructions"

`Readonly`triggers

`Static` `Readonly`~@dxos/echo/Kind

`Static` `Readonly`~@dxos/echo/SchemaKind

`Static` `Optional` `Readonly`~@dxos/echo/Type.Instance

`Static` `Readonly`~@dxos/echo/Type.StaticSchema

`Static` `Readonly`fields

`Static` `Readonly`id

`Static` `Readonly`jsonSchema

`Static` `Optional` `Readonly`name