Surface / foldkit-metadata

Evidence

namespace · packages/metadata/src/evidence.ts:84

const Evidence = {
  Enumerated,
  Bounded,
  Scenario,
  Walked,
  $is,
  $match,
  issuer,
  issuedBy,
  runtimeOnly,
}

Its type

type Evidence = Data.TaggedEnum<{
  Enumerated: {
    readonly transition: string
    readonly law: string
  }
  Bounded: {
    readonly transition: string
    readonly law: string
  }
  Scenario: {
    readonly transition: string
    readonly law: string
    readonly name: string
    readonly runner: string
  }
  Walked: {
    readonly transition: string
    readonly law: string
    readonly seeds: number
    readonly steps: number
    readonly starts: ReadonlyArray<string>
  }
  RuntimeOnly: {
    readonly transition: string
    readonly law: string
    readonly why: string
  }
}>

A transition (write:Sell, durable:CreatedTodo) keeps a law (Product.reservedWithinStock), and how that was shown.

In the guides

Members

Evidence.Enumerated

const · packages/metadata/src/evidence.ts:86

Enumerated: Data.TaggedEnum.ConstructorFrom<
  {
    readonly _tag: 'Enumerated'
    readonly transition: string
    readonly law: string
  },
  '_tag'
>

Records for a producer to issue; one made here and not issued has no issuer.

Evidence.Bounded

const · packages/metadata/src/evidence.ts:87

Bounded: Data.TaggedEnum.ConstructorFrom<
  {
    readonly _tag: 'Bounded'
    readonly transition: string
    readonly law: string
  },
  '_tag'
>

Evidence.Scenario

const · packages/metadata/src/evidence.ts:88

Scenario: Data.TaggedEnum.ConstructorFrom<
  {
    readonly _tag: 'Scenario'
    readonly transition: string
    readonly law: string
    readonly name: string
    readonly runner: string
  },
  '_tag'
>

Evidence.Walked

const · packages/metadata/src/evidence.ts:89

Walked: Data.TaggedEnum.ConstructorFrom<
  {
    readonly _tag: 'Walked'
    readonly transition: string
    readonly law: string
    readonly seeds: number
    readonly steps: number
    readonly starts: ReadonlyArray<string>
  },
  '_tag'
>

Evidence.$is

const · packages/metadata/src/evidence.ts:90

$is: <
  Tag extends
    'Enumerated' | 'Bounded' | 'Scenario' | 'Walked' | 'RuntimeOnly',
>(
  tag: Tag,
) => (
  u: unknown,
) => u is
  | Extract<
      {
        readonly _tag: 'Enumerated'
        readonly transition: string
        readonly law: string
      },
      { readonly _tag: Tag }
    >
  | Extract<
      {
        readonly _tag: 'Bounded'
        readonly transition: string
        readonly law: string
      },
      { readonly _tag: Tag }
    >
  | Extract<
      {
        readonly _tag: 'Scenario'
        readonly transition: string
        readonly law: string
        readonly name: string
        readonly runner: string
      },
      { readonly _tag: Tag }
    >
  | Extract<
      {
        readonly _tag: 'Walked'
        readonly transition: string
        readonly law: string
        readonly seeds: number
        readonly steps: number
        readonly starts: ReadonlyArray<string>
      },
      { readonly _tag: Tag }
    >
  | Extract<
      {
        readonly _tag: 'RuntimeOnly'
        readonly transition: string
        readonly law: string
        readonly why: string
      },
      { readonly _tag: Tag }
    >

Evidence.$match

const · packages/metadata/src/evidence.ts:91

$match: { <Cases extends { readonly Enumerated: (args: { readonly _tag: "Enumerated"; readonly transition: string; readonly law: string; }) => any; readonly Bounded: (args: { readonly _tag: "Bounded"; readonly transition: string; readonly law: string; }) => any; readonly Scenario: (args: { readonly _tag: "Scenario"; readonly transition: string; readonly law: string; readonly name: string; readonly runner: string; }) => any; readonly Walked: (args: { readonly _tag: "Walked"; readonly transition: string; readonly law: string; readonly seeds: number; readonly steps: number; readonly starts: ReadonlyArray<string>; }) => any; readonly RuntimeOnly: (args: { readonly _tag: "RuntimeOnly"; readonly transition: string; readonly law: string; readonly why: string; }) => any; }>(cases: Cases): (value: { readonly _tag: "Enumerated"; readonly transition: string; readonly law: string; } | { readonly _tag: "Bounded"; readonly transition: string; readonly law: string; } | { readonly _tag: "Scenario"; readonly transition: string; readonly law: string; readonly name: string; readonly runner: string; } | { readonly _tag: "Walked"; readonly transition: string; readonly law: string; readonly seeds: number; readonly steps: number; readonly starts: ReadonlyArray<string>; } | { readonly _tag: "RuntimeOnly"; readonly transition: string; readonly law: string; readonly why: string; }) => Unify<ReturnType<Cases["Enumerated" | "Bounded" | "Scenario" | "Walked" | "RuntimeOnly"]>>; <Cases extends { readonly Enumerat …;

Evidence.issuer

function · packages/metadata/src/evidence.ts:56

issuer(name: string): EvidenceIssuer

Made once, at module level, by a module that produces evidence; a second issuer of a name throws, so a module loaded after a producer cannot stamp as it. Only the producers call it, which scripts/evidence-check.mjs holds in this repository; nothing stops another author taking an unused name, so a stamp says who made a record, not that the record is true.

Evidence.issuedBy

function · packages/metadata/src/evidence.ts:102

issuedBy(record: Evidence): Option.Option<string>

The producer that issued record; none for a record typed by hand or copied.

Evidence.runtimeOnly

function · packages/metadata/src/evidence.ts:109

runtimeOnly(fields: {
  readonly transition: string
  readonly law: string
  readonly why: string
}):
  | {
      readonly _tag: 'Enumerated'
      readonly transition: string
      readonly law: string
    }
  | {
      readonly _tag: 'Bounded'
      readonly transition: string
      readonly law: string
    }
  | {
      readonly _tag: 'Scenario'
      readonly transition: string
      readonly law: string
      readonly name: string
      readonly runner: string
    }
  | {
      readonly _tag: 'Walked'
      readonly transition: string
      readonly law: string
      readonly seeds: number
      readonly steps: number
      readonly starts: ReadonlyArray<string>
    }
  | {
      readonly _tag: 'RuntimeOnly'
      readonly transition: string
      readonly law: string
      readonly why: string
    }

The record for a pair nothing before production covers: the writer or the journal refuses it, and why says why no check, walk or scenario can. Throws on an empty reason.