ApiCoreInterfaces
Interface: UnsignedVersion\<T\>
Defined in: packages/core/src/types.ts:90
A version before it is signed: its envelope and its body. What is signed is the envelope, with the body's hash in place of the body (Envelope).
Type Parameters
| Type Parameter | Default type |
|---|---|
T | unknown |
Properties
| Property | Modifier | Type | Description | Defined in |
|---|---|---|---|---|
author | readonly | string | - | packages/core/src/types.ts:91 |
body | readonly | T | The content: signed through Envelope.bodyHash, not itself. Absent on a stub, a version kept without its body once it is superseded. null on a delete. | packages/core/src/types.ts:103 |
collection | readonly | string | - | packages/core/src/types.ts:92 |
createdAt | readonly | string | - | packages/core/src/types.ts:97 |
deleted? | readonly | true | This version deletes the record; its body is null | packages/core/src/types.ts:131 |
genesis? | readonly | string | Id of the record's first version — who created it. Absent on seq 0. | packages/core/src/types.ts:113 |
key | readonly | string | The record's identity, stable across versions. Links point here. | packages/core/src/types.ts:107 |
links? | readonly | readonly Link[] | Links to other records. Signed with the rest. In a private space they are sealed inside the encrypted body instead, and this is absent. | packages/core/src/types.ts:136 |
log? | readonly | WriterLog | Its place in its writer's line for its collection in this space: a key's writes in one collection of a space form one line, n from 0, each naming the one before. Two versions by one key at one place are a fork (02 §4.10). Required in a space. | packages/core/src/types.ts:120 |
prev? | readonly | string | Id of the version this one replaces. Absent on seq 0. | packages/core/src/types.ts:111 |
proof? | readonly | Delegation | The note that lets the author write this, one token from its account, if delegated — signed along with the rest | packages/core/src/types.ts:105 |
retain? | readonly | true | Keep this version once it is superseded — set by the writer, from the collection's history | packages/core/src/types.ts:122 |
seen? | readonly | readonly string[] | The latest changes to the space's access history — roles, members, invites, revoked notes, collection definitions — its writer knew of. It is judged by who held what, and which definition was in force, as of those (space/roles.ts). | packages/core/src/types.ts:129 |
seq | readonly | number | 0 for a record's first version; each later version is one more than the one it replaces | packages/core/src/types.ts:109 |
space? | readonly | string | Space this belongs to — signed, so it cannot be replayed into another space. Omitted for unscoped data. | packages/core/src/types.ts:94 |
tags? | readonly | readonly string[] | Topic tags: a keyed hash of each value of each field the collection names as a topic (records/topics.ts), so a node that can't read the body can still match what it's about. Signed with the rest; checked by any node that can read the body. | packages/core/src/types.ts:143 |
to? | readonly | string | For a loose version (no space), the public key it is sealed to: signed, so it can't be re-sealed to another (02 §3.5) | packages/core/src/types.ts:96 |