Class Project

A user-facing container for interactive, long-running work: instructions (skills + commands), artifacts, tasks, and AI chat sessions in project context. Successor to Topic.

Fields are the refs the project owns and orders; everything that merely accumulates around it is a query — chats by the ECHO parent edge, agents via chats. What only some projects need, such as the repositories coding agents work on, is an annotation the plugin that needs it adds.

Hierarchy

{
    artifacts: readonly Ref<Unknown>[];
    description?: string;
    instructions?: Ref<Instructions.Instructions & OfKind<Object> & Unknown>;
    name?: string;
    outline?: Ref<Outline & OfKind<Object> & Unknown>;
    routines: readonly Ref<Routine.Routine & OfKind<Object> & Unknown>[];
    specs: readonly Ref<Spec.Spec>[];
    status?: "active" | "paused" | "blocked" | "ended";
    taskSet?: Ref<TaskSet & OfKind<Object> & Unknown>;
} & OfKind<Object, this>
- Project

Constructors

constructor

new Project(_: never): Project.Project
Parameters
- _: never
Returns Project.Project
Inherited from Type.makeObject<Project>(DXN.make('org.dxos.type.project', '0.8.0'))( Schema.Struct({ name: Schema.optional(Schema.String), description: Schema.optional(Format.Text), /** Work-stream lifecycle state. */ status: Schema.optional( ProjectStatus.pipe( Format.FormatAnnotation.set(Format.TypeFormat.SingleSelect), Schema.annotate({ title: 'Status', [PropertyMetaAnnotationId]: { singleSelect: { options: ProjectStatusOptions } }, }), ), ), /** Owned agent instructions (created at the plugin layer; parented by `SetParent`). */ instructions: Schema.optional( Ref.Ref(Instructions.Instructions).pipe(Annotation.SetParent.set(), Annotation.FormInlineAnnotation.set(true)), ), /** Artifacts (documents, outliners, tables, ...), in order. */ artifacts: Schema.Array(Ref.Ref(Obj.Unknown)).pipe( Annotation.SetParent.set({ override: false }), Annotation.FormInputAnnotation.set(false), ), /** Routines the project owns, in order, parented so they cascade-delete with it. */ routines: Schema.Array(Ref.Ref(Routine.Routine)).pipe( Annotation.SetParent.set(), Annotation.FormInputAnnotation.set(false), ), /** Ad hoc markdown checklist — the scratch surface; project chats write into it. */ outline: Schema.optional(Ref.Ref(Outline.Outline).pipe(Annotation.SetParent.set())), /** * Owned specs, in order: the normative text the project's tasks deliver. A form creates each and edits it inline. * Suspended because Spec refers back. */ specs: Schema.Array(Schema.suspend((): Ref.RefSchema<Spec.Spec> => Ref.Ref(Spec.Spec))).pipe( Annotation.SetParent.set(), Annotation.FormCreateAnnotation.set(Type.getTypename(Spec.Spec)), ), /** Owned (or adopted synced) task container, holding the project's tasks and milestones. */ taskSet: Schema.optional(Ref.Ref(TaskSet.TaskSet).pipe(Annotation.SetParent.set())), }).pipe( Schema.annotate({ title: 'Project' }), Annotation.LabelAnnotation.set(['name']), Annotation.IconAnnotation.set({ icon: 'ph--stack--regular', hue: 'amber' }), ArchivableAnnotation.set(true), // Only the project skill: filing created objects into `artifacts` is what a project-scoped // session structurally needs; artifact-type skills are enabled on demand. Plain dotted key, so // the type does not depend on the plugin that owns the skill. Skill.SkillsAnnotation.set(['org.dxos.skill.project']), 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<Project>(DXN.make('org.dxos.type.project', '0.8.0'))( Schema.Struct({ name: Schema.optional(Schema.String), description: Schema.optional(Format.Text), /** Work-stream lifecycle state. */ status: Schema.optional( ProjectStatus.pipe( Format.FormatAnnotation.set(Format.TypeFormat.SingleSelect), Schema.annotate({ title: 'Status', [PropertyMetaAnnotationId]: { singleSelect: { options: ProjectStatusOptions } }, }), ), ), /** Owned agent instructions (created at the plugin layer; parented by `SetParent`). */ instructions: Schema.optional( Ref.Ref(Instructions.Instructions).pipe(Annotation.SetParent.set(), Annotation.FormInlineAnnotation.set(true)), ), /** Artifacts (documents, outliners, tables, ...), in order. */ artifacts: Schema.Array(Ref.Ref(Obj.Unknown)).pipe( Annotation.SetParent.set({ override: false }), Annotation.FormInputAnnotation.set(false), ), /** Routines the project owns, in order, parented so they cascade-delete with it. */ routines: Schema.Array(Ref.Ref(Routine.Routine)).pipe( Annotation.SetParent.set(), Annotation.FormInputAnnotation.set(false), ), /** Ad hoc markdown checklist — the scratch surface; project chats write into it. */ outline: Schema.optional(Ref.Ref(Outline.Outline).pipe(Annotation.SetParent.set())), /** * Owned specs, in order: the normative text the project's tasks deliver. A form creates each and edits it inline. * Suspended because Spec refers back. */ specs: Schema.Array(Schema.suspend((): Ref.RefSchema<Spec.Spec> => Ref.Ref(Spec.Spec))).pipe( Annotation.SetParent.set(), Annotation.FormCreateAnnotation.set(Type.getTypename(Spec.Spec)), ), /** Owned (or adopted synced) task container, holding the project's tasks and milestones. */ taskSet: Schema.optional(Ref.Ref(TaskSet.TaskSet).pipe(Annotation.SetParent.set())), }).pipe( Schema.annotate({ title: 'Project' }), Annotation.LabelAnnotation.set(['name']), Annotation.IconAnnotation.set({ icon: 'ph--stack--regular', hue: 'amber' }), ArchivableAnnotation.set(true), // Only the project skill: filing created objects into `artifacts` is what a project-scoped // session structurally needs; artifact-type skills are enabled on demand. Plain dotted key, so // the type does not depend on the plugin that owns the skill. Skill.SkillsAnnotation.set(['org.dxos.skill.project']), Annotation.UserType.set(), ), ).~@dxos/echo/Kind

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

`Readonly`artifacts

artifacts: readonly Ref<Unknown>[] = ...

Artifacts (documents, outliners, tables, ...), in order.

Defined in packages/core/compute/compute/src/types/Project.ts:60

`Optional` `Readonly`description

description?: string = ...

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

`Readonly`id

id: string

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

`Optional` `Readonly`instructions

instructions?: Ref<Instructions.Instructions & OfKind<Object> & Unknown> = ...

Owned agent instructions (created at the plugin layer; parented by SetParent).

Defined in packages/core/compute/compute/src/types/Project.ts:55

`Optional` `Readonly`name

name?: string = ...

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

`Optional` `Readonly`outline

outline?: Ref<Outline & OfKind<Object> & Unknown> = ...

Ad hoc markdown checklist — the scratch surface; project chats write into it.

Defined in packages/core/compute/compute/src/types/Project.ts:72

`Readonly`routines

routines: readonly Ref<Routine.Routine & OfKind<Object> & Unknown>[] = ...

Routines the project owns, in order, parented so they cascade-delete with it.

Defined in packages/core/compute/compute/src/types/Project.ts:66

`Readonly`specs

specs: readonly Ref<Spec.Spec>[] = ...

Owned specs, in order: the normative text the project's tasks deliver. A form creates each and edits it inline. Suspended because Spec refers back.

Defined in packages/core/compute/compute/src/types/Project.ts:78

`Optional` `Readonly`status

status?: "active" | "paused" | "blocked" | "ended" = ...

Work-stream lifecycle state.

Defined in packages/core/compute/compute/src/types/Project.ts:44

`Optional` `Readonly`taskSet

taskSet?: Ref<TaskSet & OfKind<Object> & Unknown> = ...

Owned (or adopted synced) task container, holding the project's tasks and milestones.

Defined in packages/core/compute/compute/src/types/Project.ts:84

`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"?: Project.Project & 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 Project

Hierarchy

Index

Constructors

Properties

Constructors

constructor

Parameters

Returns Project.Project

Properties

`Readonly`~@dxos/echo/Kind

`Readonly`artifacts

`Optional` `Readonly`description

`Readonly`id

`Optional` `Readonly`instructions

`Optional` `Readonly`name

`Optional` `Readonly`outline

`Readonly`routines

`Readonly`specs

`Optional` `Readonly`status

`Optional` `Readonly`taskSet

`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 Project

Hierarchy

Index

Constructors

Properties

Constructors

constructor

Parameters

Returns Project.Project

Properties

Readonly~@dxos/echo/Kind

Readonlyartifacts

Optional Readonlydescription

Readonlyid

Optional Readonlyinstructions

Optional Readonlyname

Optional Readonlyoutline

Readonlyroutines

Readonlyspecs

Optional Readonlystatus

Optional ReadonlytaskSet

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

`Readonly`artifacts

`Optional` `Readonly`description

`Readonly`id

`Optional` `Readonly`instructions

`Optional` `Readonly`name

`Optional` `Readonly`outline

`Readonly`routines

`Readonly`specs

`Optional` `Readonly`status

`Optional` `Readonly`taskSet

`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