@dxos/compute - v0.16.0
    Preparing search index...

    Class SpecReview

    One compliance review of a spec: which commit's code was read, when and by whom, and a verdict per spec item. The format is fixed (a .review.mdl file's), so a review is created whole and never edited by hand. A spec's history is its reviews; an item's current status is its newest verdict in any of them.

    Hierarchy

    • {
          by: string;
          commit: string;
          date: string;
          spec: Ref<Spec.Spec & OfKind<Object> & Unknown>;
          summary?: string;
          verdicts: {
              readonly [key: string]: {
                  evidence: readonly string[];
                  note?: string;
                  status: "done" | "untested" | "partial" | "diverged" | "missing";
                  summary?: string;
                  tests: readonly string[];
                  walkthrough: readonly { key: string; text: string }[];
              };
          };
      } & OfKind<Object, this>
      • SpecReview
    Index

    Constructors

    • Parameters

      • _: never

      Returns SpecReview.SpecReview

    Properties

    "~@dxos/echo/Kind": Object
    by: string = Schema.String

    Who made it: user:<handle> or agent:<name>.

    commit: string = Schema.String

    The commit the code was read at.

    date: string = Schema.String

    When the review was made: YYYY-MM-DD, or YYYY-MM-DDTHH:MMZ in UTC to order the reviews of one day.

    id: string
    spec: Ref<Spec.Spec & OfKind<Object> & Unknown> = ...
    summary?: string = ...
    verdicts: {
        readonly [key: string]: {
            evidence: readonly string[];
            note?: string;
            status: "done" | "untested" | "partial" | "diverged" | "missing";
            summary?: string;
            tests: readonly string[];
            walkthrough: readonly { key: string; text: string }[];
        };
    } = ...

    Keyed by spec item id: a block (Scene, F-3) or a nested requirement (F-3.2).

    "~@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.

    "~@dxos/echo/SchemaKind": Object

    Schema-kind brand (object).

    "~@dxos/echo/Type.Instance"?: SpecReview.SpecReview & OfKind<Object>
    "~@dxos/echo/Type.StaticSchema": Codec<any, any>

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

    fields: {}

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

    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).

    jsonSchema: JsonSchemaType
    name?: string