diff --git a/docs/@ceramic-sdk/model-client/classes/ModelClient.md b/docs/@ceramic-sdk/model-client/classes/ModelClient.md index bfa4fdb..55d8cb6 100644 --- a/docs/@ceramic-sdk/model-client/classes/ModelClient.md +++ b/docs/@ceramic-sdk/model-client/classes/ModelClient.md @@ -9,7 +9,7 @@ Represents a client for interacting with Ceramic models. The `ModelClient` class extends the `StreamClient` class to provide additional -methods specific to working with Ceramic models, including fetching and posting +methods specific to working with Ceramic models, including fetching and creating model definitions, retrieving initialization events, and decoding stream data. ## Extends @@ -62,6 +62,34 @@ The `CeramicClient` instance associated with this StreamClient. ## Methods +### createDefinition() + +> **createDefinition**(`definition`, `signer`?): `Promise`\<[`StreamID`](../../identifiers/classes/StreamID.md)\> + +Creates a model definition and returns the resulting stream ID. + +#### Parameters + +• **definition**: `MapIn`\<`RequiredProps`\<`object`\>, `$TypeOf`\> & `MapIn`\<`OptionalProps`\<`object`\>, `$TypeOf`\> \| `MapIn`\<`RequiredProps`\<`object`\>, `$TypeOf`\> & `MapIn`\<`OptionalProps`\<`object`\>, `$TypeOf`\> + +The model JSON definition to post. + +• **signer?**: `DID` + +(Optional) A `DID` instance for signing the model definition. + +#### Returns + +`Promise`\<[`StreamID`](../../identifiers/classes/StreamID.md)\> + +A promise that resolves to the `StreamID` of the posted model. + +#### Throws + +Will throw an error if the definition is invalid or the signing process fails. + +*** + ### getDID() > **getDID**(`provided`?): `DID` @@ -236,31 +264,3 @@ console.log(streamState); #### Inherited from [`StreamClient`](../../stream-client/classes/StreamClient.md).[`getStreamState`](../../stream-client/classes/StreamClient.md#getstreamstate) - -*** - -### postDefinition() - -> **postDefinition**(`definition`, `signer`?): `Promise`\<[`StreamID`](../../identifiers/classes/StreamID.md)\> - -Posts a model definition and returns the resulting stream ID. - -#### Parameters - -• **definition**: `MapIn`\<`RequiredProps`\<`object`\>, `$TypeOf`\> & `MapIn`\<`OptionalProps`\<`object`\>, `$TypeOf`\> \| `MapIn`\<`RequiredProps`\<`object`\>, `$TypeOf`\> & `MapIn`\<`OptionalProps`\<`object`\>, `$TypeOf`\> - -The model JSON definition to post. - -• **signer?**: `DID` - -(Optional) A `DID` instance for signing the model definition. - -#### Returns - -`Promise`\<[`StreamID`](../../identifiers/classes/StreamID.md)\> - -A promise that resolves to the `StreamID` of the posted model. - -#### Throws - -Will throw an error if the definition is invalid or the signing process fails. diff --git a/docs/@ceramic-sdk/model-instance-client/README.md b/docs/@ceramic-sdk/model-instance-client/README.md index 776feee..5f65d7b 100644 --- a/docs/@ceramic-sdk/model-instance-client/README.md +++ b/docs/@ceramic-sdk/model-instance-client/README.md @@ -14,9 +14,9 @@ - [CreateDataEventParams](type-aliases/CreateDataEventParams.md) - [CreateInitEventParams](type-aliases/CreateInitEventParams.md) +- [CreateInstanceParams](type-aliases/CreateInstanceParams.md) +- [CreateSingletonParams](type-aliases/CreateSingletonParams.md) - [PostDataParams](type-aliases/PostDataParams.md) -- [PostDeterministicInitParams](type-aliases/PostDeterministicInitParams.md) -- [PostSignedInitParams](type-aliases/PostSignedInitParams.md) - [UnknownContent](type-aliases/UnknownContent.md) ## Functions diff --git a/docs/@ceramic-sdk/model-instance-client/classes/ModelInstanceClient.md b/docs/@ceramic-sdk/model-instance-client/classes/ModelInstanceClient.md index 8d04282..0140c31 100644 --- a/docs/@ceramic-sdk/model-instance-client/classes/ModelInstanceClient.md +++ b/docs/@ceramic-sdk/model-instance-client/classes/ModelInstanceClient.md @@ -10,7 +10,7 @@ Extends the StreamClient to add functionality for interacting with Ceramic model The `ModelInstanceClient` class provides methods to: - Retrieve events and document states -- Post deterministic and signed initialization events +- Create instances and singleton of models - Update existing documents with new content ## Extends @@ -63,6 +63,43 @@ The `CeramicClient` instance associated with this StreamClient. ## Methods +### createInstance() + +> **createInstance**\<`T`\>(`params`): `Promise`\<[`CommitID`](../../identifiers/classes/CommitID.md)\> + +Creates an instance of a model. The model must have an account relation of list or set. + +#### Type Parameters + +• **T** *extends* [`UnknownContent`](../type-aliases/UnknownContent.md) = [`UnknownContent`](../type-aliases/UnknownContent.md) + +#### Parameters + +• **params**: [`CreateInstanceParams`](../type-aliases/CreateInstanceParams.md)\<`T`\> + +#### Returns + +`Promise`\<[`CommitID`](../../identifiers/classes/CommitID.md)\> + +*** + +### createSingleton() + +> **createSingleton**(`params`): `Promise`\<[`CommitID`](../../identifiers/classes/CommitID.md)\> + +Creates an instance of a model with account relation single. +By definition this instance will always be a singleton. + +#### Parameters + +• **params**: [`CreateSingletonParams`](../type-aliases/CreateSingletonParams.md) + +#### Returns + +`Promise`\<[`CommitID`](../../identifiers/classes/CommitID.md)\> + +*** + ### getCurrentID() > **getCurrentID**(`streamID`): [`CommitID`](../../identifiers/classes/CommitID.md) @@ -241,61 +278,6 @@ current state of the stream. *** -### postDeterministicInit() - -> **postDeterministicInit**(`params`): `Promise`\<[`CommitID`](../../identifiers/classes/CommitID.md)\> - -Posts a deterministic initialization event and returns its commit ID. - -#### Parameters - -• **params**: [`PostDeterministicInitParams`](../type-aliases/PostDeterministicInitParams.md) - -Parameters for posting the deterministic init event. - -#### Returns - -`Promise`\<[`CommitID`](../../identifiers/classes/CommitID.md)\> - -A promise that resolves to the `CommitID` of the posted event. - -#### Remarks - -This method ensures that the resulting stream ID is deterministic, derived -from the `uniqueValue` parameter. Commonly used for model instance documents -of type `set` and `single`. - -*** - -### postSignedInit() - -> **postSignedInit**\<`T`\>(`params`): `Promise`\<[`CommitID`](../../identifiers/classes/CommitID.md)\> - -Posts a signed initialization event and returns its commit ID. - -#### Type Parameters - -• **T** *extends* [`UnknownContent`](../type-aliases/UnknownContent.md) = [`UnknownContent`](../type-aliases/UnknownContent.md) - -#### Parameters - -• **params**: [`PostSignedInitParams`](../type-aliases/PostSignedInitParams.md)\<`T`\> - -Parameters for posting the signed init event. - -#### Returns - -`Promise`\<[`CommitID`](../../identifiers/classes/CommitID.md)\> - -A promise that resolves to the `CommitID` of the posted event. - -#### Remarks - -This method results in a non-deterministic stream ID, typically used for -model instance documents of type `list`. - -*** - ### streamStateToDocumentState() > **streamStateToDocumentState**(`streamState`): `DocumentState` diff --git a/docs/@ceramic-sdk/model-instance-client/type-aliases/PostSignedInitParams.md b/docs/@ceramic-sdk/model-instance-client/type-aliases/CreateInstanceParams.md similarity index 66% rename from docs/@ceramic-sdk/model-instance-client/type-aliases/PostSignedInitParams.md rename to docs/@ceramic-sdk/model-instance-client/type-aliases/CreateInstanceParams.md index 6ace0bd..92829b6 100644 --- a/docs/@ceramic-sdk/model-instance-client/type-aliases/PostSignedInitParams.md +++ b/docs/@ceramic-sdk/model-instance-client/type-aliases/CreateInstanceParams.md @@ -2,13 +2,13 @@ *** -[Ceramic SDK](../../../README.md) / [@ceramic-sdk/model-instance-client](../README.md) / PostSignedInitParams +[Ceramic SDK](../../../README.md) / [@ceramic-sdk/model-instance-client](../README.md) / CreateInstanceParams -# Type Alias: PostSignedInitParams\ +# Type Alias: CreateInstanceParams\ -> **PostSignedInitParams**\<`T`\>: `Omit`\<[`CreateInitEventParams`](CreateInitEventParams.md)\<`T`\>, `"controller"`\> & `object` +> **CreateInstanceParams**\<`T`\>: `Omit`\<[`CreateInitEventParams`](CreateInitEventParams.md)\<`T`\>, `"controller"`\> & `object` -Parameters for posting a signed initialization event. +Parameters for creating an instance of a model. ## Type declaration diff --git a/docs/@ceramic-sdk/model-instance-client/type-aliases/PostDeterministicInitParams.md b/docs/@ceramic-sdk/model-instance-client/type-aliases/CreateSingletonParams.md similarity index 71% rename from docs/@ceramic-sdk/model-instance-client/type-aliases/PostDeterministicInitParams.md rename to docs/@ceramic-sdk/model-instance-client/type-aliases/CreateSingletonParams.md index cfe1d72..55bb9df 100644 --- a/docs/@ceramic-sdk/model-instance-client/type-aliases/PostDeterministicInitParams.md +++ b/docs/@ceramic-sdk/model-instance-client/type-aliases/CreateSingletonParams.md @@ -2,13 +2,13 @@ *** -[Ceramic SDK](../../../README.md) / [@ceramic-sdk/model-instance-client](../README.md) / PostDeterministicInitParams +[Ceramic SDK](../../../README.md) / [@ceramic-sdk/model-instance-client](../README.md) / CreateSingletonParams -# Type Alias: PostDeterministicInitParams +# Type Alias: CreateSingletonParams -> **PostDeterministicInitParams**: `object` +> **CreateSingletonParams**: `object` -Parameters for posting a deterministic initialization event. +Parameters for creating a singleton instance of a model. ## Type declaration diff --git a/docs/@ceramic-sdk/model-instance-handler/README.md b/docs/@ceramic-sdk/model-instance-handler/README.md deleted file mode 100644 index 8547119..0000000 --- a/docs/@ceramic-sdk/model-instance-handler/README.md +++ /dev/null @@ -1,34 +0,0 @@ -**@ceramic-sdk/model-instance-handler v0.2.1** • **Docs** - -*** - -[Ceramic SDK](../../README.md) / @ceramic-sdk/model-instance-handler - -# @ceramic-sdk/model-instance-handler - -## Type Aliases - -- [Context](type-aliases/Context.md) -- [DocumentEvent](type-aliases/DocumentEvent.md) -- [DocumentEventPayload](type-aliases/DocumentEventPayload.md) -- [DocumentState](type-aliases/DocumentState.md) -- [UnknownContent](type-aliases/UnknownContent.md) - -## Variables - -- [DocumentEvent](variables/DocumentEvent.md) -- [DocumentEventPayload](variables/DocumentEventPayload.md) - -## Functions - -- [assertNoImmutableFieldChange](functions/assertNoImmutableFieldChange.md) -- [assertValidContent](functions/assertValidContent.md) -- [assertValidInitHeader](functions/assertValidInitHeader.md) -- [assertValidUniqueValue](functions/assertValidUniqueValue.md) -- [handleDataPayload](functions/handleDataPayload.md) -- [handleDeterministicInitPayload](functions/handleDeterministicInitPayload.md) -- [handleEvent](functions/handleEvent.md) -- [handleInitPayload](functions/handleInitPayload.md) -- [handleTimeEvent](functions/handleTimeEvent.md) -- [validateRelation](functions/validateRelation.md) -- [validateRelationsContent](functions/validateRelationsContent.md) diff --git a/docs/@ceramic-sdk/model-instance-handler/functions/assertNoImmutableFieldChange.md b/docs/@ceramic-sdk/model-instance-handler/functions/assertNoImmutableFieldChange.md deleted file mode 100644 index 0abb076..0000000 --- a/docs/@ceramic-sdk/model-instance-handler/functions/assertNoImmutableFieldChange.md +++ /dev/null @@ -1,21 +0,0 @@ -[**@ceramic-sdk/model-instance-handler v0.2.1**](../README.md) • **Docs** - -*** - -[Ceramic SDK](../../../README.md) / [@ceramic-sdk/model-instance-handler](../README.md) / assertNoImmutableFieldChange - -# Function: assertNoImmutableFieldChange() - -> **assertNoImmutableFieldChange**(`operations`, `immutableFields`): `void` - -Helper function to validate if immutable fields are being mutated - -## Parameters - -• **operations**: (`MapIn`\<`object`, `$TypeOf`\> \| `MapIn`\<`object`, `$TypeOf`\> \| `MapIn`\<`object`, `$TypeOf`\> \| `MapIn`\<`object`, `$TypeOf`\> \| `MapIn`\<`object`, `$TypeOf`\> \| `MapIn`\<`object`, `$TypeOf`\>)[] - -• **immutableFields**: `string`[] = `[]` - -## Returns - -`void` diff --git a/docs/@ceramic-sdk/model-instance-handler/functions/assertValidContent.md b/docs/@ceramic-sdk/model-instance-handler/functions/assertValidContent.md deleted file mode 100644 index 29722c5..0000000 --- a/docs/@ceramic-sdk/model-instance-handler/functions/assertValidContent.md +++ /dev/null @@ -1,25 +0,0 @@ -[**@ceramic-sdk/model-instance-handler v0.2.1**](../README.md) • **Docs** - -*** - -[Ceramic SDK](../../../README.md) / [@ceramic-sdk/model-instance-handler](../README.md) / assertValidContent - -# Function: assertValidContent() - -> **assertValidContent**\<`T`\>(`modelID`, `modelSchema`, `content`): `asserts content is T` - -## Type Parameters - -• **T** *extends* [`UnknownContent`](../type-aliases/UnknownContent.md) - -## Parameters - -• **modelID**: `string` - -• **modelSchema**: `Object`\<`any`\> - -• **content**: `unknown` - -## Returns - -`asserts content is T` diff --git a/docs/@ceramic-sdk/model-instance-handler/functions/assertValidInitHeader.md b/docs/@ceramic-sdk/model-instance-handler/functions/assertValidInitHeader.md deleted file mode 100644 index 82293f0..0000000 --- a/docs/@ceramic-sdk/model-instance-handler/functions/assertValidInitHeader.md +++ /dev/null @@ -1,25 +0,0 @@ -[**@ceramic-sdk/model-instance-handler v0.2.1**](../README.md) • **Docs** - -*** - -[Ceramic SDK](../../../README.md) / [@ceramic-sdk/model-instance-handler](../README.md) / assertValidInitHeader - -# Function: assertValidInitHeader() - -> **assertValidInitHeader**(`definition`, `header`): `void` - -Validates the ModelInstanceDocument header against the Model definition. - -## Parameters - -• **definition**: `MapIn`\<`RequiredProps`\<`object`\>, `$TypeOf`\> & `MapIn`\<`OptionalProps`\<`object`\>, `$TypeOf`\> \| `MapIn`\<`RequiredProps`\<`object`\>, `$TypeOf`\> & `MapIn`\<`OptionalProps`\<`object`\>, `$TypeOf`\> - -definition of the Model that this ModelInstanceDocument belongs to - -• **header**: `MapIn`\<`RequiredProps`\<`object`\>, `$TypeOf`\> & `MapIn`\<`OptionalProps`\<`object`\>, `$TypeOf`\> - -the header to validate - -## Returns - -`void` diff --git a/docs/@ceramic-sdk/model-instance-handler/functions/assertValidUniqueValue.md b/docs/@ceramic-sdk/model-instance-handler/functions/assertValidUniqueValue.md deleted file mode 100644 index 934a522..0000000 --- a/docs/@ceramic-sdk/model-instance-handler/functions/assertValidUniqueValue.md +++ /dev/null @@ -1,21 +0,0 @@ -[**@ceramic-sdk/model-instance-handler v0.2.1**](../README.md) • **Docs** - -*** - -[Ceramic SDK](../../../README.md) / [@ceramic-sdk/model-instance-handler](../README.md) / assertValidUniqueValue - -# Function: assertValidUniqueValue() - -> **assertValidUniqueValue**(`definition`, `metadata`, `content`): `void` - -## Parameters - -• **definition**: `MapIn`\<`RequiredProps`\<`object`\>, `$TypeOf`\> & `MapIn`\<`OptionalProps`\<`object`\>, `$TypeOf`\> \| `MapIn`\<`RequiredProps`\<`object`\>, `$TypeOf`\> & `MapIn`\<`OptionalProps`\<`object`\>, `$TypeOf`\> - -• **metadata**: `MapIn`\<`RequiredProps`\<`object`\>, `$TypeOf`\> & `MapIn`\<`OptionalProps`\<`object`\>, `$TypeOf`\> - -• **content**: `null` \| [`UnknownContent`](../type-aliases/UnknownContent.md) - -## Returns - -`void` diff --git a/docs/@ceramic-sdk/model-instance-handler/functions/handleDataPayload.md b/docs/@ceramic-sdk/model-instance-handler/functions/handleDataPayload.md deleted file mode 100644 index 9578813..0000000 --- a/docs/@ceramic-sdk/model-instance-handler/functions/handleDataPayload.md +++ /dev/null @@ -1,19 +0,0 @@ -[**@ceramic-sdk/model-instance-handler v0.2.1**](../README.md) • **Docs** - -*** - -[Ceramic SDK](../../../README.md) / [@ceramic-sdk/model-instance-handler](../README.md) / handleDataPayload - -# Function: handleDataPayload() - -> **handleDataPayload**(`payload`, `context`): `Promise`\<[`DocumentState`](../type-aliases/DocumentState.md)\> - -## Parameters - -• **payload**: `MapIn`\<`RequiredProps`\<`object`\>, `$TypeOf`\> & `MapIn`\<`OptionalProps`\<`object`\>, `$TypeOf`\> - -• **context**: [`Context`](../type-aliases/Context.md) - -## Returns - -`Promise`\<[`DocumentState`](../type-aliases/DocumentState.md)\> diff --git a/docs/@ceramic-sdk/model-instance-handler/functions/handleDeterministicInitPayload.md b/docs/@ceramic-sdk/model-instance-handler/functions/handleDeterministicInitPayload.md deleted file mode 100644 index 488608f..0000000 --- a/docs/@ceramic-sdk/model-instance-handler/functions/handleDeterministicInitPayload.md +++ /dev/null @@ -1,19 +0,0 @@ -[**@ceramic-sdk/model-instance-handler v0.2.1**](../README.md) • **Docs** - -*** - -[Ceramic SDK](../../../README.md) / [@ceramic-sdk/model-instance-handler](../README.md) / handleDeterministicInitPayload - -# Function: handleDeterministicInitPayload() - -> **handleDeterministicInitPayload**(`payload`, `context`): `Promise`\<[`DocumentState`](../type-aliases/DocumentState.md)\> - -## Parameters - -• **payload**: `MapIn`\<`RequiredProps`\<`object`\>, `$TypeOf`\> & `MapIn`\<`OptionalProps`\<`object`\>, `$TypeOf`\> - -• **context**: [`Context`](../type-aliases/Context.md) - -## Returns - -`Promise`\<[`DocumentState`](../type-aliases/DocumentState.md)\> diff --git a/docs/@ceramic-sdk/model-instance-handler/functions/handleEvent.md b/docs/@ceramic-sdk/model-instance-handler/functions/handleEvent.md deleted file mode 100644 index 5f34448..0000000 --- a/docs/@ceramic-sdk/model-instance-handler/functions/handleEvent.md +++ /dev/null @@ -1,19 +0,0 @@ -[**@ceramic-sdk/model-instance-handler v0.2.1**](../README.md) • **Docs** - -*** - -[Ceramic SDK](../../../README.md) / [@ceramic-sdk/model-instance-handler](../README.md) / handleEvent - -# Function: handleEvent() - -> **handleEvent**(`event`, `context`): `Promise`\<[`DocumentState`](../type-aliases/DocumentState.md)\> - -## Parameters - -• **event**: `MapIn`\<`RequiredProps`\<`object`\>, `$OutputOf`\> & `MapIn`\<`OptionalProps`\<`object`\>, `$OutputOf`\> \| `MapIn`\<`RequiredProps`\<`object`\>, `$OutputOf`\> & `MapIn`\<`OptionalProps`\<`object`\>, `$OutputOf`\> \| `MapIn`\<`object`, `$OutputOf`\> - -• **context**: [`Context`](../type-aliases/Context.md) - -## Returns - -`Promise`\<[`DocumentState`](../type-aliases/DocumentState.md)\> diff --git a/docs/@ceramic-sdk/model-instance-handler/functions/handleInitPayload.md b/docs/@ceramic-sdk/model-instance-handler/functions/handleInitPayload.md deleted file mode 100644 index f858612..0000000 --- a/docs/@ceramic-sdk/model-instance-handler/functions/handleInitPayload.md +++ /dev/null @@ -1,19 +0,0 @@ -[**@ceramic-sdk/model-instance-handler v0.2.1**](../README.md) • **Docs** - -*** - -[Ceramic SDK](../../../README.md) / [@ceramic-sdk/model-instance-handler](../README.md) / handleInitPayload - -# Function: handleInitPayload() - -> **handleInitPayload**(`payload`, `context`): `Promise`\<[`DocumentState`](../type-aliases/DocumentState.md)\> - -## Parameters - -• **payload**: `MapIn`\<`RequiredProps`\<`object`\>, `$TypeOf`\> & `MapIn`\<`OptionalProps`\<`object`\>, `$TypeOf`\> \| `MapIn`\<`RequiredProps`\<`object`\>, `$TypeOf`\> & `MapIn`\<`OptionalProps`\<`object`\>, `$TypeOf`\> - -• **context**: [`Context`](../type-aliases/Context.md) - -## Returns - -`Promise`\<[`DocumentState`](../type-aliases/DocumentState.md)\> diff --git a/docs/@ceramic-sdk/model-instance-handler/functions/handleTimeEvent.md b/docs/@ceramic-sdk/model-instance-handler/functions/handleTimeEvent.md deleted file mode 100644 index 983dcf0..0000000 --- a/docs/@ceramic-sdk/model-instance-handler/functions/handleTimeEvent.md +++ /dev/null @@ -1,19 +0,0 @@ -[**@ceramic-sdk/model-instance-handler v0.2.1**](../README.md) • **Docs** - -*** - -[Ceramic SDK](../../../README.md) / [@ceramic-sdk/model-instance-handler](../README.md) / handleTimeEvent - -# Function: handleTimeEvent() - -> **handleTimeEvent**(`event`, `context`): `Promise`\<[`DocumentState`](../type-aliases/DocumentState.md)\> - -## Parameters - -• **event**: `MapIn`\<`object`, `$TypeOf`\> - -• **context**: [`Context`](../type-aliases/Context.md) - -## Returns - -`Promise`\<[`DocumentState`](../type-aliases/DocumentState.md)\> diff --git a/docs/@ceramic-sdk/model-instance-handler/functions/validateRelation.md b/docs/@ceramic-sdk/model-instance-handler/functions/validateRelation.md deleted file mode 100644 index 6c0fa6f..0000000 --- a/docs/@ceramic-sdk/model-instance-handler/functions/validateRelation.md +++ /dev/null @@ -1,23 +0,0 @@ -[**@ceramic-sdk/model-instance-handler v0.2.1**](../README.md) • **Docs** - -*** - -[Ceramic SDK](../../../README.md) / [@ceramic-sdk/model-instance-handler](../README.md) / validateRelation - -# Function: validateRelation() - -> **validateRelation**(`context`, `docID`, `expectedModelID`, `fieldName`): `Promise`\<`void`\> - -## Parameters - -• **context**: [`Context`](../type-aliases/Context.md) - -• **docID**: `string` - -• **expectedModelID**: `string` - -• **fieldName**: `string` - -## Returns - -`Promise`\<`void`\> diff --git a/docs/@ceramic-sdk/model-instance-handler/functions/validateRelationsContent.md b/docs/@ceramic-sdk/model-instance-handler/functions/validateRelationsContent.md deleted file mode 100644 index 7208841..0000000 --- a/docs/@ceramic-sdk/model-instance-handler/functions/validateRelationsContent.md +++ /dev/null @@ -1,21 +0,0 @@ -[**@ceramic-sdk/model-instance-handler v0.2.1**](../README.md) • **Docs** - -*** - -[Ceramic SDK](../../../README.md) / [@ceramic-sdk/model-instance-handler](../README.md) / validateRelationsContent - -# Function: validateRelationsContent() - -> **validateRelationsContent**(`context`, `definition`, `content`): `Promise`\<`void`\> - -## Parameters - -• **context**: [`Context`](../type-aliases/Context.md) - -• **definition**: `MapIn`\<`RequiredProps`\<`object`\>, `$TypeOf`\> & `MapIn`\<`OptionalProps`\<`object`\>, `$TypeOf`\> \| `MapIn`\<`RequiredProps`\<`object`\>, `$TypeOf`\> & `MapIn`\<`OptionalProps`\<`object`\>, `$TypeOf`\> - -• **content**: [`UnknownContent`](../type-aliases/UnknownContent.md) - -## Returns - -`Promise`\<`void`\> diff --git a/docs/@ceramic-sdk/model-instance-handler/type-aliases/Context.md b/docs/@ceramic-sdk/model-instance-handler/type-aliases/Context.md deleted file mode 100644 index cb46bf3..0000000 --- a/docs/@ceramic-sdk/model-instance-handler/type-aliases/Context.md +++ /dev/null @@ -1,51 +0,0 @@ -[**@ceramic-sdk/model-instance-handler v0.2.1**](../README.md) • **Docs** - -*** - -[Ceramic SDK](../../../README.md) / [@ceramic-sdk/model-instance-handler](../README.md) / Context - -# Type Alias: Context - -> **Context**: `object` - -## Type declaration - -### getDocumentModel() - -> **getDocumentModel**: (`streamID`) => `Promise`\<`string`\> - -#### Parameters - -• **streamID**: `string` - -#### Returns - -`Promise`\<`string`\> - -### getDocumentState() - -> **getDocumentState**: (`streamID`) => `Promise`\<[`DocumentState`](DocumentState.md)\> - -#### Parameters - -• **streamID**: `string` - -#### Returns - -`Promise`\<[`DocumentState`](DocumentState.md)\> - -### getModelDefinition() - -> **getModelDefinition**: (`streamID`) => `Promise`\<[`ModelDefinition`](../../model-protocol/type-aliases/ModelDefinition.md)\> - -#### Parameters - -• **streamID**: `string` - -#### Returns - -`Promise`\<[`ModelDefinition`](../../model-protocol/type-aliases/ModelDefinition.md)\> - -### verifier - -> **verifier**: `DID` diff --git a/docs/@ceramic-sdk/model-instance-handler/type-aliases/DocumentEvent.md b/docs/@ceramic-sdk/model-instance-handler/type-aliases/DocumentEvent.md deleted file mode 100644 index d126f92..0000000 --- a/docs/@ceramic-sdk/model-instance-handler/type-aliases/DocumentEvent.md +++ /dev/null @@ -1,9 +0,0 @@ -[**@ceramic-sdk/model-instance-handler v0.2.1**](../README.md) • **Docs** - -*** - -[Ceramic SDK](../../../README.md) / [@ceramic-sdk/model-instance-handler](../README.md) / DocumentEvent - -# Type Alias: DocumentEvent - -> **DocumentEvent**: `OutputOf`\<*typeof* [`DocumentEvent`](../variables/DocumentEvent.md)\> diff --git a/docs/@ceramic-sdk/model-instance-handler/type-aliases/DocumentEventPayload.md b/docs/@ceramic-sdk/model-instance-handler/type-aliases/DocumentEventPayload.md deleted file mode 100644 index 2cbcc36..0000000 --- a/docs/@ceramic-sdk/model-instance-handler/type-aliases/DocumentEventPayload.md +++ /dev/null @@ -1,9 +0,0 @@ -[**@ceramic-sdk/model-instance-handler v0.2.1**](../README.md) • **Docs** - -*** - -[Ceramic SDK](../../../README.md) / [@ceramic-sdk/model-instance-handler](../README.md) / DocumentEventPayload - -# Type Alias: DocumentEventPayload - -> **DocumentEventPayload**: `TypeOf`\<*typeof* [`DocumentEventPayload`](../variables/DocumentEventPayload.md)\> diff --git a/docs/@ceramic-sdk/model-instance-handler/type-aliases/DocumentState.md b/docs/@ceramic-sdk/model-instance-handler/type-aliases/DocumentState.md deleted file mode 100644 index b727c69..0000000 --- a/docs/@ceramic-sdk/model-instance-handler/type-aliases/DocumentState.md +++ /dev/null @@ -1,19 +0,0 @@ -[**@ceramic-sdk/model-instance-handler v0.2.1**](../README.md) • **Docs** - -*** - -[Ceramic SDK](../../../README.md) / [@ceramic-sdk/model-instance-handler](../README.md) / DocumentState - -# Type Alias: DocumentState - -> **DocumentState**: `object` - -## Type declaration - -### content - -> **content**: [`UnknownContent`](UnknownContent.md) \| `null` - -### metadata - -> **metadata**: [`DocumentMetadata`](../../model-instance-protocol/type-aliases/DocumentMetadata.md) diff --git a/docs/@ceramic-sdk/model-instance-handler/type-aliases/UnknownContent.md b/docs/@ceramic-sdk/model-instance-handler/type-aliases/UnknownContent.md deleted file mode 100644 index 66cec95..0000000 --- a/docs/@ceramic-sdk/model-instance-handler/type-aliases/UnknownContent.md +++ /dev/null @@ -1,9 +0,0 @@ -[**@ceramic-sdk/model-instance-handler v0.2.1**](../README.md) • **Docs** - -*** - -[Ceramic SDK](../../../README.md) / [@ceramic-sdk/model-instance-handler](../README.md) / UnknownContent - -# Type Alias: UnknownContent - -> **UnknownContent**: `Record`\<`string`, `unknown`\> diff --git a/docs/@ceramic-sdk/model-instance-handler/variables/DocumentEvent.md b/docs/@ceramic-sdk/model-instance-handler/variables/DocumentEvent.md deleted file mode 100644 index 8446e63..0000000 --- a/docs/@ceramic-sdk/model-instance-handler/variables/DocumentEvent.md +++ /dev/null @@ -1,9 +0,0 @@ -[**@ceramic-sdk/model-instance-handler v0.2.1**](../README.md) • **Docs** - -*** - -[Ceramic SDK](../../../README.md) / [@ceramic-sdk/model-instance-handler](../README.md) / DocumentEvent - -# Variable: DocumentEvent - -> `const` **DocumentEvent**: `UnionCodec`\<[`SparseCodec`\<`object`\>, `SparseCodec`\<`object`\>, `ExactCodec`\<`TypeCodec`\<`object`\>\>]\> diff --git a/docs/@ceramic-sdk/model-instance-handler/variables/DocumentEventPayload.md b/docs/@ceramic-sdk/model-instance-handler/variables/DocumentEventPayload.md deleted file mode 100644 index 4767d31..0000000 --- a/docs/@ceramic-sdk/model-instance-handler/variables/DocumentEventPayload.md +++ /dev/null @@ -1,9 +0,0 @@ -[**@ceramic-sdk/model-instance-handler v0.2.1**](../README.md) • **Docs** - -*** - -[Ceramic SDK](../../../README.md) / [@ceramic-sdk/model-instance-handler](../README.md) / DocumentEventPayload - -# Variable: DocumentEventPayload - -> `const` **DocumentEventPayload**: `UnionCodec`\<[`SparseCodec`\<`object`\>, `UnionCodec`\<[`SparseCodec`\<`object`\>, `SparseCodec`\<`object`\>]\>, `SparseCodec`\<`object`\>, `ExactCodec`\<`TypeCodec`\<`object`\>\>]\> diff --git a/docs/@ceramic-sdk/model-instance-protocol/README.md b/docs/@ceramic-sdk/model-instance-protocol/README.md index d1366d7..474f46d 100644 --- a/docs/@ceramic-sdk/model-instance-protocol/README.md +++ b/docs/@ceramic-sdk/model-instance-protocol/README.md @@ -37,7 +37,6 @@ - [JSONPatchRemoveOperation](variables/JSONPatchRemoveOperation.md) - [JSONPatchReplaceOperation](variables/JSONPatchReplaceOperation.md) - [JSONPatchTestOperation](variables/JSONPatchTestOperation.md) -- [MAX\_DOCUMENT\_SIZE](variables/MAX_DOCUMENT_SIZE.md) ## Functions diff --git a/docs/@ceramic-sdk/model-instance-protocol/variables/MAX_DOCUMENT_SIZE.md b/docs/@ceramic-sdk/model-instance-protocol/variables/MAX_DOCUMENT_SIZE.md deleted file mode 100644 index 95ad3a9..0000000 --- a/docs/@ceramic-sdk/model-instance-protocol/variables/MAX_DOCUMENT_SIZE.md +++ /dev/null @@ -1,11 +0,0 @@ -[**@ceramic-sdk/model-instance-protocol v0.2.1**](../README.md) • **Docs** - -*** - -[Ceramic SDK](../../../README.md) / [@ceramic-sdk/model-instance-protocol](../README.md) / MAX\_DOCUMENT\_SIZE - -# Variable: MAX\_DOCUMENT\_SIZE - -> `const` **MAX\_DOCUMENT\_SIZE**: `16000000` = `16_000_000` - -Maximum size of a ModelInstanceDocument content in bytes diff --git a/docs/@ceramic-sdk/model-protocol/README.md b/docs/@ceramic-sdk/model-protocol/README.md index 2bcfab8..bfb78bf 100644 --- a/docs/@ceramic-sdk/model-protocol/README.md +++ b/docs/@ceramic-sdk/model-protocol/README.md @@ -30,7 +30,6 @@ - [ModelViewsDefinitionV2](type-aliases/ModelViewsDefinitionV2.md) - [ObjectSchema](type-aliases/ObjectSchema.md) - [SchemaType](type-aliases/SchemaType.md) -- [ValidVersionSatisfies](type-aliases/ValidVersionSatisfies.md) ## Variables @@ -61,5 +60,4 @@ ## Functions -- [assertValidModelContent](functions/assertValidModelContent.md) - [getModelStreamID](functions/getModelStreamID.md) diff --git a/docs/@ceramic-sdk/model-protocol/functions/assertValidModelContent.md b/docs/@ceramic-sdk/model-protocol/functions/assertValidModelContent.md deleted file mode 100644 index 2ca1033..0000000 --- a/docs/@ceramic-sdk/model-protocol/functions/assertValidModelContent.md +++ /dev/null @@ -1,21 +0,0 @@ -[**@ceramic-sdk/model-protocol v0.2.1**](../README.md) • **Docs** - -*** - -[Ceramic SDK](../../../README.md) / [@ceramic-sdk/model-protocol](../README.md) / assertValidModelContent - -# Function: assertValidModelContent() - -> **assertValidModelContent**(`content`): `void` - -Asserts that the model definition is valid and throws an error if it's not. - -## Parameters - -• **content**: `MapIn`\<`RequiredProps`\<`object`\>, `$TypeOf`\> & `MapIn`\<`OptionalProps`\<`object`\>, `$TypeOf`\> \| `MapIn`\<`RequiredProps`\<`object`\>, `$TypeOf`\> & `MapIn`\<`OptionalProps`\<`object`\>, `$TypeOf`\> - -the model definition object - -## Returns - -`void` diff --git a/docs/@ceramic-sdk/model-protocol/type-aliases/ValidVersionSatisfies.md b/docs/@ceramic-sdk/model-protocol/type-aliases/ValidVersionSatisfies.md deleted file mode 100644 index 147a891..0000000 --- a/docs/@ceramic-sdk/model-protocol/type-aliases/ValidVersionSatisfies.md +++ /dev/null @@ -1,13 +0,0 @@ -[**@ceramic-sdk/model-protocol v0.2.1**](../README.md) • **Docs** - -*** - -[Ceramic SDK](../../../README.md) / [@ceramic-sdk/model-protocol](../README.md) / ValidVersionSatisfies - -# Type Alias: ValidVersionSatisfies - -> **ValidVersionSatisfies**: `"major"` \| `"minor"` - -Version check to satisfy: -- 'major': only major version match needs to be satisfied -- 'minor': both major and minor versions matches need to be satisfied diff --git a/docs/README.md b/docs/README.md index 59fc4bd..292400b 100644 --- a/docs/README.md +++ b/docs/README.md @@ -12,6 +12,5 @@ - [@ceramic-sdk/model-client - v0.2.1](@ceramic-sdk/model-client/README.md) - [@ceramic-sdk/model-instance-client - v0.2.1](@ceramic-sdk/model-instance-client/README.md) - [@ceramic-sdk/model-instance-protocol - v0.2.1](@ceramic-sdk/model-instance-protocol/README.md) -- [@ceramic-sdk/model-instance-handler - v0.2.1](@ceramic-sdk/model-instance-handler/README.md) - [@ceramic-sdk/model-protocol - v0.2.1](@ceramic-sdk/model-protocol/README.md) - [@ceramic-sdk/stream-client - v0.2.1](@ceramic-sdk/stream-client/README.md)