Class ModelInstanceDocument<T>

ModelInstanceDocument stream implementation

Type Parameters

T = Record<string, any>

Hierarchy

Stream
- ModelInstanceDocument

Index

Constructors

constructor

new ModelInstanceDocument<T>(state$: RunningStateLike, api: StreamReaderWriter): ModelInstanceDocument<T>
Type Parameters
- T = Record<string, any>
Parameters
- state$: RunningStateLike
- api: StreamReaderWriter
Returns ModelInstanceDocument<T>
Inherited from Stream.constructor
- Defined in packages/common/lib/stream.d.ts:110

Properties

`Protected` `Readonly` state$

state$: RunningStateLike

`Static` MAX_DOCUMENT_SIZE

MAX_DOCUMENT_SIZE: number = 16_000_000

`Static` STREAM_TYPE_ID

STREAM_TYPE_ID: number = 3

`Static` STREAM_TYPE_NAME

STREAM_TYPE_NAME: string = 'MID'

Accessors

allCommitIds

get allCommitIds(): CommitID[]
Returns CommitID[]
Inherited from Stream.allCommitIds
- Defined in packages/common/lib/stream.d.ts:117

anchorCommitIds

get anchorCommitIds(): CommitID[]
Returns CommitID[]
Inherited from Stream.anchorCommitIds
- Defined in packages/common/lib/stream.d.ts:118

api

get api(): StreamReaderWriter
Returns StreamReaderWriter
Inherited from Stream.api
- Defined in packages/common/lib/stream.d.ts:112

commitId

get commitId(): CommitID
Returns CommitID
Inherited from Stream.commitId
- Defined in packages/common/lib/stream.d.ts:116

content

get content(): T
Returns T
Overrides Stream.content
- Defined in packages/stream-model-instance/src/model-instance-document.ts:148

id

get id(): StreamID
Returns StreamID
Inherited from Stream.id
- Defined in packages/common/lib/stream.d.ts:111

isReadOnly

get isReadOnly(): boolean
Returns boolean
Overrides Stream.isReadOnly
- Defined in packages/stream-model-instance/src/model-instance-document.ts:365

metadata

get metadata(): ModelInstanceDocumentMetadata
Returns ModelInstanceDocumentMetadata
Overrides Stream.metadata
- Defined in packages/stream-model-instance/src/model-instance-document.ts:152

state

get state(): StreamState<StreamMetadata>
Returns StreamState<StreamMetadata>
Inherited from Stream.state
- Defined in packages/common/lib/stream.d.ts:119

tip

get tip(): CID<unknown, number, number, Version>
Returns CID<unknown, number, number, Version>
Inherited from Stream.tip
- Defined in packages/common/lib/stream.d.ts:115

Methods

makeReadOnly

makeReadOnly(): void
Makes this document read-only. After this has been called any future attempts to call mutation methods on the instance will throw.

Returns void
Overrides Stream.makeReadOnly
- Defined in packages/stream-model-instance/src/model-instance-document.ts:358

patch

patch(jsonPatch: Operation[], metadata?: Partial<ModelInstanceDocumentMetadataArgs>, opts?: UpdateOpts): Promise<void>
Update the contents of an existing Model Instance Document based on a JSON-patch diff from the existing contents to the desired new contents
Parameters
- jsonPatch: Operation[]
  
  JSON patch diff of document contents
- metadata: Partial<ModelInstanceDocumentMetadataArgs> = undefined
  
  Metadata change
- opts: UpdateOpts = {}
  
  Additional options
Returns Promise<void>
- Defined in packages/stream-model-instance/src/model-instance-document.ts:305

replace

replace(content: T, metadata?: Partial<ModelInstanceDocumentMetadataArgs>, opts?: UpdateOpts): Promise<void>
Update an existing Model Instance Document by replacing its content
Parameters
- content: T
  
  New content to replace old content
- metadata: Partial<ModelInstanceDocumentMetadataArgs> = undefined
- opts: UpdateOpts = {}
  
  Additional options
Returns Promise<void>
- Defined in packages/stream-model-instance/src/model-instance-document.ts:271

requestAnchor

requestAnchor(): Promise<AnchorStatus>
Returns Promise<AnchorStatus>
Inherited from Stream.requestAnchor
- Defined in packages/common/lib/stream.d.ts:121

shouldIndex

shouldIndex(shouldIndex: boolean, opts?: UpdateOpts): Promise<void>
Set the index metadata field for the stream
Parameters
- shouldIndex: boolean
  
  Whether the stream should be indexed or not
- opts: UpdateOpts = {}
  
  Additional options
Returns Promise<void>
- Defined in packages/stream-model-instance/src/model-instance-document.ts:350

sync

sync(opts?: LoadOpts): Promise<void>
Parameters
- Optional opts: LoadOpts
Returns Promise<void>
Inherited from Stream.sync
- Defined in packages/common/lib/stream.d.ts:120

`Static` create

create<T>(ceramic: StreamWriter, content: T, metadata: ModelInstanceDocumentMetadataArgs, opts?: CreateOpts): Promise<ModelInstanceDocument<T>>
Creates a Model Instance Document.
Type Parameters
- T
Parameters
- ceramic: StreamWriter
  
  Interface to write to ceramic network
- content: T
  
  Genesis contents. If 'null', then no signature is required to make the genesis commit
- metadata: ModelInstanceDocumentMetadataArgs
  
  Genesis metadata, including the model that this document belongs to
- opts: CreateOpts = {}
  
  Additional options
Returns Promise<ModelInstanceDocument<T>>
Overrides Stream.create
- Defined in packages/stream-model-instance/src/model-instance-document.ts:170

`Static` load

load<T>(reader: StreamReader, streamId: string | StreamID | CommitID, opts?: LoadOpts): Promise<ModelInstanceDocument<T>>
Loads a Model Instance Document from a given StreamID
Type Parameters
- T
Parameters
- reader: StreamReader
  
  Interface for reading streams from ceramic network
- streamId: string | StreamID | CommitID
  
  StreamID to load. Must correspond to a ModelInstanceDocument
- opts: LoadOpts = {}
  
  Additional options
Returns Promise<ModelInstanceDocument<T>>
- Defined in packages/stream-model-instance/src/model-instance-document.ts:247

`Static` makeGenesis

makeGenesis<T>(context: IntoSigner, content: T, metadata: ModelInstanceDocumentMetadataArgs, unique?: string[]): Promise<DagJWSResult | GenesisCommit>
Create genesis commit.
Type Parameters
- T
Parameters
- context: IntoSigner
  
  Object containing the DID making (and signing) the commit
- content: T
  
  genesis content
- metadata: ModelInstanceDocumentMetadataArgs
  
  genesis metadata
- Optional unique: string[]
  
  optional array of strings to set the unique header value
Returns Promise<DagJWSResult | GenesisCommit>
- Defined in packages/stream-model-instance/src/model-instance-document.ts:418

`Static` makeUpdateCommit

makeUpdateCommit<T>(signer: CeramicSigner, prev: CommitID, oldContent: T, newContent: T, header?: Partial<CommitHeader>): Promise<CeramicCommit>
Make a commit to update the document. Can be applied using the applyCommit method on the Ceramic client.
Type Parameters
- T
Parameters
- signer: CeramicSigner
  
  Interface to create signatures
- prev: CommitID
  
  The CommitID of the current tip of the Stream that the update should be applied on top of.
- oldContent: T
  
  The current content of the Stream.
- newContent: T
  
  The new content to update the Stream with.
- Optional header: Partial<CommitHeader>
  
  New commit header, used to update the stream's metadata. Metadata fields not specified will be left alone with their current values.
Returns Promise<CeramicCommit>
- Defined in packages/stream-model-instance/src/model-instance-document.ts:378

`Static` set

set<T>(ceramic: StreamWriter, metadata: ModelInstanceDocumentMetadataArgs, unique: string[], opts?: CreateOpts): Promise<ModelInstanceDocument<T>>
Creates a deterministic ModelInstanceDocument with a 'set' accountRelation.
Type Parameters
- T
Parameters
- ceramic: StreamWriter
  
  Interface to write to ceramic network
- metadata: ModelInstanceDocumentMetadataArgs
  
  Genesis metadata
- unique: string[]
  
  Unique fields values
- opts: CreateOpts = {}
  
  Additional options
Returns Promise<ModelInstanceDocument<T>>
- Defined in packages/stream-model-instance/src/model-instance-document.ts:221

`Static` single

single<T>(ceramic: StreamWriter, metadata: ModelInstanceDocumentMetadataArgs, opts?: CreateOpts): Promise<ModelInstanceDocument<T>>
Creates a deterministic ModelInstanceDocument with a 'single' accountRelation.
Type Parameters
- T
Parameters
- ceramic: StreamWriter
  
  Interface to write to ceramic network
- metadata: ModelInstanceDocumentMetadataArgs
  
  Genesis metadata
- opts: CreateOpts = {}
  
  Additional options
Returns Promise<ModelInstanceDocument<T>>
- Defined in packages/stream-model-instance/src/model-instance-document.ts:195

Class ModelInstanceDocument<T>

Type Parameters

T = Record<string, any>

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

T = Record<string, any>

Parameters

state$: RunningStateLike

api: StreamReaderWriter

Returns ModelInstanceDocument<T>

Properties

Protected Readonly state$

Static MAX_DOCUMENT_SIZE

Static STREAM_TYPE_ID

Static STREAM_TYPE_NAME

Accessors

allCommitIds

Returns CommitID[]

anchorCommitIds

Returns CommitID[]

api

Returns StreamReaderWriter

commitId

Returns CommitID

content

Returns T

id

Returns StreamID

isReadOnly

Returns boolean

metadata

Returns ModelInstanceDocumentMetadata

state

Returns StreamState<StreamMetadata>

tip

Returns CID<unknown, number, number, Version>

Methods

makeReadOnly

Returns void

patch

Parameters

jsonPatch: Operation[]

metadata: Partial<ModelInstanceDocumentMetadataArgs> = undefined

opts: UpdateOpts = {}

Returns Promise<void>

replace

Parameters

content: T

metadata: Partial<ModelInstanceDocumentMetadataArgs> = undefined

opts: UpdateOpts = {}

Returns Promise<void>

requestAnchor

Returns Promise<AnchorStatus>

shouldIndex

Parameters

shouldIndex: boolean

opts: UpdateOpts = {}

Returns Promise<void>

sync

Parameters

Optional opts: LoadOpts

Returns Promise<void>

Static create

Type Parameters

T

Parameters

ceramic: StreamWriter

content: T

metadata: ModelInstanceDocumentMetadataArgs

opts: CreateOpts = {}

Returns Promise<ModelInstanceDocument<T>>

Static load

Type Parameters

`Protected` `Readonly` state$

`Static` MAX_DOCUMENT_SIZE

`Static` STREAM_TYPE_ID

`Static` STREAM_TYPE_NAME

`Optional` opts: LoadOpts

`Static` create

`Static` load

`Static` makeGenesis

`Optional` unique: string[]

`Static` makeUpdateCommit

`Optional` header: Partial<CommitHeader>

`Static` set

`Static` single