diff --git a/apps/explorer/package.json b/apps/explorer/package.json index 954672f..244c7ab 100644 --- a/apps/explorer/package.json +++ b/apps/explorer/package.json @@ -22,7 +22,7 @@ "@mantine/hooks": "^7.12.2", "@tabler/icons-react": "^3.17.0", "@tanstack/react-query": "^5.56.2", - "@tanstack/react-router": "^1.57.17", + "@tanstack/react-router": "^1.58.3", "codeco": "^1.4.3", "jotai": "^2.9.2", "multiformats": "^13.3.0", @@ -32,8 +32,8 @@ "devDependencies": { "@ceramic-sdk/model-client": "workspace:^", "@ceramic-sdk/model-instance-client": "workspace:^", - "@tanstack/router-devtools": "^1.57.17", - "@tanstack/router-plugin": "^1.57.15", + "@tanstack/router-devtools": "^1.58.3", + "@tanstack/router-plugin": "^1.58.4", "@types/react": "^18.3.7", "@types/react-dom": "^18.3.0", "@vitejs/plugin-react-swc": "^3.5.0", diff --git a/docs/@ceramic-sdk/events/README.md b/docs/@ceramic-sdk/events/README.md new file mode 100644 index 0000000..d387724 --- /dev/null +++ b/docs/@ceramic-sdk/events/README.md @@ -0,0 +1,46 @@ +**@ceramic-sdk/events v0.1.0** • **Docs** + +*** + +[Ceramic SDK](../../README.md) / @ceramic-sdk/events + +# @ceramic-sdk/events + +## Type Aliases + +- [EventContainer](type-aliases/EventContainer.md) +- [InitEventHeader](type-aliases/InitEventHeader.md) +- [InitEventPayload](type-aliases/InitEventPayload.md) +- [PartialInitEventHeader](type-aliases/PartialInitEventHeader.md) +- [SignedEvent](type-aliases/SignedEvent.md) +- [SignedEventContainer](type-aliases/SignedEventContainer.md) +- [TimeEvent](type-aliases/TimeEvent.md) +- [UnsignedEventContainer](type-aliases/UnsignedEventContainer.md) + +## Variables + +- [InitEventHeader](variables/InitEventHeader.md) +- [InitEventPayload](variables/InitEventPayload.md) +- [SignedEvent](variables/SignedEvent.md) +- [TimeEvent](variables/TimeEvent.md) + +## Functions + +- [assertSignedEvent](functions/assertSignedEvent.md) +- [assertTimeEvent](functions/assertTimeEvent.md) +- [carFromString](functions/carFromString.md) +- [carToString](functions/carToString.md) +- [createSignedInitEvent](functions/createSignedInitEvent.md) +- [decodeSignedEvent](functions/decodeSignedEvent.md) +- [decodeTimeEvent](functions/decodeTimeEvent.md) +- [encodeEventToCAR](functions/encodeEventToCAR.md) +- [eventFromCAR](functions/eventFromCAR.md) +- [eventFromString](functions/eventFromString.md) +- [eventToCAR](functions/eventToCAR.md) +- [eventToContainer](functions/eventToContainer.md) +- [eventToString](functions/eventToString.md) +- [getSignedEventPayload](functions/getSignedEventPayload.md) +- [signedEventToCAR](functions/signedEventToCAR.md) +- [signedEventToContainer](functions/signedEventToContainer.md) +- [signEvent](functions/signEvent.md) +- [unsignedEventToContainer](functions/unsignedEventToContainer.md) diff --git a/docs/@ceramic-sdk/events/functions/assertSignedEvent.md b/docs/@ceramic-sdk/events/functions/assertSignedEvent.md new file mode 100644 index 0000000..c8fc6c8 --- /dev/null +++ b/docs/@ceramic-sdk/events/functions/assertSignedEvent.md @@ -0,0 +1,23 @@ +[**@ceramic-sdk/events v0.1.0**](../README.md) • **Docs** + +*** + +[Ceramic SDK](../../../README.md) / [@ceramic-sdk/events](../README.md) / assertSignedEvent + +# Function: assertSignedEvent() + +> **assertSignedEvent**(`input`): `asserts input is MapIn, $TypeOf> & MapIn, $TypeOf>` + +Assert the provided `input` is a SignedEvent + +## Parameters + +• **input**: `unknown` + +## Returns + +`asserts input is MapIn, $TypeOf> & MapIn, $TypeOf>` + +## Defined in + +[packages/events/src/codecs.ts:70](https://github.com/ceramicstudio/ceramic-sdk/blob/a220cbca7950f690af7f3d03a0023681bb9f5426/packages/events/src/codecs.ts#L70) diff --git a/docs/@ceramic-sdk/events/functions/assertTimeEvent.md b/docs/@ceramic-sdk/events/functions/assertTimeEvent.md new file mode 100644 index 0000000..63a2680 --- /dev/null +++ b/docs/@ceramic-sdk/events/functions/assertTimeEvent.md @@ -0,0 +1,23 @@ +[**@ceramic-sdk/events v0.1.0**](../README.md) • **Docs** + +*** + +[Ceramic SDK](../../../README.md) / [@ceramic-sdk/events](../README.md) / assertTimeEvent + +# Function: assertTimeEvent() + +> **assertTimeEvent**(`input`): `asserts input is MapIn` + +Assert the provided `input` is a TimeEvent + +## Parameters + +• **input**: `unknown` + +## Returns + +`asserts input is MapIn` + +## Defined in + +[packages/events/src/codecs.ts:94](https://github.com/ceramicstudio/ceramic-sdk/blob/a220cbca7950f690af7f3d03a0023681bb9f5426/packages/events/src/codecs.ts#L94) diff --git a/docs/@ceramic-sdk/events/functions/carFromString.md b/docs/@ceramic-sdk/events/functions/carFromString.md new file mode 100644 index 0000000..e547c20 --- /dev/null +++ b/docs/@ceramic-sdk/events/functions/carFromString.md @@ -0,0 +1,25 @@ +[**@ceramic-sdk/events v0.1.0**](../README.md) • **Docs** + +*** + +[Ceramic SDK](../../../README.md) / [@ceramic-sdk/events](../README.md) / carFromString + +# Function: carFromString() + +> **carFromString**(`value`, `base`): `CAR` + +Decode a CAR from a string, using the given base (defaults to base64) + +## Parameters + +• **value**: `string` + +• **base**: `"base64url"` \| `"base256emoji"` \| `"base64"` \| `"base64pad"` \| `"base64urlpad"` \| `"base58btc"` \| `"base58flickr"` \| `"base36"` \| `"base36upper"` \| `"base32"` \| `"base32upper"` \| `"base32pad"` \| `"base32padupper"` \| `"base32hex"` \| `"base32hexupper"` \| `"base32hexpad"` \| `"base32hexpadupper"` \| `"base32z"` \| `"base16"` \| `"base16upper"` \| `"base10"` \| `"base8"` \| `"base2"` \| `"identity"` = `DEFAULT_BASE` + +## Returns + +`CAR` + +## Defined in + +[packages/events/src/encoding.ts:30](https://github.com/ceramicstudio/ceramic-sdk/blob/a220cbca7950f690af7f3d03a0023681bb9f5426/packages/events/src/encoding.ts#L30) diff --git a/docs/@ceramic-sdk/events/functions/carToString.md b/docs/@ceramic-sdk/events/functions/carToString.md new file mode 100644 index 0000000..234d3ec --- /dev/null +++ b/docs/@ceramic-sdk/events/functions/carToString.md @@ -0,0 +1,25 @@ +[**@ceramic-sdk/events v0.1.0**](../README.md) • **Docs** + +*** + +[Ceramic SDK](../../../README.md) / [@ceramic-sdk/events](../README.md) / carToString + +# Function: carToString() + +> **carToString**(`car`, `base`): `string` + +Encode a CAR into a string, using the given base (defaults to base64) + +## Parameters + +• **car**: `CAR` + +• **base**: `"base64url"` \| `"base256emoji"` \| `"base64"` \| `"base64pad"` \| `"base64urlpad"` \| `"base58btc"` \| `"base58flickr"` \| `"base36"` \| `"base36upper"` \| `"base32"` \| `"base32upper"` \| `"base32pad"` \| `"base32padupper"` \| `"base32hex"` \| `"base32hexupper"` \| `"base32hexpad"` \| `"base32hexpadupper"` \| `"base32z"` \| `"base16"` \| `"base16upper"` \| `"base10"` \| `"base8"` \| `"base2"` \| `"identity"` = `DEFAULT_BASE` + +## Returns + +`string` + +## Defined in + +[packages/events/src/encoding.ts:25](https://github.com/ceramicstudio/ceramic-sdk/blob/a220cbca7950f690af7f3d03a0023681bb9f5426/packages/events/src/encoding.ts#L25) diff --git a/docs/@ceramic-sdk/events/functions/createSignedInitEvent.md b/docs/@ceramic-sdk/events/functions/createSignedInitEvent.md new file mode 100644 index 0000000..b28116d --- /dev/null +++ b/docs/@ceramic-sdk/events/functions/createSignedInitEvent.md @@ -0,0 +1,33 @@ +[**@ceramic-sdk/events v0.1.0**](../README.md) • **Docs** + +*** + +[Ceramic SDK](../../../README.md) / [@ceramic-sdk/events](../README.md) / createSignedInitEvent + +# Function: createSignedInitEvent() + +> **createSignedInitEvent**\<`T`\>(`did`, `data`, `header`, `options`?): `Promise`\<[`SignedEvent`](../type-aliases/SignedEvent.md)\> + +Create a signed init event using the provided DID, data and header + +## Type Parameters + +• **T** + +## Parameters + +• **did**: `DID` + +• **data**: `T` + +• **header**: [`PartialInitEventHeader`](../type-aliases/PartialInitEventHeader.md) + +• **options?**: `CreateJWSOptions` + +## Returns + +`Promise`\<[`SignedEvent`](../type-aliases/SignedEvent.md)\> + +## Defined in + +[packages/events/src/signing.ts:33](https://github.com/ceramicstudio/ceramic-sdk/blob/a220cbca7950f690af7f3d03a0023681bb9f5426/packages/events/src/signing.ts#L33) diff --git a/docs/@ceramic-sdk/events/functions/decodeSignedEvent.md b/docs/@ceramic-sdk/events/functions/decodeSignedEvent.md new file mode 100644 index 0000000..b4c7d2a --- /dev/null +++ b/docs/@ceramic-sdk/events/functions/decodeSignedEvent.md @@ -0,0 +1,23 @@ +[**@ceramic-sdk/events v0.1.0**](../README.md) • **Docs** + +*** + +[Ceramic SDK](../../../README.md) / [@ceramic-sdk/events](../README.md) / decodeSignedEvent + +# Function: decodeSignedEvent() + +> **decodeSignedEvent**(`input`): [`SignedEvent`](../type-aliases/SignedEvent.md) + +Decode the provided `input` as a SignedEvent. Throws if decoding fails. + +## Parameters + +• **input**: `unknown` + +## Returns + +[`SignedEvent`](../type-aliases/SignedEvent.md) + +## Defined in + +[packages/events/src/codecs.ts:65](https://github.com/ceramicstudio/ceramic-sdk/blob/a220cbca7950f690af7f3d03a0023681bb9f5426/packages/events/src/codecs.ts#L65) diff --git a/docs/@ceramic-sdk/events/functions/decodeTimeEvent.md b/docs/@ceramic-sdk/events/functions/decodeTimeEvent.md new file mode 100644 index 0000000..6ebadbb --- /dev/null +++ b/docs/@ceramic-sdk/events/functions/decodeTimeEvent.md @@ -0,0 +1,23 @@ +[**@ceramic-sdk/events v0.1.0**](../README.md) • **Docs** + +*** + +[Ceramic SDK](../../../README.md) / [@ceramic-sdk/events](../README.md) / decodeTimeEvent + +# Function: decodeTimeEvent() + +> **decodeTimeEvent**(`input`): [`TimeEvent`](../type-aliases/TimeEvent.md) + +Decode the provided `input` as a TimeEvent. Throws if decoding fails. + +## Parameters + +• **input**: `unknown` + +## Returns + +[`TimeEvent`](../type-aliases/TimeEvent.md) + +## Defined in + +[packages/events/src/codecs.ts:89](https://github.com/ceramicstudio/ceramic-sdk/blob/a220cbca7950f690af7f3d03a0023681bb9f5426/packages/events/src/codecs.ts#L89) diff --git a/docs/@ceramic-sdk/events/functions/encodeEventToCAR.md b/docs/@ceramic-sdk/events/functions/encodeEventToCAR.md new file mode 100644 index 0000000..b48a1d4 --- /dev/null +++ b/docs/@ceramic-sdk/events/functions/encodeEventToCAR.md @@ -0,0 +1,25 @@ +[**@ceramic-sdk/events v0.1.0**](../README.md) • **Docs** + +*** + +[Ceramic SDK](../../../README.md) / [@ceramic-sdk/events](../README.md) / encodeEventToCAR + +# Function: encodeEventToCAR() + +> **encodeEventToCAR**(`codec`, `event`): `CAR` + +Encode an unsigned event into a CAR using the provided codec + +## Parameters + +• **codec**: `Codec`\<`unknown`, `unknown`, `unknown`\> + +• **event**: `unknown` + +## Returns + +`CAR` + +## Defined in + +[packages/events/src/encoding.ts:72](https://github.com/ceramicstudio/ceramic-sdk/blob/a220cbca7950f690af7f3d03a0023681bb9f5426/packages/events/src/encoding.ts#L72) diff --git a/docs/@ceramic-sdk/events/functions/eventFromCAR.md b/docs/@ceramic-sdk/events/functions/eventFromCAR.md new file mode 100644 index 0000000..992cec0 --- /dev/null +++ b/docs/@ceramic-sdk/events/functions/eventFromCAR.md @@ -0,0 +1,31 @@ +[**@ceramic-sdk/events v0.1.0**](../README.md) • **Docs** + +*** + +[Ceramic SDK](../../../README.md) / [@ceramic-sdk/events](../README.md) / eventFromCAR + +# Function: eventFromCAR() + +> **eventFromCAR**\<`Payload`\>(`decoder`, `car`, `eventCID`?): [`SignedEvent`](../type-aliases/SignedEvent.md) \| `Payload` + +Decode an event from a string using the provided codec for unsigned events + +## Type Parameters + +• **Payload** = `unknown` + +## Parameters + +• **decoder**: `Decoder`\<`unknown`, `Payload`\> + +• **car**: `CAR` + +• **eventCID?**: `CID`\<`unknown`, `number`, `number`, `Version`\> + +## Returns + +[`SignedEvent`](../type-aliases/SignedEvent.md) \| `Payload` + +## Defined in + +[packages/events/src/encoding.ts:98](https://github.com/ceramicstudio/ceramic-sdk/blob/a220cbca7950f690af7f3d03a0023681bb9f5426/packages/events/src/encoding.ts#L98) diff --git a/docs/@ceramic-sdk/events/functions/eventFromString.md b/docs/@ceramic-sdk/events/functions/eventFromString.md new file mode 100644 index 0000000..7c62382 --- /dev/null +++ b/docs/@ceramic-sdk/events/functions/eventFromString.md @@ -0,0 +1,31 @@ +[**@ceramic-sdk/events v0.1.0**](../README.md) • **Docs** + +*** + +[Ceramic SDK](../../../README.md) / [@ceramic-sdk/events](../README.md) / eventFromString + +# Function: eventFromString() + +> **eventFromString**\<`Payload`\>(`decoder`, `value`, `base`?): [`SignedEvent`](../type-aliases/SignedEvent.md) \| `Payload` + +Decode an event from a string using the provided codec for unsigned events and the given base (defaults to base64) + +## Type Parameters + +• **Payload** = `unknown` + +## Parameters + +• **decoder**: `Decoder`\<`unknown`, `Payload`\> + +• **value**: `string` + +• **base?**: `"base64url"` \| `"base256emoji"` \| `"base64"` \| `"base64pad"` \| `"base64urlpad"` \| `"base58btc"` \| `"base58flickr"` \| `"base36"` \| `"base36upper"` \| `"base32"` \| `"base32upper"` \| `"base32pad"` \| `"base32padupper"` \| `"base32hex"` \| `"base32hexupper"` \| `"base32hexpad"` \| `"base32hexpadupper"` \| `"base32z"` \| `"base16"` \| `"base16upper"` \| `"base10"` \| `"base8"` \| `"base2"` \| `"identity"` + +## Returns + +[`SignedEvent`](../type-aliases/SignedEvent.md) \| `Payload` + +## Defined in + +[packages/events/src/encoding.ts:128](https://github.com/ceramicstudio/ceramic-sdk/blob/a220cbca7950f690af7f3d03a0023681bb9f5426/packages/events/src/encoding.ts#L128) diff --git a/docs/@ceramic-sdk/events/functions/eventToCAR.md b/docs/@ceramic-sdk/events/functions/eventToCAR.md new file mode 100644 index 0000000..02a0b24 --- /dev/null +++ b/docs/@ceramic-sdk/events/functions/eventToCAR.md @@ -0,0 +1,25 @@ +[**@ceramic-sdk/events v0.1.0**](../README.md) • **Docs** + +*** + +[Ceramic SDK](../../../README.md) / [@ceramic-sdk/events](../README.md) / eventToCAR + +# Function: eventToCAR() + +> **eventToCAR**(`codec`, `event`): `CAR` + +Encode an event into a CAR using the provided codec for unsigned events + +## Parameters + +• **codec**: `Codec`\<`unknown`, `unknown`, `unknown`\> + +• **event**: `unknown` + +## Returns + +`CAR` + +## Defined in + +[packages/events/src/encoding.ts:82](https://github.com/ceramicstudio/ceramic-sdk/blob/a220cbca7950f690af7f3d03a0023681bb9f5426/packages/events/src/encoding.ts#L82) diff --git a/docs/@ceramic-sdk/events/functions/eventToContainer.md b/docs/@ceramic-sdk/events/functions/eventToContainer.md new file mode 100644 index 0000000..f0a243b --- /dev/null +++ b/docs/@ceramic-sdk/events/functions/eventToContainer.md @@ -0,0 +1,31 @@ +[**@ceramic-sdk/events v0.1.0**](../README.md) • **Docs** + +*** + +[Ceramic SDK](../../../README.md) / [@ceramic-sdk/events](../README.md) / eventToContainer + +# Function: eventToContainer() + +> **eventToContainer**\<`Payload`\>(`did`, `codec`, `event`): `Promise`\<[`EventContainer`](../type-aliases/EventContainer.md)\<`Payload`\>\> + +Decode a Ceramic event into a container using the provided verifier DID and payload decoder + +## Type Parameters + +• **Payload** + +## Parameters + +• **did**: `DID` + +• **codec**: `Decoder`\<`unknown`, `Payload`\> + +• **event**: `unknown` + +## Returns + +`Promise`\<[`EventContainer`](../type-aliases/EventContainer.md)\<`Payload`\>\> + +## Defined in + +[packages/events/src/container.ts:54](https://github.com/ceramicstudio/ceramic-sdk/blob/a220cbca7950f690af7f3d03a0023681bb9f5426/packages/events/src/container.ts#L54) diff --git a/docs/@ceramic-sdk/events/functions/eventToString.md b/docs/@ceramic-sdk/events/functions/eventToString.md new file mode 100644 index 0000000..3bc6f54 --- /dev/null +++ b/docs/@ceramic-sdk/events/functions/eventToString.md @@ -0,0 +1,27 @@ +[**@ceramic-sdk/events v0.1.0**](../README.md) • **Docs** + +*** + +[Ceramic SDK](../../../README.md) / [@ceramic-sdk/events](../README.md) / eventToString + +# Function: eventToString() + +> **eventToString**(`codec`, `event`, `base`?): `string` + +Encode an event into a string using the provided codec for unsigned events and the given base (defaults to base64) + +## Parameters + +• **codec**: `Codec`\<`unknown`, `unknown`, `unknown`\> + +• **event**: `unknown` + +• **base?**: `"base64url"` \| `"base256emoji"` \| `"base64"` \| `"base64pad"` \| `"base64urlpad"` \| `"base58btc"` \| `"base58flickr"` \| `"base36"` \| `"base36upper"` \| `"base32"` \| `"base32upper"` \| `"base32pad"` \| `"base32padupper"` \| `"base32hex"` \| `"base32hexupper"` \| `"base32hexpad"` \| `"base32hexpadupper"` \| `"base32z"` \| `"base16"` \| `"base16upper"` \| `"base10"` \| `"base8"` \| `"base2"` \| `"identity"` + +## Returns + +`string` + +## Defined in + +[packages/events/src/encoding.ts:89](https://github.com/ceramicstudio/ceramic-sdk/blob/a220cbca7950f690af7f3d03a0023681bb9f5426/packages/events/src/encoding.ts#L89) diff --git a/docs/@ceramic-sdk/events/functions/getSignedEventPayload.md b/docs/@ceramic-sdk/events/functions/getSignedEventPayload.md new file mode 100644 index 0000000..0fc4f1c --- /dev/null +++ b/docs/@ceramic-sdk/events/functions/getSignedEventPayload.md @@ -0,0 +1,29 @@ +[**@ceramic-sdk/events v0.1.0**](../README.md) • **Docs** + +*** + +[Ceramic SDK](../../../README.md) / [@ceramic-sdk/events](../README.md) / getSignedEventPayload + +# Function: getSignedEventPayload() + +> **getSignedEventPayload**\<`Payload`\>(`decoder`, `event`): `Promise`\<`Payload`\> + +Decode the payload of a signed event using the provided decoder + +## Type Parameters + +• **Payload** = `Record`\<`string`, `unknown`\> + +## Parameters + +• **decoder**: `Decoder`\<`unknown`, `Payload`\> + +• **event**: `MapIn`\<`RequiredProps`\<`object`\>, `$TypeOf`\> & `MapIn`\<`OptionalProps`\<`object`\>, `$TypeOf`\> + +## Returns + +`Promise`\<`Payload`\> + +## Defined in + +[packages/events/src/signing.ts:53](https://github.com/ceramicstudio/ceramic-sdk/blob/a220cbca7950f690af7f3d03a0023681bb9f5426/packages/events/src/signing.ts#L53) diff --git a/docs/@ceramic-sdk/events/functions/signEvent.md b/docs/@ceramic-sdk/events/functions/signEvent.md new file mode 100644 index 0000000..82adf4b --- /dev/null +++ b/docs/@ceramic-sdk/events/functions/signEvent.md @@ -0,0 +1,27 @@ +[**@ceramic-sdk/events v0.1.0**](../README.md) • **Docs** + +*** + +[Ceramic SDK](../../../README.md) / [@ceramic-sdk/events](../README.md) / signEvent + +# Function: signEvent() + +> **signEvent**(`did`, `payload`, `options`?): `Promise`\<[`SignedEvent`](../type-aliases/SignedEvent.md)\> + +Sign an event payload using the provided DID + +## Parameters + +• **did**: `DID` + +• **payload**: `Record`\<`string`, `unknown`\> + +• **options?**: `CreateJWSOptions` + +## Returns + +`Promise`\<[`SignedEvent`](../type-aliases/SignedEvent.md)\> + +## Defined in + +[packages/events/src/signing.ts:15](https://github.com/ceramicstudio/ceramic-sdk/blob/a220cbca7950f690af7f3d03a0023681bb9f5426/packages/events/src/signing.ts#L15) diff --git a/docs/@ceramic-sdk/events/functions/signedEventToCAR.md b/docs/@ceramic-sdk/events/functions/signedEventToCAR.md new file mode 100644 index 0000000..1242773 --- /dev/null +++ b/docs/@ceramic-sdk/events/functions/signedEventToCAR.md @@ -0,0 +1,23 @@ +[**@ceramic-sdk/events v0.1.0**](../README.md) • **Docs** + +*** + +[Ceramic SDK](../../../README.md) / [@ceramic-sdk/events](../README.md) / signedEventToCAR + +# Function: signedEventToCAR() + +> **signedEventToCAR**(`event`): `CAR` + +Encode a signed event into a CAR + +## Parameters + +• **event**: `MapIn`\<`RequiredProps`\<`object`\>, `$TypeOf`\> & `MapIn`\<`OptionalProps`\<`object`\>, `$TypeOf`\> + +## Returns + +`CAR` + +## Defined in + +[packages/events/src/encoding.ts:39](https://github.com/ceramicstudio/ceramic-sdk/blob/a220cbca7950f690af7f3d03a0023681bb9f5426/packages/events/src/encoding.ts#L39) diff --git a/docs/@ceramic-sdk/events/functions/signedEventToContainer.md b/docs/@ceramic-sdk/events/functions/signedEventToContainer.md new file mode 100644 index 0000000..902c6d8 --- /dev/null +++ b/docs/@ceramic-sdk/events/functions/signedEventToContainer.md @@ -0,0 +1,31 @@ +[**@ceramic-sdk/events v0.1.0**](../README.md) • **Docs** + +*** + +[Ceramic SDK](../../../README.md) / [@ceramic-sdk/events](../README.md) / signedEventToContainer + +# Function: signedEventToContainer() + +> **signedEventToContainer**\<`Payload`\>(`did`, `codec`, `event`): `Promise`\<[`SignedEventContainer`](../type-aliases/SignedEventContainer.md)\<`Payload`\>\> + +Decode a signed Ceramic event into a container using the provided verifier DID and payload decoder + +## Type Parameters + +• **Payload** + +## Parameters + +• **did**: `DID` + +• **codec**: `Decoder`\<`unknown`, `Payload`\> + +• **event**: `MapIn`\<`RequiredProps`\<`object`\>, `$TypeOf`\> & `MapIn`\<`OptionalProps`\<`object`\>, `$TypeOf`\> + +## Returns + +`Promise`\<[`SignedEventContainer`](../type-aliases/SignedEventContainer.md)\<`Payload`\>\> + +## Defined in + +[packages/events/src/container.ts:37](https://github.com/ceramicstudio/ceramic-sdk/blob/a220cbca7950f690af7f3d03a0023681bb9f5426/packages/events/src/container.ts#L37) diff --git a/docs/@ceramic-sdk/events/functions/unsignedEventToContainer.md b/docs/@ceramic-sdk/events/functions/unsignedEventToContainer.md new file mode 100644 index 0000000..bc4acd8 --- /dev/null +++ b/docs/@ceramic-sdk/events/functions/unsignedEventToContainer.md @@ -0,0 +1,29 @@ +[**@ceramic-sdk/events v0.1.0**](../README.md) • **Docs** + +*** + +[Ceramic SDK](../../../README.md) / [@ceramic-sdk/events](../README.md) / unsignedEventToContainer + +# Function: unsignedEventToContainer() + +> **unsignedEventToContainer**\<`Payload`\>(`codec`, `event`): [`UnsignedEventContainer`](../type-aliases/UnsignedEventContainer.md)\<`Payload`\> + +Decode an unsigned Ceramic event into a container using the provided payload decoder + +## Type Parameters + +• **Payload** + +## Parameters + +• **codec**: `Decoder`\<`unknown`, `Payload`\> + +• **event**: `unknown` + +## Returns + +[`UnsignedEventContainer`](../type-aliases/UnsignedEventContainer.md)\<`Payload`\> + +## Defined in + +[packages/events/src/container.ts:29](https://github.com/ceramicstudio/ceramic-sdk/blob/a220cbca7950f690af7f3d03a0023681bb9f5426/packages/events/src/container.ts#L29) diff --git a/docs/@ceramic-sdk/events/type-aliases/EventContainer.md b/docs/@ceramic-sdk/events/type-aliases/EventContainer.md new file mode 100644 index 0000000..2feb575 --- /dev/null +++ b/docs/@ceramic-sdk/events/type-aliases/EventContainer.md @@ -0,0 +1,19 @@ +[**@ceramic-sdk/events v0.1.0**](../README.md) • **Docs** + +*** + +[Ceramic SDK](../../../README.md) / [@ceramic-sdk/events](../README.md) / EventContainer + +# Type Alias: EventContainer\ + +> **EventContainer**\<`Payload`\>: [`SignedEventContainer`](SignedEventContainer.md)\<`Payload`\> \| [`UnsignedEventContainer`](UnsignedEventContainer.md)\<`Payload`\> + +Container for a Ceramic event, providing additional metadata about the event + +## Type Parameters + +• **Payload** + +## Defined in + +[packages/events/src/container.ts:24](https://github.com/ceramicstudio/ceramic-sdk/blob/a220cbca7950f690af7f3d03a0023681bb9f5426/packages/events/src/container.ts#L24) diff --git a/docs/@ceramic-sdk/events/type-aliases/InitEventHeader.md b/docs/@ceramic-sdk/events/type-aliases/InitEventHeader.md new file mode 100644 index 0000000..58e69d8 --- /dev/null +++ b/docs/@ceramic-sdk/events/type-aliases/InitEventHeader.md @@ -0,0 +1,13 @@ +[**@ceramic-sdk/events v0.1.0**](../README.md) • **Docs** + +*** + +[Ceramic SDK](../../../README.md) / [@ceramic-sdk/events](../README.md) / InitEventHeader + +# Type Alias: InitEventHeader + +> **InitEventHeader**: `TypeOf`\<*typeof* [`InitEventHeader`](../variables/InitEventHeader.md)\> + +## Defined in + +[packages/events/src/codecs.ts:27](https://github.com/ceramicstudio/ceramic-sdk/blob/a220cbca7950f690af7f3d03a0023681bb9f5426/packages/events/src/codecs.ts#L27) diff --git a/docs/@ceramic-sdk/events/type-aliases/InitEventPayload.md b/docs/@ceramic-sdk/events/type-aliases/InitEventPayload.md new file mode 100644 index 0000000..ce52987 --- /dev/null +++ b/docs/@ceramic-sdk/events/type-aliases/InitEventPayload.md @@ -0,0 +1,27 @@ +[**@ceramic-sdk/events v0.1.0**](../README.md) • **Docs** + +*** + +[Ceramic SDK](../../../README.md) / [@ceramic-sdk/events](../README.md) / InitEventPayload + +# Type Alias: InitEventPayload\ + +> **InitEventPayload**\<`T`\>: `object` + +## Type Parameters + +• **T** = `unknown` + +## Type declaration + +### data + +> **data**: `T` + +### header + +> **header**: [`InitEventHeader`](InitEventHeader.md) + +## Defined in + +[packages/events/src/codecs.ts:41](https://github.com/ceramicstudio/ceramic-sdk/blob/a220cbca7950f690af7f3d03a0023681bb9f5426/packages/events/src/codecs.ts#L41) diff --git a/docs/@ceramic-sdk/events/type-aliases/PartialInitEventHeader.md b/docs/@ceramic-sdk/events/type-aliases/PartialInitEventHeader.md new file mode 100644 index 0000000..5d0f166 --- /dev/null +++ b/docs/@ceramic-sdk/events/type-aliases/PartialInitEventHeader.md @@ -0,0 +1,19 @@ +[**@ceramic-sdk/events v0.1.0**](../README.md) • **Docs** + +*** + +[Ceramic SDK](../../../README.md) / [@ceramic-sdk/events](../README.md) / PartialInitEventHeader + +# Type Alias: PartialInitEventHeader + +> **PartialInitEventHeader**: `Omit`\<[`InitEventHeader`](InitEventHeader.md), `"controllers"`\> & `object` + +## Type declaration + +### controllers? + +> `optional` **controllers**: [`DIDString`] + +## Defined in + +[packages/events/src/signing.ts:28](https://github.com/ceramicstudio/ceramic-sdk/blob/a220cbca7950f690af7f3d03a0023681bb9f5426/packages/events/src/signing.ts#L28) diff --git a/docs/@ceramic-sdk/events/type-aliases/SignedEvent.md b/docs/@ceramic-sdk/events/type-aliases/SignedEvent.md new file mode 100644 index 0000000..538510d --- /dev/null +++ b/docs/@ceramic-sdk/events/type-aliases/SignedEvent.md @@ -0,0 +1,13 @@ +[**@ceramic-sdk/events v0.1.0**](../README.md) • **Docs** + +*** + +[Ceramic SDK](../../../README.md) / [@ceramic-sdk/events](../README.md) / SignedEvent + +# Type Alias: SignedEvent + +> **SignedEvent**: `TypeOf`\<*typeof* [`SignedEvent`](../variables/SignedEvent.md)\> + +## Defined in + +[packages/events/src/codecs.ts:54](https://github.com/ceramicstudio/ceramic-sdk/blob/a220cbca7950f690af7f3d03a0023681bb9f5426/packages/events/src/codecs.ts#L54) diff --git a/docs/@ceramic-sdk/events/type-aliases/SignedEventContainer.md b/docs/@ceramic-sdk/events/type-aliases/SignedEventContainer.md new file mode 100644 index 0000000..6ccafcf --- /dev/null +++ b/docs/@ceramic-sdk/events/type-aliases/SignedEventContainer.md @@ -0,0 +1,41 @@ +[**@ceramic-sdk/events v0.1.0**](../README.md) • **Docs** + +*** + +[Ceramic SDK](../../../README.md) / [@ceramic-sdk/events](../README.md) / SignedEventContainer + +# Type Alias: SignedEventContainer\ + +> **SignedEventContainer**\<`Payload`\>: `object` + +Container for a signed Ceramic event + +## Type Parameters + +• **Payload** + +## Type declaration + +### cacaoBlock? + +> `optional` **cacaoBlock**: `Uint8Array` + +### cid + +> **cid**: `CID` + +### payload + +> **payload**: `Payload` + +### signed + +> **signed**: `true` + +### verified + +> **verified**: `VerifyJWSResult` + +## Defined in + +[packages/events/src/container.ts:9](https://github.com/ceramicstudio/ceramic-sdk/blob/a220cbca7950f690af7f3d03a0023681bb9f5426/packages/events/src/container.ts#L9) diff --git a/docs/@ceramic-sdk/events/type-aliases/TimeEvent.md b/docs/@ceramic-sdk/events/type-aliases/TimeEvent.md new file mode 100644 index 0000000..c1704ad --- /dev/null +++ b/docs/@ceramic-sdk/events/type-aliases/TimeEvent.md @@ -0,0 +1,13 @@ +[**@ceramic-sdk/events v0.1.0**](../README.md) • **Docs** + +*** + +[Ceramic SDK](../../../README.md) / [@ceramic-sdk/events](../README.md) / TimeEvent + +# Type Alias: TimeEvent + +> **TimeEvent**: `TypeOf`\<*typeof* [`TimeEvent`](../variables/TimeEvent.md)\> + +## Defined in + +[packages/events/src/codecs.ts:77](https://github.com/ceramicstudio/ceramic-sdk/blob/a220cbca7950f690af7f3d03a0023681bb9f5426/packages/events/src/codecs.ts#L77) diff --git a/docs/@ceramic-sdk/events/type-aliases/UnsignedEventContainer.md b/docs/@ceramic-sdk/events/type-aliases/UnsignedEventContainer.md new file mode 100644 index 0000000..dc26cbd --- /dev/null +++ b/docs/@ceramic-sdk/events/type-aliases/UnsignedEventContainer.md @@ -0,0 +1,29 @@ +[**@ceramic-sdk/events v0.1.0**](../README.md) • **Docs** + +*** + +[Ceramic SDK](../../../README.md) / [@ceramic-sdk/events](../README.md) / UnsignedEventContainer + +# Type Alias: UnsignedEventContainer\ + +> **UnsignedEventContainer**\<`Payload`\>: `object` + +Container for an unsigned Ceramic event + +## Type Parameters + +• **Payload** + +## Type declaration + +### payload + +> **payload**: `Payload` + +### signed + +> **signed**: `false` + +## Defined in + +[packages/events/src/container.ts:18](https://github.com/ceramicstudio/ceramic-sdk/blob/a220cbca7950f690af7f3d03a0023681bb9f5426/packages/events/src/container.ts#L18) diff --git a/docs/@ceramic-sdk/events/variables/InitEventHeader.md b/docs/@ceramic-sdk/events/variables/InitEventHeader.md new file mode 100644 index 0000000..113172b --- /dev/null +++ b/docs/@ceramic-sdk/events/variables/InitEventHeader.md @@ -0,0 +1,41 @@ +[**@ceramic-sdk/events v0.1.0**](../README.md) • **Docs** + +*** + +[Ceramic SDK](../../../README.md) / [@ceramic-sdk/events](../README.md) / InitEventHeader + +# Variable: InitEventHeader + +> `const` **InitEventHeader**: `SparseCodec`\<`object`\> + +Header structure of Init events + +## Type declaration + +### context + +> **context**: `OptionalCodec`\<`Type`\<[`StreamID`](../../identifiers/classes/StreamID.md), `Uint8Array`, `Uint8Array`\>\> + +### controllers + +> **controllers**: `TupleCodec`\<[`RefinementCodec`\<`TrivialCodec`\<`string`\>, `string` & `WithOpaque`\<`"DIDString"`\>\>]\> + +### model + +> **model**: `Type`\<[`StreamID`](../../identifiers/classes/StreamID.md), `Uint8Array`, `Uint8Array`\> = `streamIDAsBytes` + +### sep + +> **sep**: `TrivialCodec`\<`string`\> = `string` + +### shouldIndex + +> **shouldIndex**: `OptionalCodec`\<`TrivialCodec`\<`boolean`\>\> + +### unique + +> **unique**: `OptionalCodec`\<`TrivialCodec`\<`Uint8Array`\>\> + +## Defined in + +[packages/events/src/codecs.ts:27](https://github.com/ceramicstudio/ceramic-sdk/blob/a220cbca7950f690af7f3d03a0023681bb9f5426/packages/events/src/codecs.ts#L27) diff --git a/docs/@ceramic-sdk/events/variables/InitEventPayload.md b/docs/@ceramic-sdk/events/variables/InitEventPayload.md new file mode 100644 index 0000000..ff866d5 --- /dev/null +++ b/docs/@ceramic-sdk/events/variables/InitEventPayload.md @@ -0,0 +1,51 @@ +[**@ceramic-sdk/events v0.1.0**](../README.md) • **Docs** + +*** + +[Ceramic SDK](../../../README.md) / [@ceramic-sdk/events](../README.md) / InitEventPayload + +# Variable: InitEventPayload + +> `const` **InitEventPayload**: `SparseCodec`\<`object`\> + +Payload structure of Init events + +## Type declaration + +### data + +> **data**: `TrivialCodec`\<`unknown`\> = `unknown` + +### header + +> **header**: `SparseCodec`\<`object`\> = `InitEventHeader` + +#### Type declaration + +##### context + +> **context**: `OptionalCodec`\<`Type`\<[`StreamID`](../../identifiers/classes/StreamID.md), `Uint8Array`, `Uint8Array`\>\> + +##### controllers + +> **controllers**: `TupleCodec`\<[`RefinementCodec`\<`TrivialCodec`\<`string`\>, `string` & `WithOpaque`\<`"DIDString"`\>\>]\> + +##### model + +> **model**: `Type`\<[`StreamID`](../../identifiers/classes/StreamID.md), `Uint8Array`, `Uint8Array`\> = `streamIDAsBytes` + +##### sep + +> **sep**: `TrivialCodec`\<`string`\> = `string` + +##### shouldIndex + +> **shouldIndex**: `OptionalCodec`\<`TrivialCodec`\<`boolean`\>\> + +##### unique + +> **unique**: `OptionalCodec`\<`TrivialCodec`\<`Uint8Array`\>\> + +## Defined in + +[packages/events/src/codecs.ts:41](https://github.com/ceramicstudio/ceramic-sdk/blob/a220cbca7950f690af7f3d03a0023681bb9f5426/packages/events/src/codecs.ts#L41) diff --git a/docs/@ceramic-sdk/events/variables/SignedEvent.md b/docs/@ceramic-sdk/events/variables/SignedEvent.md new file mode 100644 index 0000000..50245c8 --- /dev/null +++ b/docs/@ceramic-sdk/events/variables/SignedEvent.md @@ -0,0 +1,43 @@ +[**@ceramic-sdk/events v0.1.0**](../README.md) • **Docs** + +*** + +[Ceramic SDK](../../../README.md) / [@ceramic-sdk/events](../README.md) / SignedEvent + +# Variable: SignedEvent + +> `const` **SignedEvent**: `SparseCodec`\<`object`\> + +Signed event structure - equivalent to DagJWSResult in `dids` package + +## Type declaration + +### cacaoBlock + +> **cacaoBlock**: `OptionalCodec`\<`TrivialCodec`\<`Uint8Array`\>\> + +### jws + +> **jws**: `SparseCodec`\<`object`\> = `DagJWS` + +#### Type declaration + +##### link + +> **link**: `OptionalCodec`\<`Type`\<`CID`\<`unknown`, `number`, `number`, `Version`\>, `CID`\<`unknown`, `number`, `number`, `Version`\>, `unknown`\>\> + +##### payload + +> **payload**: `TrivialCodec`\<`string`\> = `string` + +##### signatures + +> **signatures**: `Codec`\<`MapIn`\<`object`, `$TypeOf`\>[], `MapIn`\<`object`, `$OutputOf`\>[], `unknown`\> & `object` + +### linkedBlock + +> **linkedBlock**: `TrivialCodec`\<`Uint8Array`\> = `uint8array` + +## Defined in + +[packages/events/src/codecs.ts:54](https://github.com/ceramicstudio/ceramic-sdk/blob/a220cbca7950f690af7f3d03a0023681bb9f5426/packages/events/src/codecs.ts#L54) diff --git a/docs/@ceramic-sdk/events/variables/TimeEvent.md b/docs/@ceramic-sdk/events/variables/TimeEvent.md new file mode 100644 index 0000000..e218968 --- /dev/null +++ b/docs/@ceramic-sdk/events/variables/TimeEvent.md @@ -0,0 +1,15 @@ +[**@ceramic-sdk/events v0.1.0**](../README.md) • **Docs** + +*** + +[Ceramic SDK](../../../README.md) / [@ceramic-sdk/events](../README.md) / TimeEvent + +# Variable: TimeEvent + +> `const` **TimeEvent**: `ExactCodec`\<`TypeCodec`\<`object`\>\> + +Time event structure + +## Defined in + +[packages/events/src/codecs.ts:77](https://github.com/ceramicstudio/ceramic-sdk/blob/a220cbca7950f690af7f3d03a0023681bb9f5426/packages/events/src/codecs.ts#L77) diff --git a/docs/@ceramic-sdk/http-client/README.md b/docs/@ceramic-sdk/http-client/README.md new file mode 100644 index 0000000..3993fec --- /dev/null +++ b/docs/@ceramic-sdk/http-client/README.md @@ -0,0 +1,19 @@ +**@ceramic-sdk/http-client v0.1.0** • **Docs** + +*** + +[Ceramic SDK](../../README.md) / @ceramic-sdk/http-client + +# @ceramic-sdk/http-client + +## Classes + +- [CeramicClient](classes/CeramicClient.md) + +## Type Aliases + +- [CeramicAPI](type-aliases/CeramicAPI.md) +- [ClientParams](type-aliases/ClientParams.md) +- [EventsFeedParams](type-aliases/EventsFeedParams.md) +- [Schema](type-aliases/Schema.md) +- [Schemas](type-aliases/Schemas.md) diff --git a/docs/@ceramic-sdk/http-client/classes/CeramicClient.md b/docs/@ceramic-sdk/http-client/classes/CeramicClient.md new file mode 100644 index 0000000..42c5778 --- /dev/null +++ b/docs/@ceramic-sdk/http-client/classes/CeramicClient.md @@ -0,0 +1,285 @@ +[**@ceramic-sdk/http-client v0.1.0**](../README.md) • **Docs** + +*** + +[Ceramic SDK](../../../README.md) / [@ceramic-sdk/http-client](../README.md) / CeramicClient + +# Class: CeramicClient + +## Constructors + +### new CeramicClient() + +> **new CeramicClient**(`params`): [`CeramicClient`](CeramicClient.md) + +#### Parameters + +• **params**: [`ClientParams`](../type-aliases/ClientParams.md) + +#### Returns + +[`CeramicClient`](CeramicClient.md) + +#### Defined in + +[packages/http-client/src/index.ts:40](https://github.com/ceramicstudio/ceramic-sdk/blob/a220cbca7950f690af7f3d03a0023681bb9f5426/packages/http-client/src/index.ts#L40) + +## Accessors + +### api + +> `get` **api**(): `Client`\<`paths`, \`$\{string\}/$\{string\}\`\> + +OpenAPI client used internally, provides low-level access to the HTTP APIs exposed by the Ceramic One server + +#### Returns + +`Client`\<`paths`, \`$\{string\}/$\{string\}\`\> + +#### Defined in + +[packages/http-client/src/index.ts:49](https://github.com/ceramicstudio/ceramic-sdk/blob/a220cbca7950f690af7f3d03a0023681bb9f5426/packages/http-client/src/index.ts#L49) + +## Methods + +### getEvent() + +> **getEvent**(`id`): `Promise`\<`object`\> + +Get the raw event response for the given event CID + +#### Parameters + +• **id**: `string` + +#### Returns + +`Promise`\<`object`\> + +##### data? + +> `optional` **data**: `string` + +###### Description + +Multibase encoding of event data. + +##### id + +> **id**: `string` + +###### Description + +Multibase encoding of event root CID bytes. + +#### Defined in + +[packages/http-client/src/index.ts:54](https://github.com/ceramicstudio/ceramic-sdk/blob/a220cbca7950f690af7f3d03a0023681bb9f5426/packages/http-client/src/index.ts#L54) + +*** + +### getEventCAR() + +> **getEventCAR**(`id`): `Promise`\<`CAR`\> + +Get the CAR-encoded event for the given event CID + +#### Parameters + +• **id**: `string` + +#### Returns + +`Promise`\<`CAR`\> + +#### Defined in + +[packages/http-client/src/index.ts:74](https://github.com/ceramicstudio/ceramic-sdk/blob/a220cbca7950f690af7f3d03a0023681bb9f5426/packages/http-client/src/index.ts#L74) + +*** + +### getEventData() + +> **getEventData**(`id`): `Promise`\<`string`\> + +Get the string-encoded event for the given event CID + +#### Parameters + +• **id**: `string` + +#### Returns + +`Promise`\<`string`\> + +#### Defined in + +[packages/http-client/src/index.ts:65](https://github.com/ceramicstudio/ceramic-sdk/blob/a220cbca7950f690af7f3d03a0023681bb9f5426/packages/http-client/src/index.ts#L65) + +*** + +### getEventsFeed() + +> **getEventsFeed**(`params`): `Promise`\<`object`\> + +Get the events feed based on the given parameters + +#### Parameters + +• **params**: [`EventsFeedParams`](../type-aliases/EventsFeedParams.md) = `{}` + +#### Returns + +`Promise`\<`object`\> + +##### events + +> **events**: `object`[] + +###### Description + +An array of events. For now, the event data payload is empty. + +##### resumeToken + +> **resumeToken**: `string` + +###### Description + +The token/highwater mark to used as resumeAt on a future request + +#### Defined in + +[packages/http-client/src/index.ts:89](https://github.com/ceramicstudio/ceramic-sdk/blob/a220cbca7950f690af7f3d03a0023681bb9f5426/packages/http-client/src/index.ts#L89) + +*** + +### getEventType() + +> **getEventType**\<`Payload`\>(`decoder`, `id`): `Promise`\<`Payload` \| `MapIn`\<`RequiredProps`\<`object`\>, `$TypeOf`\> & `MapIn`\<`OptionalProps`\<`object`\>, `$TypeOf`\>\> + +Get the decoded event for the given decoder and event CID + +#### Type Parameters + +• **Payload** + +#### Parameters + +• **decoder**: `Decoder`\<`unknown`, `Payload`\> + +• **id**: `string` + +#### Returns + +`Promise`\<`Payload` \| `MapIn`\<`RequiredProps`\<`object`\>, `$TypeOf`\> & `MapIn`\<`OptionalProps`\<`object`\>, `$TypeOf`\>\> + +#### Defined in + +[packages/http-client/src/index.ts:80](https://github.com/ceramicstudio/ceramic-sdk/blob/a220cbca7950f690af7f3d03a0023681bb9f5426/packages/http-client/src/index.ts#L80) + +*** + +### getVersion() + +> **getVersion**(): `Promise`\<`object`\> + +Get information about the Ceramic One server version + +#### Returns + +`Promise`\<`object`\> + +##### version? + +> `optional` **version**: `string` + +###### Description + +Version of the Ceramic node + +#### Defined in + +[packages/http-client/src/index.ts:102](https://github.com/ceramicstudio/ceramic-sdk/blob/a220cbca7950f690af7f3d03a0023681bb9f5426/packages/http-client/src/index.ts#L102) + +*** + +### postEvent() + +> **postEvent**(`data`): `Promise`\<`void`\> + +Post a string-encoded event to the server + +#### Parameters + +• **data**: `string` + +#### Returns + +`Promise`\<`void`\> + +#### Defined in + +[packages/http-client/src/index.ts:111](https://github.com/ceramicstudio/ceramic-sdk/blob/a220cbca7950f690af7f3d03a0023681bb9f5426/packages/http-client/src/index.ts#L111) + +*** + +### postEventCAR() + +> **postEventCAR**(`car`): `Promise`\<`CID`\<`unknown`, `number`, `number`, `Version`\>\> + +Post a CAR-encoded event to the server + +#### Parameters + +• **car**: `CAR` + +#### Returns + +`Promise`\<`CID`\<`unknown`, `number`, `number`, `Version`\>\> + +#### Defined in + +[packages/http-client/src/index.ts:119](https://github.com/ceramicstudio/ceramic-sdk/blob/a220cbca7950f690af7f3d03a0023681bb9f5426/packages/http-client/src/index.ts#L119) + +*** + +### postEventType() + +> **postEventType**(`codec`, `event`): `Promise`\<`CID`\<`unknown`, `number`, `number`, `Version`\>\> + +Encode and post an event to the server + +#### Parameters + +• **codec**: `Codec`\<`unknown`, `unknown`, `unknown`\> + +• **event**: `unknown` + +#### Returns + +`Promise`\<`CID`\<`unknown`, `number`, `number`, `Version`\>\> + +#### Defined in + +[packages/http-client/src/index.ts:125](https://github.com/ceramicstudio/ceramic-sdk/blob/a220cbca7950f690af7f3d03a0023681bb9f5426/packages/http-client/src/index.ts#L125) + +*** + +### registerInterestModel() + +> **registerInterestModel**(`model`): `Promise`\<`void`\> + +Register interest in streams using the given model stream ID + +#### Parameters + +• **model**: `string` + +#### Returns + +`Promise`\<`void`\> + +#### Defined in + +[packages/http-client/src/index.ts:131](https://github.com/ceramicstudio/ceramic-sdk/blob/a220cbca7950f690af7f3d03a0023681bb9f5426/packages/http-client/src/index.ts#L131) diff --git a/docs/@ceramic-sdk/http-client/type-aliases/CeramicAPI.md b/docs/@ceramic-sdk/http-client/type-aliases/CeramicAPI.md new file mode 100644 index 0000000..88ef815 --- /dev/null +++ b/docs/@ceramic-sdk/http-client/type-aliases/CeramicAPI.md @@ -0,0 +1,13 @@ +[**@ceramic-sdk/http-client v0.1.0**](../README.md) • **Docs** + +*** + +[Ceramic SDK](../../../README.md) / [@ceramic-sdk/http-client](../README.md) / CeramicAPI + +# Type Alias: CeramicAPI + +> **CeramicAPI**: `ReturnType`\<*typeof* `createAPIClient`\> + +## Defined in + +[packages/http-client/src/index.ts:16](https://github.com/ceramicstudio/ceramic-sdk/blob/a220cbca7950f690af7f3d03a0023681bb9f5426/packages/http-client/src/index.ts#L16) diff --git a/docs/@ceramic-sdk/http-client/type-aliases/ClientParams.md b/docs/@ceramic-sdk/http-client/type-aliases/ClientParams.md new file mode 100644 index 0000000..b1ca194 --- /dev/null +++ b/docs/@ceramic-sdk/http-client/type-aliases/ClientParams.md @@ -0,0 +1,41 @@ +[**@ceramic-sdk/http-client v0.1.0**](../README.md) • **Docs** + +*** + +[Ceramic SDK](../../../README.md) / [@ceramic-sdk/http-client](../README.md) / ClientParams + +# Type Alias: ClientParams + +> **ClientParams**: `object` + +## Type declaration + +### fetch()? + +> `optional` **fetch**: (`request`) => `ReturnType`\<*typeof* `fetch`\> + +Custom fetch function to use for requests + +#### Parameters + +• **request**: `Request` + +#### Returns + +`ReturnType`\<*typeof* `fetch`\> + +### headers? + +> `optional` **headers**: `HeadersOptions` + +Additional HTTP headers to send with requests + +### url + +> **url**: `string` + +Ceramic One server URL + +## Defined in + +[packages/http-client/src/index.ts:21](https://github.com/ceramicstudio/ceramic-sdk/blob/a220cbca7950f690af7f3d03a0023681bb9f5426/packages/http-client/src/index.ts#L21) diff --git a/docs/@ceramic-sdk/http-client/type-aliases/EventsFeedParams.md b/docs/@ceramic-sdk/http-client/type-aliases/EventsFeedParams.md new file mode 100644 index 0000000..32bbd30 --- /dev/null +++ b/docs/@ceramic-sdk/http-client/type-aliases/EventsFeedParams.md @@ -0,0 +1,27 @@ +[**@ceramic-sdk/http-client v0.1.0**](../README.md) • **Docs** + +*** + +[Ceramic SDK](../../../README.md) / [@ceramic-sdk/http-client](../README.md) / EventsFeedParams + +# Type Alias: EventsFeedParams + +> **EventsFeedParams**: `object` + +## Type declaration + +### limit? + +> `optional` **limit**: `number` + +Maximum number of events to return in response + +### resumeAt? + +> `optional` **resumeAt**: `string` + +Resume token + +## Defined in + +[packages/http-client/src/index.ts:30](https://github.com/ceramicstudio/ceramic-sdk/blob/a220cbca7950f690af7f3d03a0023681bb9f5426/packages/http-client/src/index.ts#L30) diff --git a/docs/@ceramic-sdk/http-client/type-aliases/Schema.md b/docs/@ceramic-sdk/http-client/type-aliases/Schema.md new file mode 100644 index 0000000..ecd7dfd --- /dev/null +++ b/docs/@ceramic-sdk/http-client/type-aliases/Schema.md @@ -0,0 +1,17 @@ +[**@ceramic-sdk/http-client v0.1.0**](../README.md) • **Docs** + +*** + +[Ceramic SDK](../../../README.md) / [@ceramic-sdk/http-client](../README.md) / Schema + +# Type Alias: Schema\ + +> **Schema**\<`Name`\>: `SimplifyDeep`\<[`Schemas`](Schemas.md)\[`Name`\]\> + +## Type Parameters + +• **Name** *extends* keyof [`Schemas`](Schemas.md) + +## Defined in + +[packages/http-client/src/index.ts:19](https://github.com/ceramicstudio/ceramic-sdk/blob/a220cbca7950f690af7f3d03a0023681bb9f5426/packages/http-client/src/index.ts#L19) diff --git a/docs/@ceramic-sdk/http-client/type-aliases/Schemas.md b/docs/@ceramic-sdk/http-client/type-aliases/Schemas.md new file mode 100644 index 0000000..0d363fe --- /dev/null +++ b/docs/@ceramic-sdk/http-client/type-aliases/Schemas.md @@ -0,0 +1,13 @@ +[**@ceramic-sdk/http-client v0.1.0**](../README.md) • **Docs** + +*** + +[Ceramic SDK](../../../README.md) / [@ceramic-sdk/http-client](../README.md) / Schemas + +# Type Alias: Schemas + +> **Schemas**: `SimplifyDeep`\<`components`\[`"schemas"`\]\> + +## Defined in + +[packages/http-client/src/index.ts:18](https://github.com/ceramicstudio/ceramic-sdk/blob/a220cbca7950f690af7f3d03a0023681bb9f5426/packages/http-client/src/index.ts#L18) diff --git a/docs/@ceramic-sdk/identifiers/README.md b/docs/@ceramic-sdk/identifiers/README.md new file mode 100644 index 0000000..128a66e --- /dev/null +++ b/docs/@ceramic-sdk/identifiers/README.md @@ -0,0 +1,24 @@ +**@ceramic-sdk/identifiers v0.1.0** • **Docs** + +*** + +[Ceramic SDK](../../README.md) / @ceramic-sdk/identifiers + +# @ceramic-sdk/identifiers + +## Classes + +- [CommitID](classes/CommitID.md) +- [StreamID](classes/StreamID.md) + +## Type Aliases + +- [StreamType](type-aliases/StreamType.md) +- [StreamTypeCode](type-aliases/StreamTypeCode.md) +- [StreamTypeName](type-aliases/StreamTypeName.md) + +## Variables + +- [streamIDAsBytes](variables/streamIDAsBytes.md) +- [streamIDAsString](variables/streamIDAsString.md) +- [streamIDString](variables/streamIDString.md) diff --git a/docs/@ceramic-sdk/identifiers/classes/CommitID.md b/docs/@ceramic-sdk/identifiers/classes/CommitID.md new file mode 100644 index 0000000..d808c5b --- /dev/null +++ b/docs/@ceramic-sdk/identifiers/classes/CommitID.md @@ -0,0 +1,301 @@ +[**@ceramic-sdk/identifiers v0.1.0**](../README.md) • **Docs** + +*** + +[Ceramic SDK](../../../README.md) / [@ceramic-sdk/identifiers](../README.md) / CommitID + +# Class: CommitID + +Commit identifier, includes type, init CID, commit CID. + +Encoded as ``. + +String representation is base36-encoding of the bytes above. + +## Constructors + +### new CommitID() + +> **new CommitID**(`type`, `cid`, `commit`): [`CommitID`](CommitID.md) + +Create a new StreamID. + +#### Parameters + +• **type**: [`StreamType`](../type-aliases/StreamType.md) + +• **cid**: `string` \| `CID`\<`unknown`, `number`, `number`, `Version`\> + +• **commit**: `null` \| `string` \| `number` \| `CID`\<`unknown`, `number`, `number`, `Version`\> = `null` + +CID. Pass '0', 0, or omit the value as shorthand for the init commit. + +#### Returns + +[`CommitID`](CommitID.md) + +#### Example + +```ts +new StreamID(, |) +new StreamID(, |, |) +``` + +#### Defined in + +[commit-id.ts:121](https://github.com/ceramicstudio/ceramic-sdk/blob/a220cbca7950f690af7f3d03a0023681bb9f5426/packages/identifiers/src/commit-id.ts#L121) + +## Properties + +### \_tag + +> `protected` `readonly` **\_tag**: `symbol` = `TAG` + +#### Defined in + +[commit-id.ts:79](https://github.com/ceramicstudio/ceramic-sdk/blob/a220cbca7950f690af7f3d03a0023681bb9f5426/packages/identifiers/src/commit-id.ts#L79) + +*** + +### fromBytes() + +> `static` **fromBytes**: (`bytes`) => [`CommitID`](CommitID.md) + +Parse CommitID from bytes representation. + +#### Parameters + +• **bytes**: `Uint8Array` + +bytes representation of CommitID. + +#### Returns + +[`CommitID`](CommitID.md) + +#### Throws + +error on invalid input + +#### See + +CommitID#bytes + +#### Defined in + +[commit-id.ts:85](https://github.com/ceramicstudio/ceramic-sdk/blob/a220cbca7950f690af7f3d03a0023681bb9f5426/packages/identifiers/src/commit-id.ts#L85) + +*** + +### fromString() + +> `static` **fromString**: (`input`) => [`CommitID`](CommitID.md) + +Parse CommitID from string representation. + +#### Parameters + +• **input**: `string` + +string representation of CommitID, be it base36-encoded string or URL. + +#### Returns + +[`CommitID`](CommitID.md) + +#### See + + - CommitID#toString + - CommitID#toUrl + +#### Defined in + +[commit-id.ts:86](https://github.com/ceramicstudio/ceramic-sdk/blob/a220cbca7950f690af7f3d03a0023681bb9f5426/packages/identifiers/src/commit-id.ts#L86) + +## Accessors + +### baseID + +> `get` **baseID**(): [`StreamID`](StreamID.md) + +Construct StreamID, no commit information included + +#### Returns + +[`StreamID`](StreamID.md) + +#### Defined in + +[commit-id.ts:137](https://github.com/ceramicstudio/ceramic-sdk/blob/a220cbca7950f690af7f3d03a0023681bb9f5426/packages/identifiers/src/commit-id.ts#L137) + +*** + +### bytes + +> `get` **bytes**(): `Uint8Array` + +Bytes representation + +#### Returns + +`Uint8Array` + +#### Defined in + +[commit-id.ts:175](https://github.com/ceramicstudio/ceramic-sdk/blob/a220cbca7950f690af7f3d03a0023681bb9f5426/packages/identifiers/src/commit-id.ts#L175) + +*** + +### cid + +> `get` **cid**(): `CID`\<`unknown`, `number`, `number`, `Version`\> + +Genesis CID + +#### Returns + +`CID`\<`unknown`, `number`, `number`, `Version`\> + +#### Defined in + +[commit-id.ts:159](https://github.com/ceramicstudio/ceramic-sdk/blob/a220cbca7950f690af7f3d03a0023681bb9f5426/packages/identifiers/src/commit-id.ts#L159) + +*** + +### commit + +> `get` **commit**(): `CID`\<`unknown`, `number`, `number`, `Version`\> + +Commit CID + +#### Returns + +`CID`\<`unknown`, `number`, `number`, `Version`\> + +#### Defined in + +[commit-id.ts:167](https://github.com/ceramicstudio/ceramic-sdk/blob/a220cbca7950f690af7f3d03a0023681bb9f5426/packages/identifiers/src/commit-id.ts#L167) + +*** + +### type + +> `get` **type**(): [`StreamTypeCode`](../type-aliases/StreamTypeCode.md) + +Stream type code + +#### Returns + +[`StreamTypeCode`](../type-aliases/StreamTypeCode.md) + +#### Defined in + +[commit-id.ts:144](https://github.com/ceramicstudio/ceramic-sdk/blob/a220cbca7950f690af7f3d03a0023681bb9f5426/packages/identifiers/src/commit-id.ts#L144) + +*** + +### typeName + +> `get` **typeName**(): `"tile"` \| `"caip10-link"` \| `"model"` \| `"MID"` \| `"UNLOADABLE"` + +Stream type name + +#### Returns + +`"tile"` \| `"caip10-link"` \| `"model"` \| `"MID"` \| `"UNLOADABLE"` + +#### Defined in + +[commit-id.ts:152](https://github.com/ceramicstudio/ceramic-sdk/blob/a220cbca7950f690af7f3d03a0023681bb9f5426/packages/identifiers/src/commit-id.ts#L152) + +## Methods + +### equals() + +> **equals**(`other`): `boolean` + +Compare equality with another CommitID. + +#### Parameters + +• **other**: [`CommitID`](CommitID.md) + +#### Returns + +`boolean` + +#### Defined in + +[commit-id.ts:186](https://github.com/ceramicstudio/ceramic-sdk/blob/a220cbca7950f690af7f3d03a0023681bb9f5426/packages/identifiers/src/commit-id.ts#L186) + +*** + +### toString() + +> **toString**(): `string` + +Encode the CommitID into a string. + +#### Returns + +`string` + +#### Defined in + +[commit-id.ts:198](https://github.com/ceramicstudio/ceramic-sdk/blob/a220cbca7950f690af7f3d03a0023681bb9f5426/packages/identifiers/src/commit-id.ts#L198) + +*** + +### toUrl() + +> **toUrl**(): `string` + +Encode the StreamID into a base36 url + +#### Returns + +`string` + +#### Defined in + +[commit-id.ts:206](https://github.com/ceramicstudio/ceramic-sdk/blob/a220cbca7950f690af7f3d03a0023681bb9f5426/packages/identifiers/src/commit-id.ts#L206) + +*** + +### fromStream() + +> `static` **fromStream**(`stream`, `commit`): [`CommitID`](CommitID.md) + +Construct new CommitID for a given stream and commit + +#### Parameters + +• **stream**: [`StreamID`](StreamID.md) + +• **commit**: `null` \| `string` \| `number` \| `CID`\<`unknown`, `number`, `number`, `Version`\> = `null` + +#### Returns + +[`CommitID`](CommitID.md) + +#### Defined in + +[commit-id.ts:91](https://github.com/ceramicstudio/ceramic-sdk/blob/a220cbca7950f690af7f3d03a0023681bb9f5426/packages/identifiers/src/commit-id.ts#L91) + +*** + +### isInstance() + +> `static` **isInstance**(`instance`): `instance is CommitID` + +#### Parameters + +• **instance**: `unknown` + +#### Returns + +`instance is CommitID` + +#### Defined in + +[commit-id.ts:101](https://github.com/ceramicstudio/ceramic-sdk/blob/a220cbca7950f690af7f3d03a0023681bb9f5426/packages/identifiers/src/commit-id.ts#L101) diff --git a/docs/@ceramic-sdk/identifiers/classes/StreamID.md b/docs/@ceramic-sdk/identifiers/classes/StreamID.md new file mode 100644 index 0000000..b3179a6 --- /dev/null +++ b/docs/@ceramic-sdk/identifiers/classes/StreamID.md @@ -0,0 +1,301 @@ +[**@ceramic-sdk/identifiers v0.1.0**](../README.md) • **Docs** + +*** + +[Ceramic SDK](../../../README.md) / [@ceramic-sdk/identifiers](../README.md) / StreamID + +# Class: StreamID + +Stream identifier, no commit information included. + +Contains stream type and CID of genesis commit. + +Encoded as ``. + +String representation is base36-encoding of the bytes above. + +## Constructors + +### new StreamID() + +> **new StreamID**(`type`, `cid`): [`StreamID`](StreamID.md) + +Create a new StreamID. + +#### Parameters + +• **type**: [`StreamType`](../type-aliases/StreamType.md) + +the stream type + +• **cid**: `string` \| `CID`\<`unknown`, `number`, `number`, `Version`\> + +#### Returns + +[`StreamID`](StreamID.md) + +#### Example + +```typescript +new StreamID('MID', 'bagcqcerakszw2vsovxznyp5gfnpdj4cqm2xiv76yd24wkjewhhykovorwo6a'); +new StreamID('MID', cid); +new StreamID(3, cid); +``` + +#### Defined in + +[stream-id.ts:106](https://github.com/ceramicstudio/ceramic-sdk/blob/a220cbca7950f690af7f3d03a0023681bb9f5426/packages/identifiers/src/stream-id.ts#L106) + +## Properties + +### \_tag + +> `protected` `readonly` **\_tag**: `symbol` = `TAG` + +#### Defined in + +[stream-id.ts:73](https://github.com/ceramicstudio/ceramic-sdk/blob/a220cbca7950f690af7f3d03a0023681bb9f5426/packages/identifiers/src/stream-id.ts#L73) + +*** + +### fromBytes() + +> `static` **fromBytes**: (`bytes`) => [`StreamID`](StreamID.md) + +Parse StreamID from bytes representation. + +#### Parameters + +• **bytes**: `Uint8Array` + +bytes representation of StreamID. + +#### Returns + +[`StreamID`](StreamID.md) + +#### Throws + +error on invalid input + +#### See + +StreamID#bytes + +#### Defined in + +[stream-id.ts:78](https://github.com/ceramicstudio/ceramic-sdk/blob/a220cbca7950f690af7f3d03a0023681bb9f5426/packages/identifiers/src/stream-id.ts#L78) + +*** + +### fromString() + +> `static` **fromString**: (`input`) => [`StreamID`](StreamID.md) + +Parse StreamID from string representation. + +#### Parameters + +• **input**: `string` + +string representation of StreamID, be it base36-encoded string or URL. + +#### Returns + +[`StreamID`](StreamID.md) + +#### See + + - StreamID#toString + - StreamID#toUrl + +#### Defined in + +[stream-id.ts:79](https://github.com/ceramicstudio/ceramic-sdk/blob/a220cbca7950f690af7f3d03a0023681bb9f5426/packages/identifiers/src/stream-id.ts#L79) + +## Accessors + +### baseID + +> `get` **baseID**(): [`StreamID`](StreamID.md) + +Copy of self. Exists to maintain compatibility with CommitID. + +#### Returns + +[`StreamID`](StreamID.md) + +#### Defined in + +[stream-id.ts:170](https://github.com/ceramicstudio/ceramic-sdk/blob/a220cbca7950f690af7f3d03a0023681bb9f5426/packages/identifiers/src/stream-id.ts#L170) + +*** + +### bytes + +> `get` **bytes**(): `Uint8Array` + +Bytes representation of StreamID. + +#### Returns + +`Uint8Array` + +#### Defined in + +[stream-id.ts:160](https://github.com/ceramicstudio/ceramic-sdk/blob/a220cbca7950f690af7f3d03a0023681bb9f5426/packages/identifiers/src/stream-id.ts#L160) + +*** + +### cid + +> `get` **cid**(): `CID`\<`unknown`, `number`, `number`, `Version`\> + +Genesis commits CID + +#### Returns + +`CID`\<`unknown`, `number`, `number`, `Version`\> + +#### Defined in + +[stream-id.ts:152](https://github.com/ceramicstudio/ceramic-sdk/blob/a220cbca7950f690af7f3d03a0023681bb9f5426/packages/identifiers/src/stream-id.ts#L152) + +*** + +### type + +> `get` **type**(): [`StreamTypeCode`](../type-aliases/StreamTypeCode.md) + +Stream type code + +#### Returns + +[`StreamTypeCode`](../type-aliases/StreamTypeCode.md) + +#### Defined in + +[stream-id.ts:137](https://github.com/ceramicstudio/ceramic-sdk/blob/a220cbca7950f690af7f3d03a0023681bb9f5426/packages/identifiers/src/stream-id.ts#L137) + +*** + +### typeName + +> `get` **typeName**(): `"tile"` \| `"caip10-link"` \| `"model"` \| `"MID"` \| `"UNLOADABLE"` + +Stream type name + +#### Returns + +`"tile"` \| `"caip10-link"` \| `"model"` \| `"MID"` \| `"UNLOADABLE"` + +#### Defined in + +[stream-id.ts:145](https://github.com/ceramicstudio/ceramic-sdk/blob/a220cbca7950f690af7f3d03a0023681bb9f5426/packages/identifiers/src/stream-id.ts#L145) + +## Methods + +### equals() + +> **equals**(`other`): `boolean` + +Compare equality with another StreamID. + +#### Parameters + +• **other**: [`StreamID`](StreamID.md) + +#### Returns + +`boolean` + +#### Defined in + +[stream-id.ts:177](https://github.com/ceramicstudio/ceramic-sdk/blob/a220cbca7950f690af7f3d03a0023681bb9f5426/packages/identifiers/src/stream-id.ts#L177) + +*** + +### toString() + +> **toString**(): `string` + +Encode the StreamID into a string. + +#### Returns + +`string` + +#### Defined in + +[stream-id.ts:187](https://github.com/ceramicstudio/ceramic-sdk/blob/a220cbca7950f690af7f3d03a0023681bb9f5426/packages/identifiers/src/stream-id.ts#L187) + +*** + +### toUrl() + +> **toUrl**(): `string` + +Encode the StreamID into a base36 url. + +#### Returns + +`string` + +#### Defined in + +[stream-id.ts:195](https://github.com/ceramicstudio/ceramic-sdk/blob/a220cbca7950f690af7f3d03a0023681bb9f5426/packages/identifiers/src/stream-id.ts#L195) + +*** + +### fromPayload() + +> `static` **fromPayload**(`type`, `value`): [`StreamID`](StreamID.md) + +Create a streamId from an init event payload. + +#### Parameters + +• **type**: [`StreamType`](../type-aliases/StreamType.md) + +the stream type + +• **value**: `unknown` + +the init event payload + +#### Returns + +[`StreamID`](StreamID.md) + +#### Example + +```typescript +const streamId = StreamID.fromPayload('MID', { + header: { + controllers: ['did:3:kjz...'], + model: '...', + } +}); +``` + +#### Defined in + +[stream-id.ts:130](https://github.com/ceramicstudio/ceramic-sdk/blob/a220cbca7950f690af7f3d03a0023681bb9f5426/packages/identifiers/src/stream-id.ts#L130) + +*** + +### isInstance() + +> `static` **isInstance**(`instance`): `instance is StreamID` + +#### Parameters + +• **instance**: `unknown` + +#### Returns + +`instance is StreamID` + +#### Defined in + +[stream-id.ts:84](https://github.com/ceramicstudio/ceramic-sdk/blob/a220cbca7950f690af7f3d03a0023681bb9f5426/packages/identifiers/src/stream-id.ts#L84) diff --git a/docs/@ceramic-sdk/identifiers/type-aliases/StreamType.md b/docs/@ceramic-sdk/identifiers/type-aliases/StreamType.md new file mode 100644 index 0000000..69393e2 --- /dev/null +++ b/docs/@ceramic-sdk/identifiers/type-aliases/StreamType.md @@ -0,0 +1,13 @@ +[**@ceramic-sdk/identifiers v0.1.0**](../README.md) • **Docs** + +*** + +[Ceramic SDK](../../../README.md) / [@ceramic-sdk/identifiers](../README.md) / StreamType + +# Type Alias: StreamType + +> **StreamType**: [`StreamTypeCode`](StreamTypeCode.md) \| [`StreamTypeName`](StreamTypeName.md) + +## Defined in + +[constants.ts:17](https://github.com/ceramicstudio/ceramic-sdk/blob/a220cbca7950f690af7f3d03a0023681bb9f5426/packages/identifiers/src/constants.ts#L17) diff --git a/docs/@ceramic-sdk/identifiers/type-aliases/StreamTypeCode.md b/docs/@ceramic-sdk/identifiers/type-aliases/StreamTypeCode.md new file mode 100644 index 0000000..2efa38c --- /dev/null +++ b/docs/@ceramic-sdk/identifiers/type-aliases/StreamTypeCode.md @@ -0,0 +1,13 @@ +[**@ceramic-sdk/identifiers v0.1.0**](../README.md) • **Docs** + +*** + +[Ceramic SDK](../../../README.md) / [@ceramic-sdk/identifiers](../README.md) / StreamTypeCode + +# Type Alias: StreamTypeCode + +> **StreamTypeCode**: `StreamTypes`\[[`StreamTypeName`](StreamTypeName.md)\] + +## Defined in + +[constants.ts:15](https://github.com/ceramicstudio/ceramic-sdk/blob/a220cbca7950f690af7f3d03a0023681bb9f5426/packages/identifiers/src/constants.ts#L15) diff --git a/docs/@ceramic-sdk/identifiers/type-aliases/StreamTypeName.md b/docs/@ceramic-sdk/identifiers/type-aliases/StreamTypeName.md new file mode 100644 index 0000000..9f6be14 --- /dev/null +++ b/docs/@ceramic-sdk/identifiers/type-aliases/StreamTypeName.md @@ -0,0 +1,13 @@ +[**@ceramic-sdk/identifiers v0.1.0**](../README.md) • **Docs** + +*** + +[Ceramic SDK](../../../README.md) / [@ceramic-sdk/identifiers](../README.md) / StreamTypeName + +# Type Alias: StreamTypeName + +> **StreamTypeName**: keyof `StreamTypes` + +## Defined in + +[constants.ts:13](https://github.com/ceramicstudio/ceramic-sdk/blob/a220cbca7950f690af7f3d03a0023681bb9f5426/packages/identifiers/src/constants.ts#L13) diff --git a/docs/@ceramic-sdk/identifiers/variables/streamIDAsBytes.md b/docs/@ceramic-sdk/identifiers/variables/streamIDAsBytes.md new file mode 100644 index 0000000..0279475 --- /dev/null +++ b/docs/@ceramic-sdk/identifiers/variables/streamIDAsBytes.md @@ -0,0 +1,15 @@ +[**@ceramic-sdk/identifiers v0.1.0**](../README.md) • **Docs** + +*** + +[Ceramic SDK](../../../README.md) / [@ceramic-sdk/identifiers](../README.md) / streamIDAsBytes + +# Variable: streamIDAsBytes + +> `const` **streamIDAsBytes**: `Type`\<[`StreamID`](../classes/StreamID.md), `Uint8Array`, `Uint8Array`\> + +codeco codec for StreamID encoded as Uint8Array bytes. + +## Defined in + +[codecs.ts:48](https://github.com/ceramicstudio/ceramic-sdk/blob/a220cbca7950f690af7f3d03a0023681bb9f5426/packages/identifiers/src/codecs.ts#L48) diff --git a/docs/@ceramic-sdk/identifiers/variables/streamIDAsString.md b/docs/@ceramic-sdk/identifiers/variables/streamIDAsString.md new file mode 100644 index 0000000..88991cb --- /dev/null +++ b/docs/@ceramic-sdk/identifiers/variables/streamIDAsString.md @@ -0,0 +1,15 @@ +[**@ceramic-sdk/identifiers v0.1.0**](../README.md) • **Docs** + +*** + +[Ceramic SDK](../../../README.md) / [@ceramic-sdk/identifiers](../README.md) / streamIDAsString + +# Variable: streamIDAsString + +> `const` **streamIDAsString**: `Type`\<[`StreamID`](../classes/StreamID.md), `string`, `string`\> + +codeco codec for StreamID encoded as string. + +## Defined in + +[codecs.ts:30](https://github.com/ceramicstudio/ceramic-sdk/blob/a220cbca7950f690af7f3d03a0023681bb9f5426/packages/identifiers/src/codecs.ts#L30) diff --git a/docs/@ceramic-sdk/identifiers/variables/streamIDString.md b/docs/@ceramic-sdk/identifiers/variables/streamIDString.md new file mode 100644 index 0000000..9b3dcdd --- /dev/null +++ b/docs/@ceramic-sdk/identifiers/variables/streamIDString.md @@ -0,0 +1,15 @@ +[**@ceramic-sdk/identifiers v0.1.0**](../README.md) • **Docs** + +*** + +[Ceramic SDK](../../../README.md) / [@ceramic-sdk/identifiers](../README.md) / streamIDString + +# Variable: streamIDString + +> `const` **streamIDString**: `RefinementCodec`\<`TrivialCodec`\<`string`\>, `string`\> + +codeco codec for StreamID string. + +## Defined in + +[codecs.ts:21](https://github.com/ceramicstudio/ceramic-sdk/blob/a220cbca7950f690af7f3d03a0023681bb9f5426/packages/identifiers/src/codecs.ts#L21) diff --git a/docs/@ceramic-sdk/model-client/README.md b/docs/@ceramic-sdk/model-client/README.md new file mode 100644 index 0000000..08b4679 --- /dev/null +++ b/docs/@ceramic-sdk/model-client/README.md @@ -0,0 +1,11 @@ +**@ceramic-sdk/model-client v0.1.0** • **Docs** + +*** + +[Ceramic SDK](../../README.md) / @ceramic-sdk/model-client + +# @ceramic-sdk/model-client + +## Functions + +- [createInitEvent](functions/createInitEvent.md) diff --git a/docs/@ceramic-sdk/model-client/functions/createInitEvent.md b/docs/@ceramic-sdk/model-client/functions/createInitEvent.md new file mode 100644 index 0000000..9537392 --- /dev/null +++ b/docs/@ceramic-sdk/model-client/functions/createInitEvent.md @@ -0,0 +1,25 @@ +[**@ceramic-sdk/model-client v0.1.0**](../README.md) • **Docs** + +*** + +[Ceramic SDK](../../../README.md) / [@ceramic-sdk/model-client](../README.md) / createInitEvent + +# Function: createInitEvent() + +> **createInitEvent**(`did`, `data`): `Promise`\<[`SignedEvent`](../../events/type-aliases/SignedEvent.md)\> + +Create a signed init event for a model using the provided DID and model definition + +## Parameters + +• **did**: `DID` + +• **data**: `MapIn`\<`RequiredProps`\<`object`\>, `$TypeOf`\> & `MapIn`\<`OptionalProps`\<`object`\>, `$TypeOf`\> \| `MapIn`\<`RequiredProps`\<`object`\>, `$TypeOf`\> & `MapIn`\<`OptionalProps`\<`object`\>, `$TypeOf`\> + +## Returns + +`Promise`\<[`SignedEvent`](../../events/type-aliases/SignedEvent.md)\> + +## Defined in + +[model-client/src/index.ts:19](https://github.com/ceramicstudio/ceramic-sdk/blob/a220cbca7950f690af7f3d03a0023681bb9f5426/packages/model-client/src/index.ts#L19) diff --git a/docs/@ceramic-sdk/model-instance-client/README.md b/docs/@ceramic-sdk/model-instance-client/README.md new file mode 100644 index 0000000..8fab865 --- /dev/null +++ b/docs/@ceramic-sdk/model-instance-client/README.md @@ -0,0 +1,21 @@ +**@ceramic-sdk/model-instance-client v0.1.0** • **Docs** + +*** + +[Ceramic SDK](../../README.md) / @ceramic-sdk/model-instance-client + +# @ceramic-sdk/model-instance-client + +## Type Aliases + +- [CreateDataEventParams](type-aliases/CreateDataEventParams.md) +- [CreateInitEventParams](type-aliases/CreateInitEventParams.md) +- [UnknownContent](type-aliases/UnknownContent.md) + +## Functions + +- [createDataEvent](functions/createDataEvent.md) +- [createDataEventPayload](functions/createDataEventPayload.md) +- [createInitEvent](functions/createInitEvent.md) +- [getDeterministicInitEvent](functions/getDeterministicInitEvent.md) +- [getDeterministicInitEventPayload](functions/getDeterministicInitEventPayload.md) diff --git a/docs/@ceramic-sdk/model-instance-client/functions/createDataEvent.md b/docs/@ceramic-sdk/model-instance-client/functions/createDataEvent.md new file mode 100644 index 0000000..5dd4a67 --- /dev/null +++ b/docs/@ceramic-sdk/model-instance-client/functions/createDataEvent.md @@ -0,0 +1,27 @@ +[**@ceramic-sdk/model-instance-client v0.1.0**](../README.md) • **Docs** + +*** + +[Ceramic SDK](../../../README.md) / [@ceramic-sdk/model-instance-client](../README.md) / createDataEvent + +# Function: createDataEvent() + +> **createDataEvent**\<`T`\>(`params`): `Promise`\<[`SignedEvent`](../../events/type-aliases/SignedEvent.md)\> + +Create a signed data event for a ModelInstanceDocument stream + +## Type Parameters + +• **T** *extends* [`UnknownContent`](../type-aliases/UnknownContent.md) = [`UnknownContent`](../type-aliases/UnknownContent.md) + +## Parameters + +• **params**: [`CreateDataEventParams`](../type-aliases/CreateDataEventParams.md)\<`T`\> + +## Returns + +`Promise`\<[`SignedEvent`](../../events/type-aliases/SignedEvent.md)\> + +## Defined in + +[model-instance-client/src/events.ts:128](https://github.com/ceramicstudio/ceramic-sdk/blob/a220cbca7950f690af7f3d03a0023681bb9f5426/packages/model-instance-client/src/events.ts#L128) diff --git a/docs/@ceramic-sdk/model-instance-client/functions/createDataEventPayload.md b/docs/@ceramic-sdk/model-instance-client/functions/createDataEventPayload.md new file mode 100644 index 0000000..dd087ef --- /dev/null +++ b/docs/@ceramic-sdk/model-instance-client/functions/createDataEventPayload.md @@ -0,0 +1,27 @@ +[**@ceramic-sdk/model-instance-client v0.1.0**](../README.md) • **Docs** + +*** + +[Ceramic SDK](../../../README.md) / [@ceramic-sdk/model-instance-client](../README.md) / createDataEventPayload + +# Function: createDataEventPayload() + +> **createDataEventPayload**(`current`, `data`, `header`?): [`DocumentDataEventPayload`](../../model-instance-protocol/type-aliases/DocumentDataEventPayload.md) + +Create a data event payload for a ModelInstanceDocument stream + +## Parameters + +• **current**: [`CommitID`](../../identifiers/classes/CommitID.md) + +• **data**: (`MapIn`\<`object`, `$TypeOf`\> \| `MapIn`\<`object`, `$TypeOf`\> \| `MapIn`\<`object`, `$TypeOf`\> \| `MapIn`\<`object`, `$TypeOf`\> \| `MapIn`\<`object`, `$TypeOf`\> \| `MapIn`\<`object`, `$TypeOf`\>)[] + +• **header?**: `MapIn`\<`RequiredProps`\<`object`\>, `$TypeOf`\> & `MapIn`\<`OptionalProps`\<`object`\>, `$TypeOf`\> + +## Returns + +[`DocumentDataEventPayload`](../../model-instance-protocol/type-aliases/DocumentDataEventPayload.md) + +## Defined in + +[model-instance-client/src/events.ts:92](https://github.com/ceramicstudio/ceramic-sdk/blob/a220cbca7950f690af7f3d03a0023681bb9f5426/packages/model-instance-client/src/events.ts#L92) diff --git a/docs/@ceramic-sdk/model-instance-client/functions/createInitEvent.md b/docs/@ceramic-sdk/model-instance-client/functions/createInitEvent.md new file mode 100644 index 0000000..f4ed070 --- /dev/null +++ b/docs/@ceramic-sdk/model-instance-client/functions/createInitEvent.md @@ -0,0 +1,31 @@ +[**@ceramic-sdk/model-instance-client v0.1.0**](../README.md) • **Docs** + +*** + +[Ceramic SDK](../../../README.md) / [@ceramic-sdk/model-instance-client](../README.md) / createInitEvent + +# Function: createInitEvent() + +> **createInitEvent**\<`T`\>(`params`): `Promise`\<[`SignedEvent`](../../events/type-aliases/SignedEvent.md)\> + +Create a non-deterministic init event for a ModelInstanceDocument stream. + +## Type Parameters + +• **T** *extends* [`UnknownContent`](../type-aliases/UnknownContent.md) = [`UnknownContent`](../type-aliases/UnknownContent.md) + +## Parameters + +• **params**: [`CreateInitEventParams`](../type-aliases/CreateInitEventParams.md)\<`T`\> + +## Returns + +`Promise`\<[`SignedEvent`](../../events/type-aliases/SignedEvent.md)\> + +## See + +[getDeterministicInitEventPayload](getDeterministicInitEventPayload.md) for deterministic events. + +## Defined in + +[model-instance-client/src/events.ts:40](https://github.com/ceramicstudio/ceramic-sdk/blob/a220cbca7950f690af7f3d03a0023681bb9f5426/packages/model-instance-client/src/events.ts#L40) diff --git a/docs/@ceramic-sdk/model-instance-client/functions/getDeterministicInitEvent.md b/docs/@ceramic-sdk/model-instance-client/functions/getDeterministicInitEvent.md new file mode 100644 index 0000000..d44dfe9 --- /dev/null +++ b/docs/@ceramic-sdk/model-instance-client/functions/getDeterministicInitEvent.md @@ -0,0 +1,27 @@ +[**@ceramic-sdk/model-instance-client v0.1.0**](../README.md) • **Docs** + +*** + +[Ceramic SDK](../../../README.md) / [@ceramic-sdk/model-instance-client](../README.md) / getDeterministicInitEvent + +# Function: getDeterministicInitEvent() + +> **getDeterministicInitEvent**(`model`, `controller`, `uniqueValue`?): [`EncodedDeterministicInitEventPayload`](../../model-instance-protocol/type-aliases/EncodedDeterministicInitEventPayload.md) + +Get an encoded deterministic init event for a ModelInstanceDocument stream + +## Parameters + +• **model**: [`StreamID`](../../identifiers/classes/StreamID.md) + +• **controller**: `string` \| `string` & `WithOpaque`\<`"DIDString"`\> + +• **uniqueValue?**: `Uint8Array` + +## Returns + +[`EncodedDeterministicInitEventPayload`](../../model-instance-protocol/type-aliases/EncodedDeterministicInitEventPayload.md) + +## Defined in + +[model-instance-client/src/events.ts:75](https://github.com/ceramicstudio/ceramic-sdk/blob/a220cbca7950f690af7f3d03a0023681bb9f5426/packages/model-instance-client/src/events.ts#L75) diff --git a/docs/@ceramic-sdk/model-instance-client/functions/getDeterministicInitEventPayload.md b/docs/@ceramic-sdk/model-instance-client/functions/getDeterministicInitEventPayload.md new file mode 100644 index 0000000..1497c2e --- /dev/null +++ b/docs/@ceramic-sdk/model-instance-client/functions/getDeterministicInitEventPayload.md @@ -0,0 +1,31 @@ +[**@ceramic-sdk/model-instance-client v0.1.0**](../README.md) • **Docs** + +*** + +[Ceramic SDK](../../../README.md) / [@ceramic-sdk/model-instance-client](../README.md) / getDeterministicInitEventPayload + +# Function: getDeterministicInitEventPayload() + +> **getDeterministicInitEventPayload**(`model`, `controller`, `uniqueValue`?): [`DeterministicInitEventPayload`](../../model-instance-protocol/type-aliases/DeterministicInitEventPayload.md) + +Get a deterministic init event payload for a ModelInstanceDocument stream. + +## Parameters + +• **model**: [`StreamID`](../../identifiers/classes/StreamID.md) + +• **controller**: `string` \| `string` & `WithOpaque`\<`"DIDString"`\> + +• **uniqueValue?**: `Uint8Array` + +## Returns + +[`DeterministicInitEventPayload`](../../model-instance-protocol/type-aliases/DeterministicInitEventPayload.md) + +## See + +[createInitEvent](createInitEvent.md) for creating non-deterministic events. + +## Defined in + +[model-instance-client/src/events.ts:57](https://github.com/ceramicstudio/ceramic-sdk/blob/a220cbca7950f690af7f3d03a0023681bb9f5426/packages/model-instance-client/src/events.ts#L57) diff --git a/docs/@ceramic-sdk/model-instance-client/type-aliases/CreateDataEventParams.md b/docs/@ceramic-sdk/model-instance-client/type-aliases/CreateDataEventParams.md new file mode 100644 index 0000000..e8f57d0 --- /dev/null +++ b/docs/@ceramic-sdk/model-instance-client/type-aliases/CreateDataEventParams.md @@ -0,0 +1,49 @@ +[**@ceramic-sdk/model-instance-client v0.1.0**](../README.md) • **Docs** + +*** + +[Ceramic SDK](../../../README.md) / [@ceramic-sdk/model-instance-client](../README.md) / CreateDataEventParams + +# Type Alias: CreateDataEventParams\ + +> **CreateDataEventParams**\<`T`\>: `object` + +## Type Parameters + +• **T** *extends* [`UnknownContent`](UnknownContent.md) = [`UnknownContent`](UnknownContent.md) + +## Type declaration + +### controller + +> **controller**: `DID` + +DID controlling the ModelInstanceDocument stream + +### currentContent? + +> `optional` **currentContent**: `T` + +Current JSON object content for the ModelInstanceDocument stream, used with `newContent` to create the JSON patch + +### currentID + +> **currentID**: [`CommitID`](../../identifiers/classes/CommitID.md) + +Commit ID of the current tip of the ModelInstanceDocument stream + +### newContent? + +> `optional` **newContent**: `T` + +New JSON object content for the ModelInstanceDocument stream, used with `currentContent` to create the JSON patch + +### shouldIndex? + +> `optional` **shouldIndex**: `boolean` + +Flag notifying indexers if they should index the ModelInstanceDocument stream or not + +## Defined in + +[model-instance-client/src/events.ts:112](https://github.com/ceramicstudio/ceramic-sdk/blob/a220cbca7950f690af7f3d03a0023681bb9f5426/packages/model-instance-client/src/events.ts#L112) diff --git a/docs/@ceramic-sdk/model-instance-client/type-aliases/CreateInitEventParams.md b/docs/@ceramic-sdk/model-instance-client/type-aliases/CreateInitEventParams.md new file mode 100644 index 0000000..44fe406 --- /dev/null +++ b/docs/@ceramic-sdk/model-instance-client/type-aliases/CreateInitEventParams.md @@ -0,0 +1,49 @@ +[**@ceramic-sdk/model-instance-client v0.1.0**](../README.md) • **Docs** + +*** + +[Ceramic SDK](../../../README.md) / [@ceramic-sdk/model-instance-client](../README.md) / CreateInitEventParams + +# Type Alias: CreateInitEventParams\ + +> **CreateInitEventParams**\<`T`\>: `object` + +## Type Parameters + +• **T** *extends* [`UnknownContent`](UnknownContent.md) = [`UnknownContent`](UnknownContent.md) + +## Type declaration + +### content + +> **content**: `T` + +Initial JSON object content for the ModelInstanceDocument stream + +### context? + +> `optional` **context**: [`StreamID`](../../identifiers/classes/StreamID.md) + +Optional context + +### controller + +> **controller**: `DID` + +DID controlling the ModelInstanceDocument stream + +### model + +> **model**: [`StreamID`](../../identifiers/classes/StreamID.md) + +Stream ID of the Model used by the ModelInstanceDocument stream + +### shouldIndex? + +> `optional` **shouldIndex**: `boolean` + +Flag notifying indexers if they should index the ModelInstanceDocument stream or not, defaults to `true` + +## Defined in + +[model-instance-client/src/events.ts:23](https://github.com/ceramicstudio/ceramic-sdk/blob/a220cbca7950f690af7f3d03a0023681bb9f5426/packages/model-instance-client/src/events.ts#L23) diff --git a/docs/@ceramic-sdk/model-instance-client/type-aliases/UnknownContent.md b/docs/@ceramic-sdk/model-instance-client/type-aliases/UnknownContent.md new file mode 100644 index 0000000..18f9f0b --- /dev/null +++ b/docs/@ceramic-sdk/model-instance-client/type-aliases/UnknownContent.md @@ -0,0 +1,13 @@ +[**@ceramic-sdk/model-instance-client v0.1.0**](../README.md) • **Docs** + +*** + +[Ceramic SDK](../../../README.md) / [@ceramic-sdk/model-instance-client](../README.md) / UnknownContent + +# Type Alias: UnknownContent + +> **UnknownContent**: `Record`\<`string`, `unknown`\> + +## Defined in + +[model-instance-client/src/types.ts:1](https://github.com/ceramicstudio/ceramic-sdk/blob/a220cbca7950f690af7f3d03a0023681bb9f5426/packages/model-instance-client/src/types.ts#L1) diff --git a/docs/@ceramic-sdk/model-instance-protocol/README.md b/docs/@ceramic-sdk/model-instance-protocol/README.md new file mode 100644 index 0000000..ddaadff --- /dev/null +++ b/docs/@ceramic-sdk/model-instance-protocol/README.md @@ -0,0 +1,45 @@ +**@ceramic-sdk/model-instance-protocol v0.1.0** • **Docs** + +*** + +[Ceramic SDK](../../README.md) / @ceramic-sdk/model-instance-protocol + +# @ceramic-sdk/model-instance-protocol + +## Type Aliases + +- [DataInitEventPayload](type-aliases/DataInitEventPayload.md) +- [DeterministicInitEventPayload](type-aliases/DeterministicInitEventPayload.md) +- [DocumentDataEventHeader](type-aliases/DocumentDataEventHeader.md) +- [DocumentDataEventPayload](type-aliases/DocumentDataEventPayload.md) +- [DocumentEvent](type-aliases/DocumentEvent.md) +- [DocumentInitEventHeader](type-aliases/DocumentInitEventHeader.md) +- [DocumentInitEventPayload](type-aliases/DocumentInitEventPayload.md) +- [DocumentMetadata](type-aliases/DocumentMetadata.md) +- [EncodedDeterministicInitEventPayload](type-aliases/EncodedDeterministicInitEventPayload.md) +- [EncodedDocumentMetadata](type-aliases/EncodedDocumentMetadata.md) +- [JSONPatchOperation](type-aliases/JSONPatchOperation.md) + +## Variables + +- [DataInitEventPayload](variables/DataInitEventPayload.md) +- [DeterministicInitEventPayload](variables/DeterministicInitEventPayload.md) +- [DocumentDataEventHeader](variables/DocumentDataEventHeader.md) +- [DocumentDataEventPayload](variables/DocumentDataEventPayload.md) +- [DocumentEvent](variables/DocumentEvent.md) +- [DocumentInitEventHeader](variables/DocumentInitEventHeader.md) +- [DocumentInitEventPayload](variables/DocumentInitEventPayload.md) +- [DocumentMetadata](variables/DocumentMetadata.md) +- [JSONPatchAddOperation](variables/JSONPatchAddOperation.md) +- [JSONPatchCopyOperation](variables/JSONPatchCopyOperation.md) +- [JSONPatchMoveOperation](variables/JSONPatchMoveOperation.md) +- [JSONPatchOperation](variables/JSONPatchOperation.md) +- [JSONPatchRemoveOperation](variables/JSONPatchRemoveOperation.md) +- [JSONPatchReplaceOperation](variables/JSONPatchReplaceOperation.md) +- [JSONPatchTestOperation](variables/JSONPatchTestOperation.md) +- [MAX\_DOCUMENT\_SIZE](variables/MAX_DOCUMENT_SIZE.md) + +## Functions + +- [getDeterministicStreamID](functions/getDeterministicStreamID.md) +- [getStreamID](functions/getStreamID.md) diff --git a/docs/@ceramic-sdk/model-instance-protocol/functions/getDeterministicStreamID.md b/docs/@ceramic-sdk/model-instance-protocol/functions/getDeterministicStreamID.md new file mode 100644 index 0000000..de54b0b --- /dev/null +++ b/docs/@ceramic-sdk/model-instance-protocol/functions/getDeterministicStreamID.md @@ -0,0 +1,23 @@ +[**@ceramic-sdk/model-instance-protocol v0.1.0**](../README.md) • **Docs** + +*** + +[Ceramic SDK](../../../README.md) / [@ceramic-sdk/model-instance-protocol](../README.md) / getDeterministicStreamID + +# Function: getDeterministicStreamID() + +> **getDeterministicStreamID**(`header`): [`StreamID`](../../identifiers/classes/StreamID.md) + +Get the StreamID of a deterministic ModelInstanceDocument based on its init header + +## Parameters + +• **header**: `MapIn`\<`RequiredProps`\<`object`\>, `$TypeOf`\> & `MapIn`\<`OptionalProps`\<`object`\>, `$TypeOf`\> + +## Returns + +[`StreamID`](../../identifiers/classes/StreamID.md) + +## Defined in + +[packages/model-instance-protocol/src/stream-id.ts:10](https://github.com/ceramicstudio/ceramic-sdk/blob/a220cbca7950f690af7f3d03a0023681bb9f5426/packages/model-instance-protocol/src/stream-id.ts#L10) diff --git a/docs/@ceramic-sdk/model-instance-protocol/functions/getStreamID.md b/docs/@ceramic-sdk/model-instance-protocol/functions/getStreamID.md new file mode 100644 index 0000000..4475112 --- /dev/null +++ b/docs/@ceramic-sdk/model-instance-protocol/functions/getStreamID.md @@ -0,0 +1,23 @@ +[**@ceramic-sdk/model-instance-protocol v0.1.0**](../README.md) • **Docs** + +*** + +[Ceramic SDK](../../../README.md) / [@ceramic-sdk/model-instance-protocol](../README.md) / getStreamID + +# Function: getStreamID() + +> **getStreamID**(`cid`): [`StreamID`](../../identifiers/classes/StreamID.md) + +Get the StreamID of a ModelInstanceDocument based on its init CID + +## Parameters + +• **cid**: `CID`\<`unknown`, `number`, `number`, `Version`\> + +## Returns + +[`StreamID`](../../identifiers/classes/StreamID.md) + +## Defined in + +[packages/model-instance-protocol/src/stream-id.ts:29](https://github.com/ceramicstudio/ceramic-sdk/blob/a220cbca7950f690af7f3d03a0023681bb9f5426/packages/model-instance-protocol/src/stream-id.ts#L29) diff --git a/docs/@ceramic-sdk/model-instance-protocol/type-aliases/DataInitEventPayload.md b/docs/@ceramic-sdk/model-instance-protocol/type-aliases/DataInitEventPayload.md new file mode 100644 index 0000000..0de1a7f --- /dev/null +++ b/docs/@ceramic-sdk/model-instance-protocol/type-aliases/DataInitEventPayload.md @@ -0,0 +1,13 @@ +[**@ceramic-sdk/model-instance-protocol v0.1.0**](../README.md) • **Docs** + +*** + +[Ceramic SDK](../../../README.md) / [@ceramic-sdk/model-instance-protocol](../README.md) / DataInitEventPayload + +# Type Alias: DataInitEventPayload + +> **DataInitEventPayload**: `TypeOf`\<*typeof* [`DataInitEventPayload`](../variables/DataInitEventPayload.md)\> + +## Defined in + +[packages/model-instance-protocol/src/codecs.ts:117](https://github.com/ceramicstudio/ceramic-sdk/blob/a220cbca7950f690af7f3d03a0023681bb9f5426/packages/model-instance-protocol/src/codecs.ts#L117) diff --git a/docs/@ceramic-sdk/model-instance-protocol/type-aliases/DeterministicInitEventPayload.md b/docs/@ceramic-sdk/model-instance-protocol/type-aliases/DeterministicInitEventPayload.md new file mode 100644 index 0000000..c81c452 --- /dev/null +++ b/docs/@ceramic-sdk/model-instance-protocol/type-aliases/DeterministicInitEventPayload.md @@ -0,0 +1,13 @@ +[**@ceramic-sdk/model-instance-protocol v0.1.0**](../README.md) • **Docs** + +*** + +[Ceramic SDK](../../../README.md) / [@ceramic-sdk/model-instance-protocol](../README.md) / DeterministicInitEventPayload + +# Type Alias: DeterministicInitEventPayload + +> **DeterministicInitEventPayload**: `TypeOf`\<*typeof* [`DeterministicInitEventPayload`](../variables/DeterministicInitEventPayload.md)\> + +## Defined in + +[packages/model-instance-protocol/src/codecs.ts:129](https://github.com/ceramicstudio/ceramic-sdk/blob/a220cbca7950f690af7f3d03a0023681bb9f5426/packages/model-instance-protocol/src/codecs.ts#L129) diff --git a/docs/@ceramic-sdk/model-instance-protocol/type-aliases/DocumentDataEventHeader.md b/docs/@ceramic-sdk/model-instance-protocol/type-aliases/DocumentDataEventHeader.md new file mode 100644 index 0000000..6cd5899 --- /dev/null +++ b/docs/@ceramic-sdk/model-instance-protocol/type-aliases/DocumentDataEventHeader.md @@ -0,0 +1,13 @@ +[**@ceramic-sdk/model-instance-protocol v0.1.0**](../README.md) • **Docs** + +*** + +[Ceramic SDK](../../../README.md) / [@ceramic-sdk/model-instance-protocol](../README.md) / DocumentDataEventHeader + +# Type Alias: DocumentDataEventHeader + +> **DocumentDataEventHeader**: `TypeOf`\<*typeof* [`DocumentDataEventHeader`](../variables/DocumentDataEventHeader.md)\> + +## Defined in + +[packages/model-instance-protocol/src/codecs.ts:155](https://github.com/ceramicstudio/ceramic-sdk/blob/a220cbca7950f690af7f3d03a0023681bb9f5426/packages/model-instance-protocol/src/codecs.ts#L155) diff --git a/docs/@ceramic-sdk/model-instance-protocol/type-aliases/DocumentDataEventPayload.md b/docs/@ceramic-sdk/model-instance-protocol/type-aliases/DocumentDataEventPayload.md new file mode 100644 index 0000000..08db14f --- /dev/null +++ b/docs/@ceramic-sdk/model-instance-protocol/type-aliases/DocumentDataEventPayload.md @@ -0,0 +1,13 @@ +[**@ceramic-sdk/model-instance-protocol v0.1.0**](../README.md) • **Docs** + +*** + +[Ceramic SDK](../../../README.md) / [@ceramic-sdk/model-instance-protocol](../README.md) / DocumentDataEventPayload + +# Type Alias: DocumentDataEventPayload + +> **DocumentDataEventPayload**: `TypeOf`\<*typeof* [`DocumentDataEventPayload`](../variables/DocumentDataEventPayload.md)\> + +## Defined in + +[packages/model-instance-protocol/src/codecs.ts:166](https://github.com/ceramicstudio/ceramic-sdk/blob/a220cbca7950f690af7f3d03a0023681bb9f5426/packages/model-instance-protocol/src/codecs.ts#L166) diff --git a/docs/@ceramic-sdk/model-instance-protocol/type-aliases/DocumentEvent.md b/docs/@ceramic-sdk/model-instance-protocol/type-aliases/DocumentEvent.md new file mode 100644 index 0000000..d7d12c3 --- /dev/null +++ b/docs/@ceramic-sdk/model-instance-protocol/type-aliases/DocumentEvent.md @@ -0,0 +1,13 @@ +[**@ceramic-sdk/model-instance-protocol v0.1.0**](../README.md) • **Docs** + +*** + +[Ceramic SDK](../../../README.md) / [@ceramic-sdk/model-instance-protocol](../README.md) / DocumentEvent + +# Type Alias: DocumentEvent + +> **DocumentEvent**: `OutputOf`\<*typeof* [`DocumentEvent`](../variables/DocumentEvent.md)\> + +## Defined in + +[packages/model-instance-protocol/src/codecs.ts:211](https://github.com/ceramicstudio/ceramic-sdk/blob/a220cbca7950f690af7f3d03a0023681bb9f5426/packages/model-instance-protocol/src/codecs.ts#L211) diff --git a/docs/@ceramic-sdk/model-instance-protocol/type-aliases/DocumentInitEventHeader.md b/docs/@ceramic-sdk/model-instance-protocol/type-aliases/DocumentInitEventHeader.md new file mode 100644 index 0000000..15d0280 --- /dev/null +++ b/docs/@ceramic-sdk/model-instance-protocol/type-aliases/DocumentInitEventHeader.md @@ -0,0 +1,13 @@ +[**@ceramic-sdk/model-instance-protocol v0.1.0**](../README.md) • **Docs** + +*** + +[Ceramic SDK](../../../README.md) / [@ceramic-sdk/model-instance-protocol](../README.md) / DocumentInitEventHeader + +# Type Alias: DocumentInitEventHeader + +> **DocumentInitEventHeader**: `TypeOf`\<*typeof* [`DocumentInitEventHeader`](../variables/DocumentInitEventHeader.md)\> + +## Defined in + +[packages/model-instance-protocol/src/codecs.ts:101](https://github.com/ceramicstudio/ceramic-sdk/blob/a220cbca7950f690af7f3d03a0023681bb9f5426/packages/model-instance-protocol/src/codecs.ts#L101) diff --git a/docs/@ceramic-sdk/model-instance-protocol/type-aliases/DocumentInitEventPayload.md b/docs/@ceramic-sdk/model-instance-protocol/type-aliases/DocumentInitEventPayload.md new file mode 100644 index 0000000..bef98a1 --- /dev/null +++ b/docs/@ceramic-sdk/model-instance-protocol/type-aliases/DocumentInitEventPayload.md @@ -0,0 +1,13 @@ +[**@ceramic-sdk/model-instance-protocol v0.1.0**](../README.md) • **Docs** + +*** + +[Ceramic SDK](../../../README.md) / [@ceramic-sdk/model-instance-protocol](../README.md) / DocumentInitEventPayload + +# Type Alias: DocumentInitEventPayload + +> **DocumentInitEventPayload**: `TypeOf`\<*typeof* [`DocumentInitEventPayload`](../variables/DocumentInitEventPayload.md)\> + +## Defined in + +[packages/model-instance-protocol/src/codecs.ts:146](https://github.com/ceramicstudio/ceramic-sdk/blob/a220cbca7950f690af7f3d03a0023681bb9f5426/packages/model-instance-protocol/src/codecs.ts#L146) diff --git a/docs/@ceramic-sdk/model-instance-protocol/type-aliases/DocumentMetadata.md b/docs/@ceramic-sdk/model-instance-protocol/type-aliases/DocumentMetadata.md new file mode 100644 index 0000000..f0662d6 --- /dev/null +++ b/docs/@ceramic-sdk/model-instance-protocol/type-aliases/DocumentMetadata.md @@ -0,0 +1,13 @@ +[**@ceramic-sdk/model-instance-protocol v0.1.0**](../README.md) • **Docs** + +*** + +[Ceramic SDK](../../../README.md) / [@ceramic-sdk/model-instance-protocol](../README.md) / DocumentMetadata + +# Type Alias: DocumentMetadata + +> **DocumentMetadata**: `TypeOf`\<*typeof* [`DocumentMetadata`](../variables/DocumentMetadata.md)\> + +## Defined in + +[packages/model-instance-protocol/src/codecs.ts:180](https://github.com/ceramicstudio/ceramic-sdk/blob/a220cbca7950f690af7f3d03a0023681bb9f5426/packages/model-instance-protocol/src/codecs.ts#L180) diff --git a/docs/@ceramic-sdk/model-instance-protocol/type-aliases/EncodedDeterministicInitEventPayload.md b/docs/@ceramic-sdk/model-instance-protocol/type-aliases/EncodedDeterministicInitEventPayload.md new file mode 100644 index 0000000..9e8e2be --- /dev/null +++ b/docs/@ceramic-sdk/model-instance-protocol/type-aliases/EncodedDeterministicInitEventPayload.md @@ -0,0 +1,13 @@ +[**@ceramic-sdk/model-instance-protocol v0.1.0**](../README.md) • **Docs** + +*** + +[Ceramic SDK](../../../README.md) / [@ceramic-sdk/model-instance-protocol](../README.md) / EncodedDeterministicInitEventPayload + +# Type Alias: EncodedDeterministicInitEventPayload + +> **EncodedDeterministicInitEventPayload**: `OutputOf`\<*typeof* [`DeterministicInitEventPayload`](../variables/DeterministicInitEventPayload.md)\> + +## Defined in + +[packages/model-instance-protocol/src/codecs.ts:139](https://github.com/ceramicstudio/ceramic-sdk/blob/a220cbca7950f690af7f3d03a0023681bb9f5426/packages/model-instance-protocol/src/codecs.ts#L139) diff --git a/docs/@ceramic-sdk/model-instance-protocol/type-aliases/EncodedDocumentMetadata.md b/docs/@ceramic-sdk/model-instance-protocol/type-aliases/EncodedDocumentMetadata.md new file mode 100644 index 0000000..7f98add --- /dev/null +++ b/docs/@ceramic-sdk/model-instance-protocol/type-aliases/EncodedDocumentMetadata.md @@ -0,0 +1,13 @@ +[**@ceramic-sdk/model-instance-protocol v0.1.0**](../README.md) • **Docs** + +*** + +[Ceramic SDK](../../../README.md) / [@ceramic-sdk/model-instance-protocol](../README.md) / EncodedDocumentMetadata + +# Type Alias: EncodedDocumentMetadata + +> **EncodedDocumentMetadata**: `OutputOf`\<*typeof* [`DocumentMetadata`](../variables/DocumentMetadata.md)\> + +## Defined in + +[packages/model-instance-protocol/src/codecs.ts:206](https://github.com/ceramicstudio/ceramic-sdk/blob/a220cbca7950f690af7f3d03a0023681bb9f5426/packages/model-instance-protocol/src/codecs.ts#L206) diff --git a/docs/@ceramic-sdk/model-instance-protocol/type-aliases/JSONPatchOperation.md b/docs/@ceramic-sdk/model-instance-protocol/type-aliases/JSONPatchOperation.md new file mode 100644 index 0000000..5efd6c9 --- /dev/null +++ b/docs/@ceramic-sdk/model-instance-protocol/type-aliases/JSONPatchOperation.md @@ -0,0 +1,13 @@ +[**@ceramic-sdk/model-instance-protocol v0.1.0**](../README.md) • **Docs** + +*** + +[Ceramic SDK](../../../README.md) / [@ceramic-sdk/model-instance-protocol](../README.md) / JSONPatchOperation + +# Type Alias: JSONPatchOperation + +> **JSONPatchOperation**: `TypeOf`\<*typeof* [`JSONPatchOperation`](../variables/JSONPatchOperation.md)\> + +## Defined in + +[packages/model-instance-protocol/src/codecs.ts:85](https://github.com/ceramicstudio/ceramic-sdk/blob/a220cbca7950f690af7f3d03a0023681bb9f5426/packages/model-instance-protocol/src/codecs.ts#L85) diff --git a/docs/@ceramic-sdk/model-instance-protocol/variables/DataInitEventPayload.md b/docs/@ceramic-sdk/model-instance-protocol/variables/DataInitEventPayload.md new file mode 100644 index 0000000..6353f0a --- /dev/null +++ b/docs/@ceramic-sdk/model-instance-protocol/variables/DataInitEventPayload.md @@ -0,0 +1,51 @@ +[**@ceramic-sdk/model-instance-protocol v0.1.0**](../README.md) • **Docs** + +*** + +[Ceramic SDK](../../../README.md) / [@ceramic-sdk/model-instance-protocol](../README.md) / DataInitEventPayload + +# Variable: DataInitEventPayload + +> `const` **DataInitEventPayload**: `SparseCodec`\<`object`\> + +Init event payload for a non-deterministic ModelInstanceDocument Stream + +## Type declaration + +### data + +> **data**: `TrivialCodec`\<`Record`\<`string`, `unknown`\>\> = `unknownRecord` + +### header + +> **header**: `SparseCodec`\<`object`\> = `DocumentInitEventHeader` + +#### Type declaration + +##### context + +> **context**: `OptionalCodec`\<`Type`\<[`StreamID`](../../identifiers/classes/StreamID.md), `Uint8Array`, `Uint8Array`\>\> + +##### controllers + +> **controllers**: `TupleCodec`\<[`RefinementCodec`\<`TrivialCodec`\<`string`\>, `string` & `WithOpaque`\<`"DIDString"`\>\>]\> + +##### model + +> **model**: `Type`\<[`StreamID`](../../identifiers/classes/StreamID.md), `Uint8Array`, `Uint8Array`\> = `streamIDAsBytes` + +##### sep + +> **sep**: `LiteralCodec`\<`"model"`\> + +##### shouldIndex + +> **shouldIndex**: `OptionalCodec`\<`TrivialCodec`\<`boolean`\>\> + +##### unique + +> **unique**: `OptionalCodec`\<`TrivialCodec`\<`Uint8Array`\>\> + +## Defined in + +[packages/model-instance-protocol/src/codecs.ts:117](https://github.com/ceramicstudio/ceramic-sdk/blob/a220cbca7950f690af7f3d03a0023681bb9f5426/packages/model-instance-protocol/src/codecs.ts#L117) diff --git a/docs/@ceramic-sdk/model-instance-protocol/variables/DeterministicInitEventPayload.md b/docs/@ceramic-sdk/model-instance-protocol/variables/DeterministicInitEventPayload.md new file mode 100644 index 0000000..80106e7 --- /dev/null +++ b/docs/@ceramic-sdk/model-instance-protocol/variables/DeterministicInitEventPayload.md @@ -0,0 +1,51 @@ +[**@ceramic-sdk/model-instance-protocol v0.1.0**](../README.md) • **Docs** + +*** + +[Ceramic SDK](../../../README.md) / [@ceramic-sdk/model-instance-protocol](../README.md) / DeterministicInitEventPayload + +# Variable: DeterministicInitEventPayload + +> `const` **DeterministicInitEventPayload**: `SparseCodec`\<`object`\> + +Init event payload for a deterministic ModelInstanceDocument Stream + +## Type declaration + +### data + +> **data**: `TrivialCodec`\<`null`\> = `nullCodec` + +### header + +> **header**: `SparseCodec`\<`object`\> = `DocumentInitEventHeader` + +#### Type declaration + +##### context + +> **context**: `OptionalCodec`\<`Type`\<[`StreamID`](../../identifiers/classes/StreamID.md), `Uint8Array`, `Uint8Array`\>\> + +##### controllers + +> **controllers**: `TupleCodec`\<[`RefinementCodec`\<`TrivialCodec`\<`string`\>, `string` & `WithOpaque`\<`"DIDString"`\>\>]\> + +##### model + +> **model**: `Type`\<[`StreamID`](../../identifiers/classes/StreamID.md), `Uint8Array`, `Uint8Array`\> = `streamIDAsBytes` + +##### sep + +> **sep**: `LiteralCodec`\<`"model"`\> + +##### shouldIndex + +> **shouldIndex**: `OptionalCodec`\<`TrivialCodec`\<`boolean`\>\> + +##### unique + +> **unique**: `OptionalCodec`\<`TrivialCodec`\<`Uint8Array`\>\> + +## Defined in + +[packages/model-instance-protocol/src/codecs.ts:129](https://github.com/ceramicstudio/ceramic-sdk/blob/a220cbca7950f690af7f3d03a0023681bb9f5426/packages/model-instance-protocol/src/codecs.ts#L129) diff --git a/docs/@ceramic-sdk/model-instance-protocol/variables/DocumentDataEventHeader.md b/docs/@ceramic-sdk/model-instance-protocol/variables/DocumentDataEventHeader.md new file mode 100644 index 0000000..e432e44 --- /dev/null +++ b/docs/@ceramic-sdk/model-instance-protocol/variables/DocumentDataEventHeader.md @@ -0,0 +1,21 @@ +[**@ceramic-sdk/model-instance-protocol v0.1.0**](../README.md) • **Docs** + +*** + +[Ceramic SDK](../../../README.md) / [@ceramic-sdk/model-instance-protocol](../README.md) / DocumentDataEventHeader + +# Variable: DocumentDataEventHeader + +> `const` **DocumentDataEventHeader**: `SparseCodec`\<`object`\> + +Data event header for a ModelInstanceDocument Stream + +## Type declaration + +### shouldIndex + +> **shouldIndex**: `OptionalCodec`\<`TrivialCodec`\<`boolean`\>\> + +## Defined in + +[packages/model-instance-protocol/src/codecs.ts:155](https://github.com/ceramicstudio/ceramic-sdk/blob/a220cbca7950f690af7f3d03a0023681bb9f5426/packages/model-instance-protocol/src/codecs.ts#L155) diff --git a/docs/@ceramic-sdk/model-instance-protocol/variables/DocumentDataEventPayload.md b/docs/@ceramic-sdk/model-instance-protocol/variables/DocumentDataEventPayload.md new file mode 100644 index 0000000..a3184e4 --- /dev/null +++ b/docs/@ceramic-sdk/model-instance-protocol/variables/DocumentDataEventPayload.md @@ -0,0 +1,33 @@ +[**@ceramic-sdk/model-instance-protocol v0.1.0**](../README.md) • **Docs** + +*** + +[Ceramic SDK](../../../README.md) / [@ceramic-sdk/model-instance-protocol](../README.md) / DocumentDataEventPayload + +# Variable: DocumentDataEventPayload + +> `const` **DocumentDataEventPayload**: `SparseCodec`\<`object`\> + +Data event payload for a ModelInstanceDocument Stream + +## Type declaration + +### data + +> **data**: `Codec`\<(`MapIn`\<`object`, `$TypeOf`\> \| `MapIn`\<`object`, `$TypeOf`\> \| `MapIn`\<`object`, `$TypeOf`\> \| `MapIn`\<`object`, `$TypeOf`\> \| `MapIn`\<`object`, `$TypeOf`\> \| `MapIn`\<`object`, `$TypeOf`\>)[], (`MapIn`\<`object`, `$OutputOf`\> \| `MapIn`\<`object`, `$OutputOf`\> \| `MapIn`\<`object`, `$OutputOf`\> \| `MapIn`\<`object`, `$OutputOf`\> \| `MapIn`\<`object`, `$OutputOf`\> \| `MapIn`\<`object`, `$OutputOf`\>)[], `unknown`\> & `object` + +### header + +> **header**: `OptionalCodec`\<`SparseCodec`\<`object`\>\> + +### id + +> **id**: `Type`\<`CID`\<`unknown`, `number`, `number`, `Version`\>, `CID`\<`unknown`, `number`, `number`, `Version`\>, `unknown`\> = `cid` + +### prev + +> **prev**: `Type`\<`CID`\<`unknown`, `number`, `number`, `Version`\>, `CID`\<`unknown`, `number`, `number`, `Version`\>, `unknown`\> = `cid` + +## Defined in + +[packages/model-instance-protocol/src/codecs.ts:166](https://github.com/ceramicstudio/ceramic-sdk/blob/a220cbca7950f690af7f3d03a0023681bb9f5426/packages/model-instance-protocol/src/codecs.ts#L166) diff --git a/docs/@ceramic-sdk/model-instance-protocol/variables/DocumentEvent.md b/docs/@ceramic-sdk/model-instance-protocol/variables/DocumentEvent.md new file mode 100644 index 0000000..1bad094 --- /dev/null +++ b/docs/@ceramic-sdk/model-instance-protocol/variables/DocumentEvent.md @@ -0,0 +1,15 @@ +[**@ceramic-sdk/model-instance-protocol v0.1.0**](../README.md) • **Docs** + +*** + +[Ceramic SDK](../../../README.md) / [@ceramic-sdk/model-instance-protocol](../README.md) / DocumentEvent + +# Variable: DocumentEvent + +> `const` **DocumentEvent**: `UnionCodec`\<[`SparseCodec`\<`object`\>, `SparseCodec`\<`object`\>, `ExactCodec`\<`TypeCodec`\<`object`\>\>]\> + +Document event: either a deterministic init event payload, a signed event or a time event. + +## Defined in + +[packages/model-instance-protocol/src/codecs.ts:211](https://github.com/ceramicstudio/ceramic-sdk/blob/a220cbca7950f690af7f3d03a0023681bb9f5426/packages/model-instance-protocol/src/codecs.ts#L211) diff --git a/docs/@ceramic-sdk/model-instance-protocol/variables/DocumentInitEventHeader.md b/docs/@ceramic-sdk/model-instance-protocol/variables/DocumentInitEventHeader.md new file mode 100644 index 0000000..a8bff90 --- /dev/null +++ b/docs/@ceramic-sdk/model-instance-protocol/variables/DocumentInitEventHeader.md @@ -0,0 +1,41 @@ +[**@ceramic-sdk/model-instance-protocol v0.1.0**](../README.md) • **Docs** + +*** + +[Ceramic SDK](../../../README.md) / [@ceramic-sdk/model-instance-protocol](../README.md) / DocumentInitEventHeader + +# Variable: DocumentInitEventHeader + +> `const` **DocumentInitEventHeader**: `SparseCodec`\<`object`\> + +Init event header for a ModelInstanceDocument Stream + +## Type declaration + +### context + +> **context**: `OptionalCodec`\<`Type`\<[`StreamID`](../../identifiers/classes/StreamID.md), `Uint8Array`, `Uint8Array`\>\> + +### controllers + +> **controllers**: `TupleCodec`\<[`RefinementCodec`\<`TrivialCodec`\<`string`\>, `string` & `WithOpaque`\<`"DIDString"`\>\>]\> + +### model + +> **model**: `Type`\<[`StreamID`](../../identifiers/classes/StreamID.md), `Uint8Array`, `Uint8Array`\> = `streamIDAsBytes` + +### sep + +> **sep**: `LiteralCodec`\<`"model"`\> + +### shouldIndex + +> **shouldIndex**: `OptionalCodec`\<`TrivialCodec`\<`boolean`\>\> + +### unique + +> **unique**: `OptionalCodec`\<`TrivialCodec`\<`Uint8Array`\>\> + +## Defined in + +[packages/model-instance-protocol/src/codecs.ts:101](https://github.com/ceramicstudio/ceramic-sdk/blob/a220cbca7950f690af7f3d03a0023681bb9f5426/packages/model-instance-protocol/src/codecs.ts#L101) diff --git a/docs/@ceramic-sdk/model-instance-protocol/variables/DocumentInitEventPayload.md b/docs/@ceramic-sdk/model-instance-protocol/variables/DocumentInitEventPayload.md new file mode 100644 index 0000000..cf054ca --- /dev/null +++ b/docs/@ceramic-sdk/model-instance-protocol/variables/DocumentInitEventPayload.md @@ -0,0 +1,15 @@ +[**@ceramic-sdk/model-instance-protocol v0.1.0**](../README.md) • **Docs** + +*** + +[Ceramic SDK](../../../README.md) / [@ceramic-sdk/model-instance-protocol](../README.md) / DocumentInitEventPayload + +# Variable: DocumentInitEventPayload + +> `const` **DocumentInitEventPayload**: `UnionCodec`\<[`SparseCodec`\<`object`\>, `SparseCodec`\<`object`\>]\> + +Init event payload for a ModelInstanceDocument Stream + +## Defined in + +[packages/model-instance-protocol/src/codecs.ts:146](https://github.com/ceramicstudio/ceramic-sdk/blob/a220cbca7950f690af7f3d03a0023681bb9f5426/packages/model-instance-protocol/src/codecs.ts#L146) diff --git a/docs/@ceramic-sdk/model-instance-protocol/variables/DocumentMetadata.md b/docs/@ceramic-sdk/model-instance-protocol/variables/DocumentMetadata.md new file mode 100644 index 0000000..679813c --- /dev/null +++ b/docs/@ceramic-sdk/model-instance-protocol/variables/DocumentMetadata.md @@ -0,0 +1,47 @@ +[**@ceramic-sdk/model-instance-protocol v0.1.0**](../README.md) • **Docs** + +*** + +[Ceramic SDK](../../../README.md) / [@ceramic-sdk/model-instance-protocol](../README.md) / DocumentMetadata + +# Variable: DocumentMetadata + +> `const` **DocumentMetadata**: `SparseCodec`\<`object`\> + +Metadata for a ModelInstanceDocument Stream + +## Type declaration + +### context + +> **context**: `OptionalCodec`\<`Type`\<[`StreamID`](../../identifiers/classes/StreamID.md), `string`, `string`\>\> + +The "context" StreamID for this ModelInstanceDocument. + +### controller + +> **controller**: `RefinementCodec`\<`TrivialCodec`\<`string`\>, `string` & `WithOpaque`\<`"DIDString"`\>\> = `didString` + +The DID that is allowed to author updates to this ModelInstanceDocument + +### model + +> **model**: `Type`\<[`StreamID`](../../identifiers/classes/StreamID.md), `string`, `string`\> = `streamIDAsString` + +The StreamID of the Model that this ModelInstanceDocument belongs to. + +### shouldIndex + +> **shouldIndex**: `OptionalCodec`\<`TrivialCodec`\<`boolean`\>\> + +Whether the stream should be indexed or not. + +### unique + +> **unique**: `OptionalCodec`\<`Type`\<`Uint8Array`, `string`, `string`\>\> + +Unique bytes + +## Defined in + +[packages/model-instance-protocol/src/codecs.ts:180](https://github.com/ceramicstudio/ceramic-sdk/blob/a220cbca7950f690af7f3d03a0023681bb9f5426/packages/model-instance-protocol/src/codecs.ts#L180) diff --git a/docs/@ceramic-sdk/model-instance-protocol/variables/JSONPatchAddOperation.md b/docs/@ceramic-sdk/model-instance-protocol/variables/JSONPatchAddOperation.md new file mode 100644 index 0000000..5548d05 --- /dev/null +++ b/docs/@ceramic-sdk/model-instance-protocol/variables/JSONPatchAddOperation.md @@ -0,0 +1,15 @@ +[**@ceramic-sdk/model-instance-protocol v0.1.0**](../README.md) • **Docs** + +*** + +[Ceramic SDK](../../../README.md) / [@ceramic-sdk/model-instance-protocol](../README.md) / JSONPatchAddOperation + +# Variable: JSONPatchAddOperation + +> `const` **JSONPatchAddOperation**: `ExactCodec`\<`TypeCodec`\<`object`\>\> + +JSON patch operations. + +## Defined in + +[packages/model-instance-protocol/src/codecs.ts:32](https://github.com/ceramicstudio/ceramic-sdk/blob/a220cbca7950f690af7f3d03a0023681bb9f5426/packages/model-instance-protocol/src/codecs.ts#L32) diff --git a/docs/@ceramic-sdk/model-instance-protocol/variables/JSONPatchCopyOperation.md b/docs/@ceramic-sdk/model-instance-protocol/variables/JSONPatchCopyOperation.md new file mode 100644 index 0000000..3c841d9 --- /dev/null +++ b/docs/@ceramic-sdk/model-instance-protocol/variables/JSONPatchCopyOperation.md @@ -0,0 +1,13 @@ +[**@ceramic-sdk/model-instance-protocol v0.1.0**](../README.md) • **Docs** + +*** + +[Ceramic SDK](../../../README.md) / [@ceramic-sdk/model-instance-protocol](../README.md) / JSONPatchCopyOperation + +# Variable: JSONPatchCopyOperation + +> `const` **JSONPatchCopyOperation**: `ExactCodec`\<`TypeCodec`\<`object`\>\> + +## Defined in + +[packages/model-instance-protocol/src/codecs.ts:67](https://github.com/ceramicstudio/ceramic-sdk/blob/a220cbca7950f690af7f3d03a0023681bb9f5426/packages/model-instance-protocol/src/codecs.ts#L67) diff --git a/docs/@ceramic-sdk/model-instance-protocol/variables/JSONPatchMoveOperation.md b/docs/@ceramic-sdk/model-instance-protocol/variables/JSONPatchMoveOperation.md new file mode 100644 index 0000000..28d7289 --- /dev/null +++ b/docs/@ceramic-sdk/model-instance-protocol/variables/JSONPatchMoveOperation.md @@ -0,0 +1,13 @@ +[**@ceramic-sdk/model-instance-protocol v0.1.0**](../README.md) • **Docs** + +*** + +[Ceramic SDK](../../../README.md) / [@ceramic-sdk/model-instance-protocol](../README.md) / JSONPatchMoveOperation + +# Variable: JSONPatchMoveOperation + +> `const` **JSONPatchMoveOperation**: `ExactCodec`\<`TypeCodec`\<`object`\>\> + +## Defined in + +[packages/model-instance-protocol/src/codecs.ts:58](https://github.com/ceramicstudio/ceramic-sdk/blob/a220cbca7950f690af7f3d03a0023681bb9f5426/packages/model-instance-protocol/src/codecs.ts#L58) diff --git a/docs/@ceramic-sdk/model-instance-protocol/variables/JSONPatchOperation.md b/docs/@ceramic-sdk/model-instance-protocol/variables/JSONPatchOperation.md new file mode 100644 index 0000000..2bc0483 --- /dev/null +++ b/docs/@ceramic-sdk/model-instance-protocol/variables/JSONPatchOperation.md @@ -0,0 +1,13 @@ +[**@ceramic-sdk/model-instance-protocol v0.1.0**](../README.md) • **Docs** + +*** + +[Ceramic SDK](../../../README.md) / [@ceramic-sdk/model-instance-protocol](../README.md) / JSONPatchOperation + +# Variable: JSONPatchOperation + +> `const` **JSONPatchOperation**: `UnionCodec`\<[`ExactCodec`\<`TypeCodec`\<`object`\>\>, `ExactCodec`\<`TypeCodec`\<`object`\>\>, `ExactCodec`\<`TypeCodec`\<`object`\>\>, `ExactCodec`\<`TypeCodec`\<`object`\>\>, `ExactCodec`\<`TypeCodec`\<`object`\>\>, `ExactCodec`\<`TypeCodec`\<`object`\>\>]\> + +## Defined in + +[packages/model-instance-protocol/src/codecs.ts:85](https://github.com/ceramicstudio/ceramic-sdk/blob/a220cbca7950f690af7f3d03a0023681bb9f5426/packages/model-instance-protocol/src/codecs.ts#L85) diff --git a/docs/@ceramic-sdk/model-instance-protocol/variables/JSONPatchRemoveOperation.md b/docs/@ceramic-sdk/model-instance-protocol/variables/JSONPatchRemoveOperation.md new file mode 100644 index 0000000..dcca0d2 --- /dev/null +++ b/docs/@ceramic-sdk/model-instance-protocol/variables/JSONPatchRemoveOperation.md @@ -0,0 +1,13 @@ +[**@ceramic-sdk/model-instance-protocol v0.1.0**](../README.md) • **Docs** + +*** + +[Ceramic SDK](../../../README.md) / [@ceramic-sdk/model-instance-protocol](../README.md) / JSONPatchRemoveOperation + +# Variable: JSONPatchRemoveOperation + +> `const` **JSONPatchRemoveOperation**: `ExactCodec`\<`TypeCodec`\<`object`\>\> + +## Defined in + +[packages/model-instance-protocol/src/codecs.ts:41](https://github.com/ceramicstudio/ceramic-sdk/blob/a220cbca7950f690af7f3d03a0023681bb9f5426/packages/model-instance-protocol/src/codecs.ts#L41) diff --git a/docs/@ceramic-sdk/model-instance-protocol/variables/JSONPatchReplaceOperation.md b/docs/@ceramic-sdk/model-instance-protocol/variables/JSONPatchReplaceOperation.md new file mode 100644 index 0000000..9d07ec8 --- /dev/null +++ b/docs/@ceramic-sdk/model-instance-protocol/variables/JSONPatchReplaceOperation.md @@ -0,0 +1,13 @@ +[**@ceramic-sdk/model-instance-protocol v0.1.0**](../README.md) • **Docs** + +*** + +[Ceramic SDK](../../../README.md) / [@ceramic-sdk/model-instance-protocol](../README.md) / JSONPatchReplaceOperation + +# Variable: JSONPatchReplaceOperation + +> `const` **JSONPatchReplaceOperation**: `ExactCodec`\<`TypeCodec`\<`object`\>\> + +## Defined in + +[packages/model-instance-protocol/src/codecs.ts:49](https://github.com/ceramicstudio/ceramic-sdk/blob/a220cbca7950f690af7f3d03a0023681bb9f5426/packages/model-instance-protocol/src/codecs.ts#L49) diff --git a/docs/@ceramic-sdk/model-instance-protocol/variables/JSONPatchTestOperation.md b/docs/@ceramic-sdk/model-instance-protocol/variables/JSONPatchTestOperation.md new file mode 100644 index 0000000..b721367 --- /dev/null +++ b/docs/@ceramic-sdk/model-instance-protocol/variables/JSONPatchTestOperation.md @@ -0,0 +1,13 @@ +[**@ceramic-sdk/model-instance-protocol v0.1.0**](../README.md) • **Docs** + +*** + +[Ceramic SDK](../../../README.md) / [@ceramic-sdk/model-instance-protocol](../README.md) / JSONPatchTestOperation + +# Variable: JSONPatchTestOperation + +> `const` **JSONPatchTestOperation**: `ExactCodec`\<`TypeCodec`\<`object`\>\> + +## Defined in + +[packages/model-instance-protocol/src/codecs.ts:76](https://github.com/ceramicstudio/ceramic-sdk/blob/a220cbca7950f690af7f3d03a0023681bb9f5426/packages/model-instance-protocol/src/codecs.ts#L76) 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 new file mode 100644 index 0000000..f356206 --- /dev/null +++ b/docs/@ceramic-sdk/model-instance-protocol/variables/MAX_DOCUMENT_SIZE.md @@ -0,0 +1,15 @@ +[**@ceramic-sdk/model-instance-protocol v0.1.0**](../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 + +## Defined in + +[packages/model-instance-protocol/src/constants.ts:4](https://github.com/ceramicstudio/ceramic-sdk/blob/a220cbca7950f690af7f3d03a0023681bb9f5426/packages/model-instance-protocol/src/constants.ts#L4) diff --git a/docs/@ceramic-sdk/model-protocol/README.md b/docs/@ceramic-sdk/model-protocol/README.md new file mode 100644 index 0000000..d88cc33 --- /dev/null +++ b/docs/@ceramic-sdk/model-protocol/README.md @@ -0,0 +1,65 @@ +**@ceramic-sdk/model-protocol v0.1.0** • **Docs** + +*** + +[Ceramic SDK](../../README.md) / @ceramic-sdk/model-protocol + +# @ceramic-sdk/model-protocol + +## Type Aliases + +- [ModelAccountRelation](type-aliases/ModelAccountRelation.md) +- [ModelAccountRelationV2](type-aliases/ModelAccountRelationV2.md) +- [ModelDefinition](type-aliases/ModelDefinition.md) +- [ModelDefinitionV1](type-aliases/ModelDefinitionV1.md) +- [ModelDefinitionV2](type-aliases/ModelDefinitionV2.md) +- [ModelDocumentMetadataViewDefinition](type-aliases/ModelDocumentMetadataViewDefinition.md) +- [ModelEvent](type-aliases/ModelEvent.md) +- [ModelEventHeader](type-aliases/ModelEventHeader.md) +- [ModelInitEventPayload](type-aliases/ModelInitEventPayload.md) +- [ModelMetadata](type-aliases/ModelMetadata.md) +- [ModelRelationDefinition](type-aliases/ModelRelationDefinition.md) +- [ModelRelationDefinitionV2](type-aliases/ModelRelationDefinitionV2.md) +- [ModelRelationsDefinition](type-aliases/ModelRelationsDefinition.md) +- [ModelRelationsDefinitionV2](type-aliases/ModelRelationsDefinitionV2.md) +- [ModelRelationViewDefinition](type-aliases/ModelRelationViewDefinition.md) +- [ModelRelationViewDefinitionV2](type-aliases/ModelRelationViewDefinitionV2.md) +- [ModelViewDefinition](type-aliases/ModelViewDefinition.md) +- [ModelViewDefinitionV2](type-aliases/ModelViewDefinitionV2.md) +- [ModelViewsDefinition](type-aliases/ModelViewsDefinition.md) +- [ModelViewsDefinitionV2](type-aliases/ModelViewsDefinitionV2.md) +- [ObjectSchema](type-aliases/ObjectSchema.md) +- [SchemaType](type-aliases/SchemaType.md) +- [ValidVersionSatisfies](type-aliases/ValidVersionSatisfies.md) + +## Variables + +- [MODEL](variables/MODEL.md) +- [MODEL\_STREAM\_ID](variables/MODEL_STREAM_ID.md) +- [ModelAccountRelation](variables/ModelAccountRelation.md) +- [ModelAccountRelationV2](variables/ModelAccountRelationV2.md) +- [ModelDefinition](variables/ModelDefinition.md) +- [ModelDefinitionV1](variables/ModelDefinitionV1.md) +- [ModelDefinitionV2](variables/ModelDefinitionV2.md) +- [ModelDocumentMetadataViewDefinition](variables/ModelDocumentMetadataViewDefinition.md) +- [ModelEvent](variables/ModelEvent.md) +- [ModelEventHeader](variables/ModelEventHeader.md) +- [ModelInitEventPayload](variables/ModelInitEventPayload.md) +- [ModelMetadata](variables/ModelMetadata.md) +- [ModelRelationDefinition](variables/ModelRelationDefinition.md) +- [ModelRelationDefinitionV2](variables/ModelRelationDefinitionV2.md) +- [ModelRelationsDefinition](variables/ModelRelationsDefinition.md) +- [ModelRelationsDefinitionV2](variables/ModelRelationsDefinitionV2.md) +- [ModelRelationViewDefinition](variables/ModelRelationViewDefinition.md) +- [ModelRelationViewDefinitionV2](variables/ModelRelationViewDefinitionV2.md) +- [ModelViewDefinition](variables/ModelViewDefinition.md) +- [ModelViewDefinitionV2](variables/ModelViewDefinitionV2.md) +- [ModelViewsDefinition](variables/ModelViewsDefinition.md) +- [ModelViewsDefinitionV2](variables/ModelViewsDefinitionV2.md) +- [ObjectSchema](variables/ObjectSchema.md) +- [optionalModelString](variables/optionalModelString.md) + +## 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 new file mode 100644 index 0000000..e54a7d5 --- /dev/null +++ b/docs/@ceramic-sdk/model-protocol/functions/assertValidModelContent.md @@ -0,0 +1,25 @@ +[**@ceramic-sdk/model-protocol v0.1.0**](../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` + +## Defined in + +[packages/model-protocol/src/assertions.ts:251](https://github.com/ceramicstudio/ceramic-sdk/blob/a220cbca7950f690af7f3d03a0023681bb9f5426/packages/model-protocol/src/assertions.ts#L251) diff --git a/docs/@ceramic-sdk/model-protocol/functions/getModelStreamID.md b/docs/@ceramic-sdk/model-protocol/functions/getModelStreamID.md new file mode 100644 index 0000000..4077d2f --- /dev/null +++ b/docs/@ceramic-sdk/model-protocol/functions/getModelStreamID.md @@ -0,0 +1,25 @@ +[**@ceramic-sdk/model-protocol v0.1.0**](../README.md) • **Docs** + +*** + +[Ceramic SDK](../../../README.md) / [@ceramic-sdk/model-protocol](../README.md) / getModelStreamID + +# Function: getModelStreamID() + +> **getModelStreamID**(`cid`): [`StreamID`](../../identifiers/classes/StreamID.md) + +Get a model StreamID from its init event CID + +## Parameters + +• **cid**: `CID`\<`unknown`, `number`, `number`, `Version`\> + +the CID of the init event + +## Returns + +[`StreamID`](../../identifiers/classes/StreamID.md) + +## Defined in + +[packages/model-protocol/src/stream-id.ts:10](https://github.com/ceramicstudio/ceramic-sdk/blob/a220cbca7950f690af7f3d03a0023681bb9f5426/packages/model-protocol/src/stream-id.ts#L10) diff --git a/docs/@ceramic-sdk/model-protocol/type-aliases/ModelAccountRelation.md b/docs/@ceramic-sdk/model-protocol/type-aliases/ModelAccountRelation.md new file mode 100644 index 0000000..e92cb40 --- /dev/null +++ b/docs/@ceramic-sdk/model-protocol/type-aliases/ModelAccountRelation.md @@ -0,0 +1,13 @@ +[**@ceramic-sdk/model-protocol v0.1.0**](../README.md) • **Docs** + +*** + +[Ceramic SDK](../../../README.md) / [@ceramic-sdk/model-protocol](../README.md) / ModelAccountRelation + +# Type Alias: ModelAccountRelation + +> **ModelAccountRelation**: `TypeOf`\<*typeof* [`ModelAccountRelation`](../variables/ModelAccountRelation.md)\> + +## Defined in + +[packages/model-protocol/src/codecs.ts:120](https://github.com/ceramicstudio/ceramic-sdk/blob/a220cbca7950f690af7f3d03a0023681bb9f5426/packages/model-protocol/src/codecs.ts#L120) diff --git a/docs/@ceramic-sdk/model-protocol/type-aliases/ModelAccountRelationV2.md b/docs/@ceramic-sdk/model-protocol/type-aliases/ModelAccountRelationV2.md new file mode 100644 index 0000000..43e58f3 --- /dev/null +++ b/docs/@ceramic-sdk/model-protocol/type-aliases/ModelAccountRelationV2.md @@ -0,0 +1,13 @@ +[**@ceramic-sdk/model-protocol v0.1.0**](../README.md) • **Docs** + +*** + +[Ceramic SDK](../../../README.md) / [@ceramic-sdk/model-protocol](../README.md) / ModelAccountRelationV2 + +# Type Alias: ModelAccountRelationV2 + +> **ModelAccountRelationV2**: `TypeOf`\<*typeof* [`ModelAccountRelationV2`](../variables/ModelAccountRelationV2.md)\> + +## Defined in + +[packages/model-protocol/src/codecs.ts:135](https://github.com/ceramicstudio/ceramic-sdk/blob/a220cbca7950f690af7f3d03a0023681bb9f5426/packages/model-protocol/src/codecs.ts#L135) diff --git a/docs/@ceramic-sdk/model-protocol/type-aliases/ModelDefinition.md b/docs/@ceramic-sdk/model-protocol/type-aliases/ModelDefinition.md new file mode 100644 index 0000000..98b05de --- /dev/null +++ b/docs/@ceramic-sdk/model-protocol/type-aliases/ModelDefinition.md @@ -0,0 +1,13 @@ +[**@ceramic-sdk/model-protocol v0.1.0**](../README.md) • **Docs** + +*** + +[Ceramic SDK](../../../README.md) / [@ceramic-sdk/model-protocol](../README.md) / ModelDefinition + +# Type Alias: ModelDefinition + +> **ModelDefinition**: `TypeOf`\<*typeof* [`ModelDefinition`](../variables/ModelDefinition.md)\> + +## Defined in + +[packages/model-protocol/src/codecs.ts:362](https://github.com/ceramicstudio/ceramic-sdk/blob/a220cbca7950f690af7f3d03a0023681bb9f5426/packages/model-protocol/src/codecs.ts#L362) diff --git a/docs/@ceramic-sdk/model-protocol/type-aliases/ModelDefinitionV1.md b/docs/@ceramic-sdk/model-protocol/type-aliases/ModelDefinitionV1.md new file mode 100644 index 0000000..4c5c5f4 --- /dev/null +++ b/docs/@ceramic-sdk/model-protocol/type-aliases/ModelDefinitionV1.md @@ -0,0 +1,13 @@ +[**@ceramic-sdk/model-protocol v0.1.0**](../README.md) • **Docs** + +*** + +[Ceramic SDK](../../../README.md) / [@ceramic-sdk/model-protocol](../README.md) / ModelDefinitionV1 + +# Type Alias: ModelDefinitionV1 + +> **ModelDefinitionV1**: `TypeOf`\<*typeof* [`ModelDefinitionV1`](../variables/ModelDefinitionV1.md)\> + +## Defined in + +[packages/model-protocol/src/codecs.ts:328](https://github.com/ceramicstudio/ceramic-sdk/blob/a220cbca7950f690af7f3d03a0023681bb9f5426/packages/model-protocol/src/codecs.ts#L328) diff --git a/docs/@ceramic-sdk/model-protocol/type-aliases/ModelDefinitionV2.md b/docs/@ceramic-sdk/model-protocol/type-aliases/ModelDefinitionV2.md new file mode 100644 index 0000000..0fb91fd --- /dev/null +++ b/docs/@ceramic-sdk/model-protocol/type-aliases/ModelDefinitionV2.md @@ -0,0 +1,13 @@ +[**@ceramic-sdk/model-protocol v0.1.0**](../README.md) • **Docs** + +*** + +[Ceramic SDK](../../../README.md) / [@ceramic-sdk/model-protocol](../README.md) / ModelDefinitionV2 + +# Type Alias: ModelDefinitionV2 + +> **ModelDefinitionV2**: `TypeOf`\<*typeof* [`ModelDefinitionV2`](../variables/ModelDefinitionV2.md)\> + +## Defined in + +[packages/model-protocol/src/codecs.ts:342](https://github.com/ceramicstudio/ceramic-sdk/blob/a220cbca7950f690af7f3d03a0023681bb9f5426/packages/model-protocol/src/codecs.ts#L342) diff --git a/docs/@ceramic-sdk/model-protocol/type-aliases/ModelDocumentMetadataViewDefinition.md b/docs/@ceramic-sdk/model-protocol/type-aliases/ModelDocumentMetadataViewDefinition.md new file mode 100644 index 0000000..d4e4ca4 --- /dev/null +++ b/docs/@ceramic-sdk/model-protocol/type-aliases/ModelDocumentMetadataViewDefinition.md @@ -0,0 +1,13 @@ +[**@ceramic-sdk/model-protocol v0.1.0**](../README.md) • **Docs** + +*** + +[Ceramic SDK](../../../README.md) / [@ceramic-sdk/model-protocol](../README.md) / ModelDocumentMetadataViewDefinition + +# Type Alias: ModelDocumentMetadataViewDefinition + +> **ModelDocumentMetadataViewDefinition**: `TypeOf`\<*typeof* [`ModelDocumentMetadataViewDefinition`](../variables/ModelDocumentMetadataViewDefinition.md)\> + +## Defined in + +[packages/model-protocol/src/codecs.ts:201](https://github.com/ceramicstudio/ceramic-sdk/blob/a220cbca7950f690af7f3d03a0023681bb9f5426/packages/model-protocol/src/codecs.ts#L201) diff --git a/docs/@ceramic-sdk/model-protocol/type-aliases/ModelEvent.md b/docs/@ceramic-sdk/model-protocol/type-aliases/ModelEvent.md new file mode 100644 index 0000000..a62014c --- /dev/null +++ b/docs/@ceramic-sdk/model-protocol/type-aliases/ModelEvent.md @@ -0,0 +1,13 @@ +[**@ceramic-sdk/model-protocol v0.1.0**](../README.md) • **Docs** + +*** + +[Ceramic SDK](../../../README.md) / [@ceramic-sdk/model-protocol](../README.md) / ModelEvent + +# Type Alias: ModelEvent + +> **ModelEvent**: `TypeOf`\<*typeof* [`ModelEvent`](../variables/ModelEvent.md)\> + +## Defined in + +[packages/model-protocol/src/codecs.ts:396](https://github.com/ceramicstudio/ceramic-sdk/blob/a220cbca7950f690af7f3d03a0023681bb9f5426/packages/model-protocol/src/codecs.ts#L396) diff --git a/docs/@ceramic-sdk/model-protocol/type-aliases/ModelEventHeader.md b/docs/@ceramic-sdk/model-protocol/type-aliases/ModelEventHeader.md new file mode 100644 index 0000000..1b1cac3 --- /dev/null +++ b/docs/@ceramic-sdk/model-protocol/type-aliases/ModelEventHeader.md @@ -0,0 +1,13 @@ +[**@ceramic-sdk/model-protocol v0.1.0**](../README.md) • **Docs** + +*** + +[Ceramic SDK](../../../README.md) / [@ceramic-sdk/model-protocol](../README.md) / ModelEventHeader + +# Type Alias: ModelEventHeader + +> **ModelEventHeader**: `TypeOf`\<*typeof* [`ModelEventHeader`](../variables/ModelEventHeader.md)\> + +## Defined in + +[packages/model-protocol/src/codecs.ts:371](https://github.com/ceramicstudio/ceramic-sdk/blob/a220cbca7950f690af7f3d03a0023681bb9f5426/packages/model-protocol/src/codecs.ts#L371) diff --git a/docs/@ceramic-sdk/model-protocol/type-aliases/ModelInitEventPayload.md b/docs/@ceramic-sdk/model-protocol/type-aliases/ModelInitEventPayload.md new file mode 100644 index 0000000..aeea199 --- /dev/null +++ b/docs/@ceramic-sdk/model-protocol/type-aliases/ModelInitEventPayload.md @@ -0,0 +1,13 @@ +[**@ceramic-sdk/model-protocol v0.1.0**](../README.md) • **Docs** + +*** + +[Ceramic SDK](../../../README.md) / [@ceramic-sdk/model-protocol](../README.md) / ModelInitEventPayload + +# Type Alias: ModelInitEventPayload + +> **ModelInitEventPayload**: `TypeOf`\<*typeof* [`ModelInitEventPayload`](../variables/ModelInitEventPayload.md)\> + +## Defined in + +[packages/model-protocol/src/codecs.ts:384](https://github.com/ceramicstudio/ceramic-sdk/blob/a220cbca7950f690af7f3d03a0023681bb9f5426/packages/model-protocol/src/codecs.ts#L384) diff --git a/docs/@ceramic-sdk/model-protocol/type-aliases/ModelMetadata.md b/docs/@ceramic-sdk/model-protocol/type-aliases/ModelMetadata.md new file mode 100644 index 0000000..ecd3f06 --- /dev/null +++ b/docs/@ceramic-sdk/model-protocol/type-aliases/ModelMetadata.md @@ -0,0 +1,13 @@ +[**@ceramic-sdk/model-protocol v0.1.0**](../README.md) • **Docs** + +*** + +[Ceramic SDK](../../../README.md) / [@ceramic-sdk/model-protocol](../README.md) / ModelMetadata + +# Type Alias: ModelMetadata + +> **ModelMetadata**: `TypeOf`\<*typeof* [`ModelMetadata`](../variables/ModelMetadata.md)\> + +## Defined in + +[packages/model-protocol/src/codecs.ts:99](https://github.com/ceramicstudio/ceramic-sdk/blob/a220cbca7950f690af7f3d03a0023681bb9f5426/packages/model-protocol/src/codecs.ts#L99) diff --git a/docs/@ceramic-sdk/model-protocol/type-aliases/ModelRelationDefinition.md b/docs/@ceramic-sdk/model-protocol/type-aliases/ModelRelationDefinition.md new file mode 100644 index 0000000..a475df3 --- /dev/null +++ b/docs/@ceramic-sdk/model-protocol/type-aliases/ModelRelationDefinition.md @@ -0,0 +1,13 @@ +[**@ceramic-sdk/model-protocol v0.1.0**](../README.md) • **Docs** + +*** + +[Ceramic SDK](../../../README.md) / [@ceramic-sdk/model-protocol](../README.md) / ModelRelationDefinition + +# Type Alias: ModelRelationDefinition + +> **ModelRelationDefinition**: `TypeOf`\<*typeof* [`ModelRelationDefinition`](../variables/ModelRelationDefinition.md)\> + +## Defined in + +[packages/model-protocol/src/codecs.ts:154](https://github.com/ceramicstudio/ceramic-sdk/blob/a220cbca7950f690af7f3d03a0023681bb9f5426/packages/model-protocol/src/codecs.ts#L154) diff --git a/docs/@ceramic-sdk/model-protocol/type-aliases/ModelRelationDefinitionV2.md b/docs/@ceramic-sdk/model-protocol/type-aliases/ModelRelationDefinitionV2.md new file mode 100644 index 0000000..178168f --- /dev/null +++ b/docs/@ceramic-sdk/model-protocol/type-aliases/ModelRelationDefinitionV2.md @@ -0,0 +1,13 @@ +[**@ceramic-sdk/model-protocol v0.1.0**](../README.md) • **Docs** + +*** + +[Ceramic SDK](../../../README.md) / [@ceramic-sdk/model-protocol](../README.md) / ModelRelationDefinitionV2 + +# Type Alias: ModelRelationDefinitionV2 + +> **ModelRelationDefinitionV2**: `TypeOf`\<*typeof* [`ModelRelationDefinitionV2`](../variables/ModelRelationDefinitionV2.md)\> + +## Defined in + +[packages/model-protocol/src/codecs.ts:171](https://github.com/ceramicstudio/ceramic-sdk/blob/a220cbca7950f690af7f3d03a0023681bb9f5426/packages/model-protocol/src/codecs.ts#L171) diff --git a/docs/@ceramic-sdk/model-protocol/type-aliases/ModelRelationViewDefinition.md b/docs/@ceramic-sdk/model-protocol/type-aliases/ModelRelationViewDefinition.md new file mode 100644 index 0000000..f6ad237 --- /dev/null +++ b/docs/@ceramic-sdk/model-protocol/type-aliases/ModelRelationViewDefinition.md @@ -0,0 +1,13 @@ +[**@ceramic-sdk/model-protocol v0.1.0**](../README.md) • **Docs** + +*** + +[Ceramic SDK](../../../README.md) / [@ceramic-sdk/model-protocol](../README.md) / ModelRelationViewDefinition + +# Type Alias: ModelRelationViewDefinition + +> **ModelRelationViewDefinition**: `TypeOf`\<*typeof* [`ModelRelationViewDefinition`](../variables/ModelRelationViewDefinition.md)\> + +## Defined in + +[packages/model-protocol/src/codecs.ts:212](https://github.com/ceramicstudio/ceramic-sdk/blob/a220cbca7950f690af7f3d03a0023681bb9f5426/packages/model-protocol/src/codecs.ts#L212) diff --git a/docs/@ceramic-sdk/model-protocol/type-aliases/ModelRelationViewDefinitionV2.md b/docs/@ceramic-sdk/model-protocol/type-aliases/ModelRelationViewDefinitionV2.md new file mode 100644 index 0000000..875e24f --- /dev/null +++ b/docs/@ceramic-sdk/model-protocol/type-aliases/ModelRelationViewDefinitionV2.md @@ -0,0 +1,13 @@ +[**@ceramic-sdk/model-protocol v0.1.0**](../README.md) • **Docs** + +*** + +[Ceramic SDK](../../../README.md) / [@ceramic-sdk/model-protocol](../README.md) / ModelRelationViewDefinitionV2 + +# Type Alias: ModelRelationViewDefinitionV2 + +> **ModelRelationViewDefinitionV2**: `TypeOf`\<*typeof* [`ModelRelationViewDefinitionV2`](../variables/ModelRelationViewDefinitionV2.md)\> + +## Defined in + +[packages/model-protocol/src/codecs.ts:236](https://github.com/ceramicstudio/ceramic-sdk/blob/a220cbca7950f690af7f3d03a0023681bb9f5426/packages/model-protocol/src/codecs.ts#L236) diff --git a/docs/@ceramic-sdk/model-protocol/type-aliases/ModelRelationsDefinition.md b/docs/@ceramic-sdk/model-protocol/type-aliases/ModelRelationsDefinition.md new file mode 100644 index 0000000..a20808b --- /dev/null +++ b/docs/@ceramic-sdk/model-protocol/type-aliases/ModelRelationsDefinition.md @@ -0,0 +1,13 @@ +[**@ceramic-sdk/model-protocol v0.1.0**](../README.md) • **Docs** + +*** + +[Ceramic SDK](../../../README.md) / [@ceramic-sdk/model-protocol](../README.md) / ModelRelationsDefinition + +# Type Alias: ModelRelationsDefinition + +> **ModelRelationsDefinition**: `TypeOf`\<*typeof* [`ModelRelationsDefinition`](../variables/ModelRelationsDefinition.md)\> + +## Defined in + +[packages/model-protocol/src/codecs.ts:185](https://github.com/ceramicstudio/ceramic-sdk/blob/a220cbca7950f690af7f3d03a0023681bb9f5426/packages/model-protocol/src/codecs.ts#L185) diff --git a/docs/@ceramic-sdk/model-protocol/type-aliases/ModelRelationsDefinitionV2.md b/docs/@ceramic-sdk/model-protocol/type-aliases/ModelRelationsDefinitionV2.md new file mode 100644 index 0000000..e2d5824 --- /dev/null +++ b/docs/@ceramic-sdk/model-protocol/type-aliases/ModelRelationsDefinitionV2.md @@ -0,0 +1,13 @@ +[**@ceramic-sdk/model-protocol v0.1.0**](../README.md) • **Docs** + +*** + +[Ceramic SDK](../../../README.md) / [@ceramic-sdk/model-protocol](../README.md) / ModelRelationsDefinitionV2 + +# Type Alias: ModelRelationsDefinitionV2 + +> **ModelRelationsDefinitionV2**: `TypeOf`\<*typeof* [`ModelRelationsDefinitionV2`](../variables/ModelRelationsDefinitionV2.md)\> + +## Defined in + +[packages/model-protocol/src/codecs.ts:192](https://github.com/ceramicstudio/ceramic-sdk/blob/a220cbca7950f690af7f3d03a0023681bb9f5426/packages/model-protocol/src/codecs.ts#L192) diff --git a/docs/@ceramic-sdk/model-protocol/type-aliases/ModelViewDefinition.md b/docs/@ceramic-sdk/model-protocol/type-aliases/ModelViewDefinition.md new file mode 100644 index 0000000..5787819 --- /dev/null +++ b/docs/@ceramic-sdk/model-protocol/type-aliases/ModelViewDefinition.md @@ -0,0 +1,13 @@ +[**@ceramic-sdk/model-protocol v0.1.0**](../README.md) • **Docs** + +*** + +[Ceramic SDK](../../../README.md) / [@ceramic-sdk/model-protocol](../README.md) / ModelViewDefinition + +# Type Alias: ModelViewDefinition + +> **ModelViewDefinition**: `TypeOf`\<*typeof* [`ModelViewDefinition`](../variables/ModelViewDefinition.md)\> + +## Defined in + +[packages/model-protocol/src/codecs.ts:278](https://github.com/ceramicstudio/ceramic-sdk/blob/a220cbca7950f690af7f3d03a0023681bb9f5426/packages/model-protocol/src/codecs.ts#L278) diff --git a/docs/@ceramic-sdk/model-protocol/type-aliases/ModelViewDefinitionV2.md b/docs/@ceramic-sdk/model-protocol/type-aliases/ModelViewDefinitionV2.md new file mode 100644 index 0000000..d8b7e55 --- /dev/null +++ b/docs/@ceramic-sdk/model-protocol/type-aliases/ModelViewDefinitionV2.md @@ -0,0 +1,13 @@ +[**@ceramic-sdk/model-protocol v0.1.0**](../README.md) • **Docs** + +*** + +[Ceramic SDK](../../../README.md) / [@ceramic-sdk/model-protocol](../README.md) / ModelViewDefinitionV2 + +# Type Alias: ModelViewDefinitionV2 + +> **ModelViewDefinitionV2**: `TypeOf`\<*typeof* [`ModelViewDefinitionV2`](../variables/ModelViewDefinitionV2.md)\> + +## Defined in + +[packages/model-protocol/src/codecs.ts:298](https://github.com/ceramicstudio/ceramic-sdk/blob/a220cbca7950f690af7f3d03a0023681bb9f5426/packages/model-protocol/src/codecs.ts#L298) diff --git a/docs/@ceramic-sdk/model-protocol/type-aliases/ModelViewsDefinition.md b/docs/@ceramic-sdk/model-protocol/type-aliases/ModelViewsDefinition.md new file mode 100644 index 0000000..c0270a5 --- /dev/null +++ b/docs/@ceramic-sdk/model-protocol/type-aliases/ModelViewsDefinition.md @@ -0,0 +1,13 @@ +[**@ceramic-sdk/model-protocol v0.1.0**](../README.md) • **Docs** + +*** + +[Ceramic SDK](../../../README.md) / [@ceramic-sdk/model-protocol](../README.md) / ModelViewsDefinition + +# Type Alias: ModelViewsDefinition + +> **ModelViewsDefinition**: `TypeOf`\<*typeof* [`ModelViewsDefinition`](../variables/ModelViewsDefinition.md)\> + +## Defined in + +[packages/model-protocol/src/codecs.ts:309](https://github.com/ceramicstudio/ceramic-sdk/blob/a220cbca7950f690af7f3d03a0023681bb9f5426/packages/model-protocol/src/codecs.ts#L309) diff --git a/docs/@ceramic-sdk/model-protocol/type-aliases/ModelViewsDefinitionV2.md b/docs/@ceramic-sdk/model-protocol/type-aliases/ModelViewsDefinitionV2.md new file mode 100644 index 0000000..22097a7 --- /dev/null +++ b/docs/@ceramic-sdk/model-protocol/type-aliases/ModelViewsDefinitionV2.md @@ -0,0 +1,13 @@ +[**@ceramic-sdk/model-protocol v0.1.0**](../README.md) • **Docs** + +*** + +[Ceramic SDK](../../../README.md) / [@ceramic-sdk/model-protocol](../README.md) / ModelViewsDefinitionV2 + +# Type Alias: ModelViewsDefinitionV2 + +> **ModelViewsDefinitionV2**: `TypeOf`\<*typeof* [`ModelViewsDefinitionV2`](../variables/ModelViewsDefinitionV2.md)\> + +## Defined in + +[packages/model-protocol/src/codecs.ts:321](https://github.com/ceramicstudio/ceramic-sdk/blob/a220cbca7950f690af7f3d03a0023681bb9f5426/packages/model-protocol/src/codecs.ts#L321) diff --git a/docs/@ceramic-sdk/model-protocol/type-aliases/ObjectSchema.md b/docs/@ceramic-sdk/model-protocol/type-aliases/ObjectSchema.md new file mode 100644 index 0000000..f146c99 --- /dev/null +++ b/docs/@ceramic-sdk/model-protocol/type-aliases/ObjectSchema.md @@ -0,0 +1,13 @@ +[**@ceramic-sdk/model-protocol v0.1.0**](../README.md) • **Docs** + +*** + +[Ceramic SDK](../../../README.md) / [@ceramic-sdk/model-protocol](../README.md) / ObjectSchema + +# Type Alias: ObjectSchema + +> **ObjectSchema**: `TypeOf`\<*typeof* [`ObjectSchema`](../variables/ObjectSchema.md)\> + +## Defined in + +[packages/model-protocol/src/codecs.ts:88](https://github.com/ceramicstudio/ceramic-sdk/blob/a220cbca7950f690af7f3d03a0023681bb9f5426/packages/model-protocol/src/codecs.ts#L88) diff --git a/docs/@ceramic-sdk/model-protocol/type-aliases/SchemaType.md b/docs/@ceramic-sdk/model-protocol/type-aliases/SchemaType.md new file mode 100644 index 0000000..47eebdd --- /dev/null +++ b/docs/@ceramic-sdk/model-protocol/type-aliases/SchemaType.md @@ -0,0 +1,13 @@ +[**@ceramic-sdk/model-protocol v0.1.0**](../README.md) • **Docs** + +*** + +[Ceramic SDK](../../../README.md) / [@ceramic-sdk/model-protocol](../README.md) / SchemaType + +# Type Alias: SchemaType + +> **SchemaType**: `JSONSchema.Boolean` \| `JSONSchema.Integer` \| `JSONSchema.Number` \| `JSONSchema.String` \| `JSONSchema.Array` \| `JSONSchema.Object` + +## Defined in + +[packages/model-protocol/src/codecs.ts:44](https://github.com/ceramicstudio/ceramic-sdk/blob/a220cbca7950f690af7f3d03a0023681bb9f5426/packages/model-protocol/src/codecs.ts#L44) diff --git a/docs/@ceramic-sdk/model-protocol/type-aliases/ValidVersionSatisfies.md b/docs/@ceramic-sdk/model-protocol/type-aliases/ValidVersionSatisfies.md new file mode 100644 index 0000000..5e407f7 --- /dev/null +++ b/docs/@ceramic-sdk/model-protocol/type-aliases/ValidVersionSatisfies.md @@ -0,0 +1,17 @@ +[**@ceramic-sdk/model-protocol v0.1.0**](../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 + +## Defined in + +[packages/model-protocol/src/assertions.ts:49](https://github.com/ceramicstudio/ceramic-sdk/blob/a220cbca7950f690af7f3d03a0023681bb9f5426/packages/model-protocol/src/assertions.ts#L49) diff --git a/docs/@ceramic-sdk/model-protocol/variables/MODEL.md b/docs/@ceramic-sdk/model-protocol/variables/MODEL.md new file mode 100644 index 0000000..60a4093 --- /dev/null +++ b/docs/@ceramic-sdk/model-protocol/variables/MODEL.md @@ -0,0 +1,13 @@ +[**@ceramic-sdk/model-protocol v0.1.0**](../README.md) • **Docs** + +*** + +[Ceramic SDK](../../../README.md) / [@ceramic-sdk/model-protocol](../README.md) / MODEL + +# Variable: MODEL + +> `const` **MODEL**: [`StreamID`](../../identifiers/classes/StreamID.md) + +## Defined in + +[packages/model-protocol/src/constants.ts:9](https://github.com/ceramicstudio/ceramic-sdk/blob/a220cbca7950f690af7f3d03a0023681bb9f5426/packages/model-protocol/src/constants.ts#L9) diff --git a/docs/@ceramic-sdk/model-protocol/variables/MODEL_STREAM_ID.md b/docs/@ceramic-sdk/model-protocol/variables/MODEL_STREAM_ID.md new file mode 100644 index 0000000..df1d612 --- /dev/null +++ b/docs/@ceramic-sdk/model-protocol/variables/MODEL_STREAM_ID.md @@ -0,0 +1,17 @@ +[**@ceramic-sdk/model-protocol v0.1.0**](../README.md) • **Docs** + +*** + +[Ceramic SDK](../../../README.md) / [@ceramic-sdk/model-protocol](../README.md) / MODEL\_STREAM\_ID + +# Variable: MODEL\_STREAM\_ID + +> `const` **MODEL\_STREAM\_ID**: `"kh4q0ozorrgaq2mezktnrmdwleo1d"` = `'kh4q0ozorrgaq2mezktnrmdwleo1d'` + +The hardcoded "model" StreamID that all Model streams have in their metadata. This provides +a "model" StreamID that can be indexed to query the set of all published Models. +The StreamID uses the "UNLOADABLE" StreamType, and has string representation: "kh4q0ozorrgaq2mezktnrmdwleo1d" + +## Defined in + +[packages/model-protocol/src/constants.ts:8](https://github.com/ceramicstudio/ceramic-sdk/blob/a220cbca7950f690af7f3d03a0023681bb9f5426/packages/model-protocol/src/constants.ts#L8) diff --git a/docs/@ceramic-sdk/model-protocol/variables/ModelAccountRelation.md b/docs/@ceramic-sdk/model-protocol/variables/ModelAccountRelation.md new file mode 100644 index 0000000..ab9b47c --- /dev/null +++ b/docs/@ceramic-sdk/model-protocol/variables/ModelAccountRelation.md @@ -0,0 +1,18 @@ +[**@ceramic-sdk/model-protocol v0.1.0**](../README.md) • **Docs** + +*** + +[Ceramic SDK](../../../README.md) / [@ceramic-sdk/model-protocol](../README.md) / ModelAccountRelation + +# Variable: ModelAccountRelation + +> `const` **ModelAccountRelation**: `UnionCodec`\<[`ExactCodec`\<`TypeCodec`\<`object`\>\>, `ExactCodec`\<`TypeCodec`\<`object`\>\>]\> + +Represents the relationship between an instance of this model and the controller account. +'list' means there can be many instances of this model for a single account. 'single' means +there can be only one instance of this model per account (if a new instance is created it +overrides the old one). + +## Defined in + +[packages/model-protocol/src/codecs.ts:120](https://github.com/ceramicstudio/ceramic-sdk/blob/a220cbca7950f690af7f3d03a0023681bb9f5426/packages/model-protocol/src/codecs.ts#L120) diff --git a/docs/@ceramic-sdk/model-protocol/variables/ModelAccountRelationV2.md b/docs/@ceramic-sdk/model-protocol/variables/ModelAccountRelationV2.md new file mode 100644 index 0000000..b96cdef --- /dev/null +++ b/docs/@ceramic-sdk/model-protocol/variables/ModelAccountRelationV2.md @@ -0,0 +1,20 @@ +[**@ceramic-sdk/model-protocol v0.1.0**](../README.md) • **Docs** + +*** + +[Ceramic SDK](../../../README.md) / [@ceramic-sdk/model-protocol](../README.md) / ModelAccountRelationV2 + +# Variable: ModelAccountRelationV2 + +> `const` **ModelAccountRelationV2**: `UnionCodec`\<[`ExactCodec`\<`TypeCodec`\<`object`\>\>, `ExactCodec`\<`TypeCodec`\<`object`\>\>, `ExactCodec`\<`TypeCodec`\<`object`\>\>, `ExactCodec`\<`TypeCodec`\<`object`\>\>]\> + +Represents the relationship between an instance of this model and the controller account: +- 'list' means there can be many instances of this model for a single account +- 'single' means there can be only one instance of this model per account (if a new instance is created it +overrides the old one) +- 'none' means there can be no instance associated to an account (for interfaces notably) +- 'set' means there can be only one instance of this model per account and value of the specified content 'fields' + +## Defined in + +[packages/model-protocol/src/codecs.ts:135](https://github.com/ceramicstudio/ceramic-sdk/blob/a220cbca7950f690af7f3d03a0023681bb9f5426/packages/model-protocol/src/codecs.ts#L135) diff --git a/docs/@ceramic-sdk/model-protocol/variables/ModelDefinition.md b/docs/@ceramic-sdk/model-protocol/variables/ModelDefinition.md new file mode 100644 index 0000000..df207f6 --- /dev/null +++ b/docs/@ceramic-sdk/model-protocol/variables/ModelDefinition.md @@ -0,0 +1,15 @@ +[**@ceramic-sdk/model-protocol v0.1.0**](../README.md) • **Docs** + +*** + +[Ceramic SDK](../../../README.md) / [@ceramic-sdk/model-protocol](../README.md) / ModelDefinition + +# Variable: ModelDefinition + +> `const` **ModelDefinition**: `UnionCodec`\<[`SparseCodec`\<`object`\>, `SparseCodec`\<`object`\>]\> + +Contents of a Model Stream. + +## Defined in + +[packages/model-protocol/src/codecs.ts:362](https://github.com/ceramicstudio/ceramic-sdk/blob/a220cbca7950f690af7f3d03a0023681bb9f5426/packages/model-protocol/src/codecs.ts#L362) diff --git a/docs/@ceramic-sdk/model-protocol/variables/ModelDefinitionV1.md b/docs/@ceramic-sdk/model-protocol/variables/ModelDefinitionV1.md new file mode 100644 index 0000000..c36bd47 --- /dev/null +++ b/docs/@ceramic-sdk/model-protocol/variables/ModelDefinitionV1.md @@ -0,0 +1,43 @@ +[**@ceramic-sdk/model-protocol v0.1.0**](../README.md) • **Docs** + +*** + +[Ceramic SDK](../../../README.md) / [@ceramic-sdk/model-protocol](../README.md) / ModelDefinitionV1 + +# Variable: ModelDefinitionV1 + +> `const` **ModelDefinitionV1**: `SparseCodec`\<`object`\> + +## Type declaration + +### accountRelation + +> **accountRelation**: `UnionCodec`\<[`ExactCodec`\<`TypeCodec`\<`object`\>\>, `ExactCodec`\<`TypeCodec`\<`object`\>\>]\> = `ModelAccountRelation` + +### description + +> **description**: `OptionalCodec`\<`TrivialCodec`\<`string`\>\> + +### name + +> **name**: `TrivialCodec`\<`string`\> = `string` + +### relations + +> **relations**: `OptionalCodec`\<`NonEnumerableRecordCodec`\<`TrivialCodec`\<`string`\>, `UnionCodec`\<[`ExactCodec`\<`TypeCodec`\<`object`\>\>, `ExactCodec`\<`TypeCodec`\<`object`\>\>]\>\>\> + +### schema + +> **schema**: `Type`\<`Object`\<`any`\>, `Object`\<`any`\>, `unknown`\> = `ObjectSchema` + +### version + +> **version**: `LiteralCodec`\<`"1.0"`\> + +### views + +> **views**: `OptionalCodec`\<`NonEnumerableRecordCodec`\<`TrivialCodec`\<`string`\>, `UnionCodec`\<[`UnionCodec`\<[`ExactCodec`\<`TypeCodec`\<`object`\>\>, `ExactCodec`\<`TypeCodec`\<`object`\>\>]\>, `UnionCodec`\<[`ExactCodec`\<`TypeCodec`\<`object`\>\>, `ExactCodec`\<`TypeCodec`\<`object`\>\>, `ExactCodec`\<`TypeCodec`\<`object`\>\>]\>]\>\>\> + +## Defined in + +[packages/model-protocol/src/codecs.ts:328](https://github.com/ceramicstudio/ceramic-sdk/blob/a220cbca7950f690af7f3d03a0023681bb9f5426/packages/model-protocol/src/codecs.ts#L328) diff --git a/docs/@ceramic-sdk/model-protocol/variables/ModelDefinitionV2.md b/docs/@ceramic-sdk/model-protocol/variables/ModelDefinitionV2.md new file mode 100644 index 0000000..8b60b55 --- /dev/null +++ b/docs/@ceramic-sdk/model-protocol/variables/ModelDefinitionV2.md @@ -0,0 +1,55 @@ +[**@ceramic-sdk/model-protocol v0.1.0**](../README.md) • **Docs** + +*** + +[Ceramic SDK](../../../README.md) / [@ceramic-sdk/model-protocol](../README.md) / ModelDefinitionV2 + +# Variable: ModelDefinitionV2 + +> `const` **ModelDefinitionV2**: `SparseCodec`\<`object`\> + +## Type declaration + +### accountRelation + +> **accountRelation**: `UnionCodec`\<[`ExactCodec`\<`TypeCodec`\<`object`\>\>, `ExactCodec`\<`TypeCodec`\<`object`\>\>, `ExactCodec`\<`TypeCodec`\<`object`\>\>, `ExactCodec`\<`TypeCodec`\<`object`\>\>]\> = `ModelAccountRelationV2` + +### description + +> **description**: `OptionalCodec`\<`TrivialCodec`\<`string`\>\> + +### immutableFields + +> **immutableFields**: `OptionalCodec`\<`Codec`\<`string`[], `string`[], `unknown`\> & `object`\> + +### implements + +> **implements**: `Codec`\<`string`[], `string`[], `unknown`\> & `object` + +### interface + +> **interface**: `TrivialCodec`\<`boolean`\> = `boolean` + +### name + +> **name**: `TrivialCodec`\<`string`\> = `string` + +### relations + +> **relations**: `OptionalCodec`\<`NonEnumerableRecordCodec`\<`TrivialCodec`\<`string`\>, `UnionCodec`\<[`ExactCodec`\<`TypeCodec`\<`object`\>\>, `ExactCodec`\<`TypeCodec`\<`object`\>\>]\>\>\> + +### schema + +> **schema**: `Type`\<`Object`\<`any`\>, `Object`\<`any`\>, `unknown`\> = `ObjectSchema` + +### version + +> **version**: `LiteralCodec`\<`"2.0"`\> + +### views + +> **views**: `OptionalCodec`\<`NonEnumerableRecordCodec`\<`TrivialCodec`\<`string`\>, `UnionCodec`\<[`UnionCodec`\<[`ExactCodec`\<`TypeCodec`\<`object`\>\>, `ExactCodec`\<`TypeCodec`\<`object`\>\>]\>, `UnionCodec`\<[`ExactCodec`\<`TypeCodec`\<`object`\>\>, `ExactCodec`\<`TypeCodec`\<`object`\>\>, `ExactCodec`\<`TypeCodec`\<`object`\>\>, `ExactCodec`\<`TypeCodec`\<`object`\>\>]\>]\>\>\> + +## Defined in + +[packages/model-protocol/src/codecs.ts:342](https://github.com/ceramicstudio/ceramic-sdk/blob/a220cbca7950f690af7f3d03a0023681bb9f5426/packages/model-protocol/src/codecs.ts#L342) diff --git a/docs/@ceramic-sdk/model-protocol/variables/ModelDocumentMetadataViewDefinition.md b/docs/@ceramic-sdk/model-protocol/variables/ModelDocumentMetadataViewDefinition.md new file mode 100644 index 0000000..bb3bff0 --- /dev/null +++ b/docs/@ceramic-sdk/model-protocol/variables/ModelDocumentMetadataViewDefinition.md @@ -0,0 +1,13 @@ +[**@ceramic-sdk/model-protocol v0.1.0**](../README.md) • **Docs** + +*** + +[Ceramic SDK](../../../README.md) / [@ceramic-sdk/model-protocol](../README.md) / ModelDocumentMetadataViewDefinition + +# Variable: ModelDocumentMetadataViewDefinition + +> `const` **ModelDocumentMetadataViewDefinition**: `UnionCodec`\<[`ExactCodec`\<`TypeCodec`\<`object`\>\>, `ExactCodec`\<`TypeCodec`\<`object`\>\>]\> + +## Defined in + +[packages/model-protocol/src/codecs.ts:201](https://github.com/ceramicstudio/ceramic-sdk/blob/a220cbca7950f690af7f3d03a0023681bb9f5426/packages/model-protocol/src/codecs.ts#L201) diff --git a/docs/@ceramic-sdk/model-protocol/variables/ModelEvent.md b/docs/@ceramic-sdk/model-protocol/variables/ModelEvent.md new file mode 100644 index 0000000..19bb50b --- /dev/null +++ b/docs/@ceramic-sdk/model-protocol/variables/ModelEvent.md @@ -0,0 +1,15 @@ +[**@ceramic-sdk/model-protocol v0.1.0**](../README.md) • **Docs** + +*** + +[Ceramic SDK](../../../README.md) / [@ceramic-sdk/model-protocol](../README.md) / ModelEvent + +# Variable: ModelEvent + +> `const` **ModelEvent**: `UnionCodec`\<[`SparseCodec`\<`object`\>, `ExactCodec`\<`TypeCodec`\<`object`\>\>]\> + +Model event: either a signed event or a time event. + +## Defined in + +[packages/model-protocol/src/codecs.ts:396](https://github.com/ceramicstudio/ceramic-sdk/blob/a220cbca7950f690af7f3d03a0023681bb9f5426/packages/model-protocol/src/codecs.ts#L396) diff --git a/docs/@ceramic-sdk/model-protocol/variables/ModelEventHeader.md b/docs/@ceramic-sdk/model-protocol/variables/ModelEventHeader.md new file mode 100644 index 0000000..a860475 --- /dev/null +++ b/docs/@ceramic-sdk/model-protocol/variables/ModelEventHeader.md @@ -0,0 +1,15 @@ +[**@ceramic-sdk/model-protocol v0.1.0**](../README.md) • **Docs** + +*** + +[Ceramic SDK](../../../README.md) / [@ceramic-sdk/model-protocol](../README.md) / ModelEventHeader + +# Variable: ModelEventHeader + +> `const` **ModelEventHeader**: `ExactCodec`\<`TypeCodec`\<`object`\>\> + +Header of a Model Stream. + +## Defined in + +[packages/model-protocol/src/codecs.ts:371](https://github.com/ceramicstudio/ceramic-sdk/blob/a220cbca7950f690af7f3d03a0023681bb9f5426/packages/model-protocol/src/codecs.ts#L371) diff --git a/docs/@ceramic-sdk/model-protocol/variables/ModelInitEventPayload.md b/docs/@ceramic-sdk/model-protocol/variables/ModelInitEventPayload.md new file mode 100644 index 0000000..6d0ce0d --- /dev/null +++ b/docs/@ceramic-sdk/model-protocol/variables/ModelInitEventPayload.md @@ -0,0 +1,15 @@ +[**@ceramic-sdk/model-protocol v0.1.0**](../README.md) • **Docs** + +*** + +[Ceramic SDK](../../../README.md) / [@ceramic-sdk/model-protocol](../README.md) / ModelInitEventPayload + +# Variable: ModelInitEventPayload + +> `const` **ModelInitEventPayload**: `ExactCodec`\<`TypeCodec`\<`object`\>\> + +Model Init event payload. + +## Defined in + +[packages/model-protocol/src/codecs.ts:384](https://github.com/ceramicstudio/ceramic-sdk/blob/a220cbca7950f690af7f3d03a0023681bb9f5426/packages/model-protocol/src/codecs.ts#L384) diff --git a/docs/@ceramic-sdk/model-protocol/variables/ModelMetadata.md b/docs/@ceramic-sdk/model-protocol/variables/ModelMetadata.md new file mode 100644 index 0000000..f312da4 --- /dev/null +++ b/docs/@ceramic-sdk/model-protocol/variables/ModelMetadata.md @@ -0,0 +1,15 @@ +[**@ceramic-sdk/model-protocol v0.1.0**](../README.md) • **Docs** + +*** + +[Ceramic SDK](../../../README.md) / [@ceramic-sdk/model-protocol](../README.md) / ModelMetadata + +# Variable: ModelMetadata + +> `const` **ModelMetadata**: `ExactCodec`\<`TypeCodec`\<`object`\>\> + +Metadata for a Model Stream + +## Defined in + +[packages/model-protocol/src/codecs.ts:99](https://github.com/ceramicstudio/ceramic-sdk/blob/a220cbca7950f690af7f3d03a0023681bb9f5426/packages/model-protocol/src/codecs.ts#L99) diff --git a/docs/@ceramic-sdk/model-protocol/variables/ModelRelationDefinition.md b/docs/@ceramic-sdk/model-protocol/variables/ModelRelationDefinition.md new file mode 100644 index 0000000..2e2061f --- /dev/null +++ b/docs/@ceramic-sdk/model-protocol/variables/ModelRelationDefinition.md @@ -0,0 +1,19 @@ +[**@ceramic-sdk/model-protocol v0.1.0**](../README.md) • **Docs** + +*** + +[Ceramic SDK](../../../README.md) / [@ceramic-sdk/model-protocol](../README.md) / ModelRelationDefinition + +# Variable: ModelRelationDefinition + +> `const` **ModelRelationDefinition**: `UnionCodec`\<[`ExactCodec`\<`TypeCodec`\<`object`\>\>, `ExactCodec`\<`TypeCodec`\<`object`\>\>]\> + +Identifies types of properties that are supported as relations by the indexing service. + +Currently supported types of relation properties: +- 'account': references a DID property +- 'document': references a StreamID property with associated 'model' the related document must use + +## Defined in + +[packages/model-protocol/src/codecs.ts:154](https://github.com/ceramicstudio/ceramic-sdk/blob/a220cbca7950f690af7f3d03a0023681bb9f5426/packages/model-protocol/src/codecs.ts#L154) diff --git a/docs/@ceramic-sdk/model-protocol/variables/ModelRelationDefinitionV2.md b/docs/@ceramic-sdk/model-protocol/variables/ModelRelationDefinitionV2.md new file mode 100644 index 0000000..14c431e --- /dev/null +++ b/docs/@ceramic-sdk/model-protocol/variables/ModelRelationDefinitionV2.md @@ -0,0 +1,19 @@ +[**@ceramic-sdk/model-protocol v0.1.0**](../README.md) • **Docs** + +*** + +[Ceramic SDK](../../../README.md) / [@ceramic-sdk/model-protocol](../README.md) / ModelRelationDefinitionV2 + +# Variable: ModelRelationDefinitionV2 + +> `const` **ModelRelationDefinitionV2**: `UnionCodec`\<[`ExactCodec`\<`TypeCodec`\<`object`\>\>, `ExactCodec`\<`TypeCodec`\<`object`\>\>]\> + +Identifies types of properties that are supported as relations by the indexing service. + +Currently supported types of relation properties: +- 'account': references a DID property +- 'document': references a StreamID property with associated 'model' the related document must use if provided + +## Defined in + +[packages/model-protocol/src/codecs.ts:171](https://github.com/ceramicstudio/ceramic-sdk/blob/a220cbca7950f690af7f3d03a0023681bb9f5426/packages/model-protocol/src/codecs.ts#L171) diff --git a/docs/@ceramic-sdk/model-protocol/variables/ModelRelationViewDefinition.md b/docs/@ceramic-sdk/model-protocol/variables/ModelRelationViewDefinition.md new file mode 100644 index 0000000..2af6dc3 --- /dev/null +++ b/docs/@ceramic-sdk/model-protocol/variables/ModelRelationViewDefinition.md @@ -0,0 +1,13 @@ +[**@ceramic-sdk/model-protocol v0.1.0**](../README.md) • **Docs** + +*** + +[Ceramic SDK](../../../README.md) / [@ceramic-sdk/model-protocol](../README.md) / ModelRelationViewDefinition + +# Variable: ModelRelationViewDefinition + +> `const` **ModelRelationViewDefinition**: `UnionCodec`\<[`ExactCodec`\<`TypeCodec`\<`object`\>\>, `ExactCodec`\<`TypeCodec`\<`object`\>\>, `ExactCodec`\<`TypeCodec`\<`object`\>\>]\> + +## Defined in + +[packages/model-protocol/src/codecs.ts:212](https://github.com/ceramicstudio/ceramic-sdk/blob/a220cbca7950f690af7f3d03a0023681bb9f5426/packages/model-protocol/src/codecs.ts#L212) diff --git a/docs/@ceramic-sdk/model-protocol/variables/ModelRelationViewDefinitionV2.md b/docs/@ceramic-sdk/model-protocol/variables/ModelRelationViewDefinitionV2.md new file mode 100644 index 0000000..ce2c088 --- /dev/null +++ b/docs/@ceramic-sdk/model-protocol/variables/ModelRelationViewDefinitionV2.md @@ -0,0 +1,13 @@ +[**@ceramic-sdk/model-protocol v0.1.0**](../README.md) • **Docs** + +*** + +[Ceramic SDK](../../../README.md) / [@ceramic-sdk/model-protocol](../README.md) / ModelRelationViewDefinitionV2 + +# Variable: ModelRelationViewDefinitionV2 + +> `const` **ModelRelationViewDefinitionV2**: `UnionCodec`\<[`ExactCodec`\<`TypeCodec`\<`object`\>\>, `ExactCodec`\<`TypeCodec`\<`object`\>\>, `ExactCodec`\<`TypeCodec`\<`object`\>\>, `ExactCodec`\<`TypeCodec`\<`object`\>\>]\> + +## Defined in + +[packages/model-protocol/src/codecs.ts:236](https://github.com/ceramicstudio/ceramic-sdk/blob/a220cbca7950f690af7f3d03a0023681bb9f5426/packages/model-protocol/src/codecs.ts#L236) diff --git a/docs/@ceramic-sdk/model-protocol/variables/ModelRelationsDefinition.md b/docs/@ceramic-sdk/model-protocol/variables/ModelRelationsDefinition.md new file mode 100644 index 0000000..bb59203 --- /dev/null +++ b/docs/@ceramic-sdk/model-protocol/variables/ModelRelationsDefinition.md @@ -0,0 +1,17 @@ +[**@ceramic-sdk/model-protocol v0.1.0**](../README.md) • **Docs** + +*** + +[Ceramic SDK](../../../README.md) / [@ceramic-sdk/model-protocol](../README.md) / ModelRelationsDefinition + +# Variable: ModelRelationsDefinition + +> `const` **ModelRelationsDefinition**: `NonEnumerableRecordCodec`\<`TrivialCodec`\<`string`\>, `UnionCodec`\<[`ExactCodec`\<`TypeCodec`\<`object`\>\>, `ExactCodec`\<`TypeCodec`\<`object`\>\>]\>\> + +A mapping between model's property names and types of relation properties + +It indicates which properties of a model are relation properties and of what type + +## Defined in + +[packages/model-protocol/src/codecs.ts:185](https://github.com/ceramicstudio/ceramic-sdk/blob/a220cbca7950f690af7f3d03a0023681bb9f5426/packages/model-protocol/src/codecs.ts#L185) diff --git a/docs/@ceramic-sdk/model-protocol/variables/ModelRelationsDefinitionV2.md b/docs/@ceramic-sdk/model-protocol/variables/ModelRelationsDefinitionV2.md new file mode 100644 index 0000000..8af5d6e --- /dev/null +++ b/docs/@ceramic-sdk/model-protocol/variables/ModelRelationsDefinitionV2.md @@ -0,0 +1,13 @@ +[**@ceramic-sdk/model-protocol v0.1.0**](../README.md) • **Docs** + +*** + +[Ceramic SDK](../../../README.md) / [@ceramic-sdk/model-protocol](../README.md) / ModelRelationsDefinitionV2 + +# Variable: ModelRelationsDefinitionV2 + +> `const` **ModelRelationsDefinitionV2**: `NonEnumerableRecordCodec`\<`TrivialCodec`\<`string`\>, `UnionCodec`\<[`ExactCodec`\<`TypeCodec`\<`object`\>\>, `ExactCodec`\<`TypeCodec`\<`object`\>\>]\>\> + +## Defined in + +[packages/model-protocol/src/codecs.ts:192](https://github.com/ceramicstudio/ceramic-sdk/blob/a220cbca7950f690af7f3d03a0023681bb9f5426/packages/model-protocol/src/codecs.ts#L192) diff --git a/docs/@ceramic-sdk/model-protocol/variables/ModelViewDefinition.md b/docs/@ceramic-sdk/model-protocol/variables/ModelViewDefinition.md new file mode 100644 index 0000000..be823a8 --- /dev/null +++ b/docs/@ceramic-sdk/model-protocol/variables/ModelViewDefinition.md @@ -0,0 +1,24 @@ +[**@ceramic-sdk/model-protocol v0.1.0**](../README.md) • **Docs** + +*** + +[Ceramic SDK](../../../README.md) / [@ceramic-sdk/model-protocol](../README.md) / ModelViewDefinition + +# Variable: ModelViewDefinition + +> `const` **ModelViewDefinition**: `UnionCodec`\<[`UnionCodec`\<[`ExactCodec`\<`TypeCodec`\<`object`\>\>, `ExactCodec`\<`TypeCodec`\<`object`\>\>]\>, `UnionCodec`\<[`ExactCodec`\<`TypeCodec`\<`object`\>\>, `ExactCodec`\<`TypeCodec`\<`object`\>\>, `ExactCodec`\<`TypeCodec`\<`object`\>\>]\>]\> + +Identifies types of properties that are supported as view properties at DApps' runtime + +A view-property is one that is not stored in related MIDs' content, but is derived from their other properties + +Currently supported types of view properties: +- 'documentAccount': view properties of this type have the MID's controller DID as values +- 'documentVersion': view properties of this type have the MID's commit ID as values +- 'relationDocument': view properties of this type represent document relations identified by the given 'property' field +- 'relationFrom': view properties of this type represent inverse relations identified by the given 'model' and 'property' fields +- 'relationCountFrom': view properties of this type represent the number of inverse relations identified by the given 'model' and 'property' fields + +## Defined in + +[packages/model-protocol/src/codecs.ts:278](https://github.com/ceramicstudio/ceramic-sdk/blob/a220cbca7950f690af7f3d03a0023681bb9f5426/packages/model-protocol/src/codecs.ts#L278) diff --git a/docs/@ceramic-sdk/model-protocol/variables/ModelViewDefinitionV2.md b/docs/@ceramic-sdk/model-protocol/variables/ModelViewDefinitionV2.md new file mode 100644 index 0000000..6595dd3 --- /dev/null +++ b/docs/@ceramic-sdk/model-protocol/variables/ModelViewDefinitionV2.md @@ -0,0 +1,25 @@ +[**@ceramic-sdk/model-protocol v0.1.0**](../README.md) • **Docs** + +*** + +[Ceramic SDK](../../../README.md) / [@ceramic-sdk/model-protocol](../README.md) / ModelViewDefinitionV2 + +# Variable: ModelViewDefinitionV2 + +> `const` **ModelViewDefinitionV2**: `UnionCodec`\<[`UnionCodec`\<[`ExactCodec`\<`TypeCodec`\<`object`\>\>, `ExactCodec`\<`TypeCodec`\<`object`\>\>]\>, `UnionCodec`\<[`ExactCodec`\<`TypeCodec`\<`object`\>\>, `ExactCodec`\<`TypeCodec`\<`object`\>\>, `ExactCodec`\<`TypeCodec`\<`object`\>\>, `ExactCodec`\<`TypeCodec`\<`object`\>\>]\>]\> + +Identifies types of properties that are supported as view properties at DApps' runtime + +A view-property is one that is not stored in related MIDs' content, but is derived from their other properties + +Currently supported types of view properties: +- 'documentAccount': view properties of this type have the MID's controller DID as values +- 'documentVersion': view properties of this type have the MID's commit ID as values +- 'relationDocument': view properties of this type represent document relations identified by the given 'property' field +- 'relationFrom': view properties of this type represent inverse relations identified by the given 'model' and 'property' fields +- 'relationCountFrom': view properties of this type represent the number of inverse relations identified by the given 'model' and 'property' fields +- 'relationSetFrom': view properties of this type represent a single inverse relation identified by the given 'model' and 'property' fields for models using the SET account relation + +## Defined in + +[packages/model-protocol/src/codecs.ts:298](https://github.com/ceramicstudio/ceramic-sdk/blob/a220cbca7950f690af7f3d03a0023681bb9f5426/packages/model-protocol/src/codecs.ts#L298) diff --git a/docs/@ceramic-sdk/model-protocol/variables/ModelViewsDefinition.md b/docs/@ceramic-sdk/model-protocol/variables/ModelViewsDefinition.md new file mode 100644 index 0000000..aa98670 --- /dev/null +++ b/docs/@ceramic-sdk/model-protocol/variables/ModelViewsDefinition.md @@ -0,0 +1,17 @@ +[**@ceramic-sdk/model-protocol v0.1.0**](../README.md) • **Docs** + +*** + +[Ceramic SDK](../../../README.md) / [@ceramic-sdk/model-protocol](../README.md) / ModelViewsDefinition + +# Variable: ModelViewsDefinition + +> `const` **ModelViewsDefinition**: `NonEnumerableRecordCodec`\<`TrivialCodec`\<`string`\>, `UnionCodec`\<[`UnionCodec`\<[`ExactCodec`\<`TypeCodec`\<`object`\>\>, `ExactCodec`\<`TypeCodec`\<`object`\>\>]\>, `UnionCodec`\<[`ExactCodec`\<`TypeCodec`\<`object`\>\>, `ExactCodec`\<`TypeCodec`\<`object`\>\>, `ExactCodec`\<`TypeCodec`\<`object`\>\>]\>]\>\> + +A mapping between model's property names and types of view properties + +It indicates which properties of a model are view properties and of what type + +## Defined in + +[packages/model-protocol/src/codecs.ts:309](https://github.com/ceramicstudio/ceramic-sdk/blob/a220cbca7950f690af7f3d03a0023681bb9f5426/packages/model-protocol/src/codecs.ts#L309) diff --git a/docs/@ceramic-sdk/model-protocol/variables/ModelViewsDefinitionV2.md b/docs/@ceramic-sdk/model-protocol/variables/ModelViewsDefinitionV2.md new file mode 100644 index 0000000..26cf94f --- /dev/null +++ b/docs/@ceramic-sdk/model-protocol/variables/ModelViewsDefinitionV2.md @@ -0,0 +1,17 @@ +[**@ceramic-sdk/model-protocol v0.1.0**](../README.md) • **Docs** + +*** + +[Ceramic SDK](../../../README.md) / [@ceramic-sdk/model-protocol](../README.md) / ModelViewsDefinitionV2 + +# Variable: ModelViewsDefinitionV2 + +> `const` **ModelViewsDefinitionV2**: `NonEnumerableRecordCodec`\<`TrivialCodec`\<`string`\>, `UnionCodec`\<[`UnionCodec`\<[`ExactCodec`\<`TypeCodec`\<`object`\>\>, `ExactCodec`\<`TypeCodec`\<`object`\>\>]\>, `UnionCodec`\<[`ExactCodec`\<`TypeCodec`\<`object`\>\>, `ExactCodec`\<`TypeCodec`\<`object`\>\>, `ExactCodec`\<`TypeCodec`\<`object`\>\>, `ExactCodec`\<`TypeCodec`\<`object`\>\>]\>]\>\> + +A mapping between model's property names and types of view properties + +It indicates which properties of a model are view properties and of what type + +## Defined in + +[packages/model-protocol/src/codecs.ts:321](https://github.com/ceramicstudio/ceramic-sdk/blob/a220cbca7950f690af7f3d03a0023681bb9f5426/packages/model-protocol/src/codecs.ts#L321) diff --git a/docs/@ceramic-sdk/model-protocol/variables/ObjectSchema.md b/docs/@ceramic-sdk/model-protocol/variables/ObjectSchema.md new file mode 100644 index 0000000..8144b56 --- /dev/null +++ b/docs/@ceramic-sdk/model-protocol/variables/ObjectSchema.md @@ -0,0 +1,13 @@ +[**@ceramic-sdk/model-protocol v0.1.0**](../README.md) • **Docs** + +*** + +[Ceramic SDK](../../../README.md) / [@ceramic-sdk/model-protocol](../README.md) / ObjectSchema + +# Variable: ObjectSchema + +> `const` **ObjectSchema**: `Type`\<`Object`\<`any`\>, `Object`\<`any`\>, `unknown`\> + +## Defined in + +[packages/model-protocol/src/codecs.ts:88](https://github.com/ceramicstudio/ceramic-sdk/blob/a220cbca7950f690af7f3d03a0023681bb9f5426/packages/model-protocol/src/codecs.ts#L88) diff --git a/docs/@ceramic-sdk/model-protocol/variables/optionalModelString.md b/docs/@ceramic-sdk/model-protocol/variables/optionalModelString.md new file mode 100644 index 0000000..638258f --- /dev/null +++ b/docs/@ceramic-sdk/model-protocol/variables/optionalModelString.md @@ -0,0 +1,13 @@ +[**@ceramic-sdk/model-protocol v0.1.0**](../README.md) • **Docs** + +*** + +[Ceramic SDK](../../../README.md) / [@ceramic-sdk/model-protocol](../README.md) / optionalModelString + +# Variable: optionalModelString + +> `const` **optionalModelString**: `UnionCodec`\<[`RefinementCodec`\<`TrivialCodec`\<`string`\>, `string`\>, `TrivialCodec`\<`null`\>]\> + +## Defined in + +[packages/model-protocol/src/codecs.ts:94](https://github.com/ceramicstudio/ceramic-sdk/blob/a220cbca7950f690af7f3d03a0023681bb9f5426/packages/model-protocol/src/codecs.ts#L94) diff --git a/docs/README.md b/docs/README.md new file mode 100644 index 0000000..1db6576 --- /dev/null +++ b/docs/README.md @@ -0,0 +1,15 @@ +**Ceramic SDK** • **Docs** + +*** + +# Ceramic SDK + +## Packages + +- [@ceramic-sdk/events - v0.1.0](@ceramic-sdk/events/README.md) +- [@ceramic-sdk/http-client - v0.1.0](@ceramic-sdk/http-client/README.md) +- [@ceramic-sdk/identifiers - v0.1.0](@ceramic-sdk/identifiers/README.md) +- [@ceramic-sdk/model-client - v0.1.0](@ceramic-sdk/model-client/README.md) +- [@ceramic-sdk/model-instance-client - v0.1.0](@ceramic-sdk/model-instance-client/README.md) +- [@ceramic-sdk/model-instance-protocol - v0.1.0](@ceramic-sdk/model-instance-protocol/README.md) +- [@ceramic-sdk/model-protocol - v0.1.0](@ceramic-sdk/model-protocol/README.md) diff --git a/package.json b/package.json index 4ad035a..a52a2be 100644 --- a/package.json +++ b/package.json @@ -4,6 +4,7 @@ "packageManager": "pnpm@9.8.0", "scripts": { "build": "pnpm --filter \"@ceramic-sdk/*\" build:types && turbo run build:js", + "docs": "typedoc", "lint": "biome check --write apps/* packages/* tests/*", "lint:ci": "biome ci packages/* tests/*", "test": "turbo run test -- --passWithNoTests", @@ -14,7 +15,7 @@ "@jest/globals": "^29.7.0", "@skypack/package-check": "^0.2.2", "@swc/cli": "^0.4.0", - "@swc/core": "^1.7.11", + "@swc/core": "^1.7.24", "@swc/jest": "^0.2.36", "@types/jest": "^29.5.13", "@types/node": "^22.5.5", @@ -22,6 +23,8 @@ "jest": "^29.7.0", "tsx": "^4.19.0", "turbo": "^2.1.2", + "typedoc": "^0.26.7", + "typedoc-plugin-markdown": "^4.2.7", "typescript": "^5.6.2" }, "pnpm": { diff --git a/packages/events/README.md b/packages/events/README.md index ff77259..4ee6908 100644 --- a/packages/events/README.md +++ b/packages/events/README.md @@ -1,5 +1,17 @@ # Ceramic events +Encoding, signing and other utilities for interacting with Ceramic events. + +## Installation + +```sh +npm install @ceramic-sdk/events +``` + +## Documentation + +[API reference](https://github.com/ceramicstudio/ceramic-sdk/tree/main/docs/@ceramic-sdk/events) + ## License Dual licensed under MIT and Apache 2 diff --git a/packages/events/src/codecs.ts b/packages/events/src/codecs.ts index 0b0bd13..fd4abf0 100644 --- a/packages/events/src/codecs.ts +++ b/packages/events/src/codecs.ts @@ -15,6 +15,7 @@ import { import 'multiformats' // Import needed for TS reference import 'ts-essentials' // Import needed for TS reference +/** IPLD DAG-encoded JWS */ export const DagJWS = sparse({ payload: string, signatures: array(JWSSignature), @@ -22,6 +23,7 @@ export const DagJWS = sparse({ }) export type DagJWS = TypeOf +/** Header structure of Init events */ export const InitEventHeader = sparse( { controllers: tuple([didString]), @@ -35,6 +37,7 @@ export const InitEventHeader = sparse( ) export type InitEventHeader = TypeOf +/** Payload structure of Init events */ export const InitEventPayload = sparse( { data: unknown, @@ -47,7 +50,7 @@ export type InitEventPayload = { header: InitEventHeader } -// DagJWSResult in DID package +/** Signed event structure - equivalent to DagJWSResult in `dids` package */ export const SignedEvent = sparse( { jws: DagJWS, @@ -58,15 +61,19 @@ export const SignedEvent = sparse( ) export type SignedEvent = TypeOf +/** Decode the provided `input` as a SignedEvent. Throws if decoding fails. */ export function decodeSignedEvent(input: unknown): SignedEvent { return decode(SignedEvent, input) } + +/** Assert the provided `input` is a SignedEvent */ export function assertSignedEvent( input: unknown, ): asserts input is SignedEvent { decodeSignedEvent(input) } +/** Time event structure */ export const TimeEvent = strict( { id: cid, @@ -78,9 +85,12 @@ export const TimeEvent = strict( ) export type TimeEvent = TypeOf +/** Decode the provided `input` as a TimeEvent. Throws if decoding fails. */ export function decodeTimeEvent(input: unknown): TimeEvent { return decode(TimeEvent, input) } + +/** Assert the provided `input` is a TimeEvent */ export function assertTimeEvent(input: unknown): asserts input is TimeEvent { decodeTimeEvent(input) } diff --git a/packages/events/src/container.ts b/packages/events/src/container.ts index db3833c..4bc27ec 100644 --- a/packages/events/src/container.ts +++ b/packages/events/src/container.ts @@ -5,6 +5,7 @@ import type { CID } from 'multiformats/cid' import { SignedEvent } from './codecs.js' import { getSignedEventPayload } from './signing.js' +/** Container for a signed Ceramic event */ export type SignedEventContainer = { signed: true cid: CID @@ -13,15 +14,18 @@ export type SignedEventContainer = { cacaoBlock?: Uint8Array } +/** Container for an unsigned Ceramic event */ export type UnsignedEventContainer = { signed: false payload: Payload } +/** Container for a Ceramic event, providing additional metadata about the event */ export type EventContainer = | SignedEventContainer | UnsignedEventContainer +/** Decode an unsigned Ceramic event into a container using the provided payload decoder */ export function unsignedEventToContainer( codec: Decoder, event: unknown, @@ -29,6 +33,7 @@ export function unsignedEventToContainer( return { signed: false, payload: decode(codec, event) } } +/** Decode a signed Ceramic event into a container using the provided verifier DID and payload decoder */ export async function signedEventToContainer( did: DID, codec: Decoder, @@ -45,6 +50,7 @@ export async function signedEventToContainer( return { signed: true, cid, verified, payload, cacaoBlock: event.cacaoBlock } } +/** Decode a Ceramic event into a container using the provided verifier DID and payload decoder */ export async function eventToContainer( did: DID, codec: Decoder, diff --git a/packages/events/src/encoding.ts b/packages/events/src/encoding.ts index 48f981b..de66446 100644 --- a/packages/events/src/encoding.ts +++ b/packages/events/src/encoding.ts @@ -15,14 +15,18 @@ carFactory.codecs.add(dagJose) carFactory.codecs.add(dagJson) carFactory.hashers.add(sha256) +/** @internal */ export type Base = keyof typeof bases +/** @internal */ export const DEFAULT_BASE: Base = 'base64' +/** Encode a CAR into a string, using the given base (defaults to base64) */ export function carToString(car: CAR, base: Base = DEFAULT_BASE): string { return car.toString(base) } +/** Decode a CAR from a string, using the given base (defaults to base64) */ export function carFromString(value: string, base: Base = DEFAULT_BASE): CAR { const codec = bases[base] if (codec == null) { @@ -31,6 +35,7 @@ export function carFromString(value: string, base: Base = DEFAULT_BASE): CAR { return carFactory.fromBytes(codec.decode(value)) } +/** Encode a signed event into a CAR */ export function signedEventToCAR(event: SignedEvent): CAR { const { jws, linkedBlock, cacaoBlock } = event const car = carFactory.build() @@ -63,6 +68,7 @@ export function signedEventToCAR(event: SignedEvent): CAR { return car } +/** Encode an unsigned event into a CAR using the provided codec */ export function encodeEventToCAR(codec: Codec, event: unknown): CAR { const car = carFactory.build() const cid = car.put(codec.encode(event), { isRoot: true }) @@ -72,12 +78,14 @@ export function encodeEventToCAR(codec: Codec, event: unknown): CAR { return car } +/** Encode an event into a CAR using the provided codec for unsigned events */ export function eventToCAR(codec: Codec, event: unknown): CAR { return SignedEvent.is(event) ? signedEventToCAR(event) : encodeEventToCAR(codec, event) } +/** Encode an event into a string using the provided codec for unsigned events and the given base (defaults to base64) */ export function eventToString( codec: Codec, event: unknown, @@ -86,6 +94,7 @@ export function eventToString( return carToString(eventToCAR(codec, event), base) } +/** Decode an event from a string using the provided codec for unsigned events */ export function eventFromCAR( decoder: Decoder, car: CAR, @@ -115,6 +124,7 @@ export function eventFromCAR( return decode(decoder, root) } +/** Decode an event from a string using the provided codec for unsigned events and the given base (defaults to base64) */ export function eventFromString( decoder: Decoder, value: string, diff --git a/packages/events/src/signing.ts b/packages/events/src/signing.ts index 3eb0b78..5c1cc0c 100644 --- a/packages/events/src/signing.ts +++ b/packages/events/src/signing.ts @@ -11,6 +11,7 @@ import { type SignedEvent, } from './codecs.js' +/** Sign an event payload using the provided DID */ export async function signEvent( did: DID, payload: Record, @@ -28,6 +29,7 @@ export type PartialInitEventHeader = Omit & { controllers?: [DIDString] } +/** Create a signed init event using the provided DID, data and header */ export async function createSignedInitEvent( did: DID, data: T, @@ -47,6 +49,7 @@ export async function createSignedInitEvent( return await signEvent(did, payload, options) } +/** Decode the payload of a signed event using the provided decoder */ export async function getSignedEventPayload>( decoder: Decoder, event: SignedEvent, diff --git a/packages/events/src/utils.ts b/packages/events/src/utils.ts index ffbd6ca..62445b9 100644 --- a/packages/events/src/utils.ts +++ b/packages/events/src/utils.ts @@ -1,8 +1,10 @@ import type { CID } from 'multiformats/cid' import { toString as bytesToString, fromString } from 'uint8arrays' +/** @internal */ export const MAX_BLOCK_SIZE = 256000 // 256 KB +/** @internal */ export function base64urlToJSON>(value: string): T { return JSON.parse(bytesToString(fromString(value, 'base64url'))) } @@ -12,6 +14,7 @@ export function base64urlToJSON>(value: string): T { * * @param block - Uint8Array of IPLD block * @param cid - Commit CID + * @internal */ export function restrictBlockSize(block: Uint8Array, cid: CID): void { const size = block.byteLength diff --git a/packages/http-client/README.md b/packages/http-client/README.md index bbf7090..1cdc2e1 100644 --- a/packages/http-client/README.md +++ b/packages/http-client/README.md @@ -1,5 +1,17 @@ # Ceramic HTTP client +HTTP client for interacting with a Ceramic One node + +## Installation + +```sh +npm install @ceramic-sdk/http-client +``` + +## Documentation + +[API reference](https://github.com/ceramicstudio/ceramic-sdk/tree/main/docs/@ceramic-sdk/http-client) + ## License Dual licensed under MIT and Apache 2 diff --git a/packages/http-client/src/index.ts b/packages/http-client/src/index.ts index 3307195..1e8a3fa 100644 --- a/packages/http-client/src/index.ts +++ b/packages/http-client/src/index.ts @@ -19,13 +19,18 @@ export type Schemas = SimplifyDeep export type Schema = SimplifyDeep export type ClientParams = { + /** Ceramic One server URL */ url: string + /** Custom fetch function to use for requests */ fetch?: (request: Request) => ReturnType + /** Additional HTTP headers to send with requests */ headers?: HeadersOptions } export type EventsFeedParams = { + /** Resume token */ resumeAt?: string + /** Maximum number of events to return in response */ limit?: number } @@ -40,10 +45,12 @@ export class CeramicClient { }) } + /** OpenAPI client used internally, provides low-level access to the HTTP APIs exposed by the Ceramic One server */ get api(): CeramicAPI { return this.#api } + /** Get the raw event response for the given event CID */ async getEvent(id: string): Promise> { const { data, error } = await this.#api.GET('/events/{event_id}', { params: { path: { event_id: id } }, @@ -54,6 +61,7 @@ export class CeramicClient { return data } + /** Get the string-encoded event for the given event CID */ async getEventData(id: string): Promise { const event = await this.getEvent(id) if (event.data == null) { @@ -62,11 +70,13 @@ export class CeramicClient { return event.data } + /** Get the CAR-encoded event for the given event CID */ async getEventCAR(id: string): Promise { const data = await this.getEventData(id) return carFromString(data) } + /** Get the decoded event for the given decoder and event CID */ async getEventType( decoder: Decoder, id: string, @@ -75,6 +85,7 @@ export class CeramicClient { return eventFromString(decoder, data) } + /** Get the events feed based on the given parameters */ async getEventsFeed( params: EventsFeedParams = {}, ): Promise> { @@ -87,6 +98,7 @@ export class CeramicClient { return data } + /** Get information about the Ceramic One server version */ async getVersion(): Promise> { const { data, error } = await this.#api.GET('/version') if (error != null) { @@ -95,6 +107,7 @@ export class CeramicClient { return data } + /** Post a string-encoded event to the server */ async postEvent(data: string): Promise { const { error } = await this.#api.POST('/events', { body: { data } }) if (error != null) { @@ -102,16 +115,19 @@ export class CeramicClient { } } + /** Post a CAR-encoded event to the server */ async postEventCAR(car: CAR): Promise { await this.postEvent(carToString(car)) return car.roots[0] } + /** Encode and post an event to the server */ async postEventType(codec: Codec, event: unknown): Promise { const car = eventToCAR(codec, event) return await this.postEventCAR(car) } + /** Register interest in streams using the given model stream ID */ async registerInterestModel(model: string): Promise { const { error } = await this.#api.POST('/interests', { body: { sep: 'model', sepValue: model }, diff --git a/packages/identifiers/README.md b/packages/identifiers/README.md index 0c0e68d..28dad10 100644 --- a/packages/identifiers/README.md +++ b/packages/identifiers/README.md @@ -1,5 +1,17 @@ # Ceramic identifiers +Ceramic streams and commits identifiers + +## Installation + +```sh +npm install @ceramic-sdk/identifiers +``` + +## Documentation + +[API reference](https://github.com/ceramicstudio/ceramic-sdk/tree/main/docs/@ceramic-sdk/identifiers) + ## License Dual licensed under MIT and Apache 2 diff --git a/packages/identifiers/src/codecs.ts b/packages/identifiers/src/codecs.ts index 7e1b4f7..035495e 100644 --- a/packages/identifiers/src/codecs.ts +++ b/packages/identifiers/src/codecs.ts @@ -4,6 +4,7 @@ import { StreamID } from './stream-id.js' /** * Verify if `input` is a StreamID string. + * @internal */ export function isStreamIDString(input: string): input is string { try { diff --git a/packages/identifiers/src/commit-id.ts b/packages/identifiers/src/commit-id.ts index 2022a83..e381a94 100644 --- a/packages/identifiers/src/commit-id.ts +++ b/packages/identifiers/src/commit-id.ts @@ -214,7 +214,7 @@ export class CommitID { * If commit: * CommitID(k3y52l7mkcvtg023bt9txegccxe1bah8os3naw5asin3baf3l3t54atn0cuy98yws, bagjqcgzaday6dzalvmy5ady2m5a5legq5zrbsnlxfc2bfxej532ds7htpova) * - * @returns {String} + * @internal */ [Symbol.for('nodejs.util.inspect.custom')](): string { return `CommitID(${this.toString()})` @@ -222,6 +222,7 @@ export class CommitID { /** * String representation of CommitID. + * @internal */ [Symbol.toPrimitive](): string | Uint8Array { return this.toString() diff --git a/packages/identifiers/src/parsing.ts b/packages/identifiers/src/parsing.ts index 9d760f5..34c1a1f 100644 --- a/packages/identifiers/src/parsing.ts +++ b/packages/identifiers/src/parsing.ts @@ -5,6 +5,7 @@ import varint from 'varint' import { STREAMID_CODEC, type StreamTypeCode } from './constants.js' +/** @internal */ export function readVarint(bytes: Uint8Array): [number, Uint8Array, number] { const value = varint.decode(bytes) const readLength = varint.decode.bytes @@ -19,6 +20,7 @@ function isCidVersion(input: number): input is 0 | 1 { return input === 0 || input === 1 } +/** @internal */ export function readCid(bytes: Uint8Array): [CID, Uint8Array] { const [cidVersion, cidVersionRemainder] = readVarint(bytes) if (!isCidVersion(cidVersion)) { @@ -40,12 +42,14 @@ export function readCid(bytes: Uint8Array): [CID, Uint8Array] { ] } +/** @internal */ export type StreamIDComponents = { kind: 'stream-id' type: StreamTypeCode init: CID } +/** @internal */ export type CommitIDComponents = { kind: 'commit-id' type: StreamTypeCode @@ -53,10 +57,12 @@ export type CommitIDComponents = { commit: CID | null } +/** @internal */ export type StreamRefComponents = StreamIDComponents | CommitIDComponents /** * Parse StreamID or CommitID from bytes. + * @internal */ export function fromBytes( input: Uint8Array, @@ -87,6 +93,7 @@ export function fromBytes( const URL_PATTERN = /(ceramic:\/\/|\/ceramic\/)?([a-zA-Z0-9]+)(\?commit=([a-zA-Z0-9]+))?/ +/** @internal */ export function fromString( input: string, title = 'StreamRef', @@ -113,6 +120,8 @@ export function fromString( * Return `undefined` if not CID. * * @param input - CID or string. + * + * @internal */ export function parseCID(input: unknown): CID | null { try { @@ -130,6 +139,8 @@ export function parseCID(input: unknown): CID | null { * * @param genesis - genesis CID for stream * @param commit - representation of commit, be it CID, 0, `'0'`, `null` + * + * @internal */ export function parseCommit( genesis: CID, diff --git a/packages/identifiers/src/stream-id.ts b/packages/identifiers/src/stream-id.ts index f907b4f..b4bb842 100644 --- a/packages/identifiers/src/stream-id.ts +++ b/packages/identifiers/src/stream-id.ts @@ -165,7 +165,6 @@ export class StreamID { /** * Copy of self. Exists to maintain compatibility with CommitID. - * @readonly */ @Memoize() get baseID(): StreamID { @@ -199,6 +198,7 @@ export class StreamID { /** * StreamId(k3y52l7mkcvtg023bt9txegccxe1bah8os3naw5asin3baf3l3t54atn0cuy98yws) + * @internal */ [Symbol.for('nodejs.util.inspect.custom')](): string { return `StreamID(${this.toString()})` @@ -206,6 +206,7 @@ export class StreamID { /** * String representation of StreamID. + * @internal */ [Symbol.toPrimitive](): string { return this.toString() diff --git a/packages/identifiers/src/utils.ts b/packages/identifiers/src/utils.ts index 2afc8f2..87af3b0 100644 --- a/packages/identifiers/src/utils.ts +++ b/packages/identifiers/src/utils.ts @@ -14,6 +14,7 @@ import { StreamID } from './stream-id.js' type CodecCode = typeof codec.code type DigestCode = typeof sha256.code +/** @internal */ export function createCID( value: T, ): CID { @@ -23,6 +24,7 @@ export function createCID( return CID.createV1(codec.code, hash) as CID } +/** @internal */ export function getCodeByName(name: StreamTypeName): StreamTypeCode { const index = STREAM_TYPES[name] if (index == null) { @@ -31,6 +33,7 @@ export function getCodeByName(name: StreamTypeName): StreamTypeCode { return index } +/** @internal */ export function getNameByCode(code: StreamTypeCode): StreamTypeName { for (const [name, value] of Object.entries(STREAM_TYPES)) { if (value === code) { @@ -40,11 +43,13 @@ export function getNameByCode(code: StreamTypeCode): StreamTypeName { throw new Error(`No stream type registered for code ${code}`) } +/** @internal */ export function randomCID(): CID { const randomBytes = globalThis.crypto.getRandomValues(new Uint8Array(32)) return CID.createV1(codec.code, create(sha256.code, randomBytes)) } +/** @internal */ export function randomStreamID(type: StreamType = 0): StreamID { return new StreamID(type, randomCID()) } diff --git a/packages/model-client/README.md b/packages/model-client/README.md index d16e64c..2b194e4 100644 --- a/packages/model-client/README.md +++ b/packages/model-client/README.md @@ -1,5 +1,15 @@ # Ceramic Model stream client +## Installation + +```sh +npm install @ceramic-sdk/model-client +``` + +## Documentation + +[API reference](https://github.com/ceramicstudio/ceramic-sdk/tree/main/docs/@ceramic-sdk/model-client) + ## License Dual licensed under MIT and Apache 2 diff --git a/packages/model-client/src/index.ts b/packages/model-client/src/index.ts index e02ec46..fa63b5f 100644 --- a/packages/model-client/src/index.ts +++ b/packages/model-client/src/index.ts @@ -13,6 +13,9 @@ import type { DID } from 'dids' const header: PartialInitEventHeader = { model: MODEL, sep: 'model' } +/** + * Create a signed init event for a model using the provided DID and model definition + */ export async function createInitEvent( did: DID, data: ModelDefinition, diff --git a/packages/model-instance-client/README.md b/packages/model-instance-client/README.md index a0f1ece..c431200 100644 --- a/packages/model-instance-client/README.md +++ b/packages/model-instance-client/README.md @@ -1,5 +1,15 @@ # Ceramic ModelInstanceDocument stream client +## Installation + +```sh +npm install @ceramic-sdk/model-instance-client +``` + +## Documentation + +[API reference](https://github.com/ceramicstudio/ceramic-sdk/tree/main/docs/@ceramic-sdk/model-instance-client) + ## License Dual licensed under MIT and Apache 2 diff --git a/packages/model-instance-client/src/events.ts b/packages/model-instance-client/src/events.ts index e54f07e..3f2e7b8 100644 --- a/packages/model-instance-client/src/events.ts +++ b/packages/model-instance-client/src/events.ts @@ -21,13 +21,22 @@ import type { UnknownContent } from './types.js' import { createInitHeader, getPatchOperations } from './utils.js' export type CreateInitEventParams = { + /** Initial JSON object content for the ModelInstanceDocument stream */ content: T + /** DID controlling the ModelInstanceDocument stream */ controller: DID + /** Stream ID of the Model used by the ModelInstanceDocument stream */ model: StreamID + /** Optional context */ context?: StreamID + /** Flag notifying indexers if they should index the ModelInstanceDocument stream or not, defaults to `true` */ shouldIndex?: boolean } +/** + * Create a non-deterministic init event for a ModelInstanceDocument stream. + * @see {@link getDeterministicInitEventPayload} for deterministic events. + */ export async function createInitEvent< T extends UnknownContent = UnknownContent, >(params: CreateInitEventParams): Promise { @@ -41,6 +50,10 @@ export async function createInitEvent< return await createSignedInitEvent(controller, content, header) } +/** + * Get a deterministic init event payload for a ModelInstanceDocument stream. + * @see {@link createInitEvent} for creating non-deterministic events. + */ export function getDeterministicInitEventPayload( model: StreamID, controller: DIDString | string, @@ -56,6 +69,9 @@ export function getDeterministicInitEventPayload( } } +/** + * Get an encoded deterministic init event for a ModelInstanceDocument stream + */ export function getDeterministicInitEvent( model: StreamID, controller: DIDString | string, @@ -70,6 +86,9 @@ export function getDeterministicInitEvent( return { data: null, header: InitEventHeader.encode(header) } } +/** + * Create a data event payload for a ModelInstanceDocument stream + */ export function createDataEventPayload( current: CommitID, data: Array, @@ -91,13 +110,21 @@ export function createDataEventPayload( } export type CreateDataEventParams = { + /** DID controlling the ModelInstanceDocument stream */ controller: DID + /** Commit ID of the current tip of the ModelInstanceDocument stream */ currentID: CommitID + /** Current JSON object content for the ModelInstanceDocument stream, used with `newContent` to create the JSON patch */ currentContent?: T + /** New JSON object content for the ModelInstanceDocument stream, used with `currentContent` to create the JSON patch */ newContent?: T + /** Flag notifying indexers if they should index the ModelInstanceDocument stream or not */ shouldIndex?: boolean } +/** + * Create a signed data event for a ModelInstanceDocument stream + */ export async function createDataEvent< T extends UnknownContent = UnknownContent, >(params: CreateDataEventParams): Promise { diff --git a/packages/model-instance-client/src/utils.ts b/packages/model-instance-client/src/utils.ts index c31a27b..972f60e 100644 --- a/packages/model-instance-client/src/utils.ts +++ b/packages/model-instance-client/src/utils.ts @@ -8,12 +8,14 @@ import jsonpatch from 'fast-json-patch' import type { UnknownContent } from './types.js' +/** @internal */ export function randomBytes(length: number): Uint8Array { const bytes = new Uint8Array(length) globalThis.crypto.getRandomValues(bytes) return bytes } +/** @internal */ export type CreateInitHeaderParams = { model: StreamID controller: DIDString | string @@ -22,6 +24,7 @@ export type CreateInitHeaderParams = { shouldIndex?: boolean } +/** @internal */ export function createInitHeader( params: CreateInitHeaderParams, ): DocumentInitEventHeader { @@ -55,6 +58,7 @@ export function createInitHeader( return header } +/** @internal */ export function getPatchOperations( fromContent?: T, toContent?: T, diff --git a/packages/model-instance-protocol/README.md b/packages/model-instance-protocol/README.md index 1727450..bdea781 100644 --- a/packages/model-instance-protocol/README.md +++ b/packages/model-instance-protocol/README.md @@ -1,5 +1,15 @@ # Ceramic ModelInstanceDocument stream protocol +## Installation + +```sh +npm install @ceramic-sdk/model-instance-protocol +``` + +## Documentation + +[API reference](https://github.com/ceramicstudio/ceramic-sdk/tree/main/docs/@ceramic-sdk/model-instance-protocol) + ## License Dual licensed under MIT and Apache 2 diff --git a/packages/model-instance-protocol/src/assertions.ts b/packages/model-instance-protocol/src/assertions.ts index b40d5c2..8e15fde 100644 --- a/packages/model-instance-protocol/src/assertions.ts +++ b/packages/model-instance-protocol/src/assertions.ts @@ -6,6 +6,7 @@ import { MAX_DOCUMENT_SIZE } from './constants.js' /** * Validate that content does not exceed the maximum size allowed * @param content Content to validate + * @internal */ export function assertValidContentLength(content: unknown) { if (content != null) { @@ -21,6 +22,7 @@ export function assertValidContentLength(content: unknown) { /** * Validate that patches content does not exceed the maximum size allowed * @param patches JSON patches to validate + * @internal */ export function assertValidPatchOperations(patches: Array) { for (const patch of patches) { diff --git a/packages/model-instance-protocol/src/constants.ts b/packages/model-instance-protocol/src/constants.ts index 9df33e6..bf4931a 100644 --- a/packages/model-instance-protocol/src/constants.ts +++ b/packages/model-instance-protocol/src/constants.ts @@ -1,4 +1,9 @@ +/** + * Maximum size of a ModelInstanceDocument content in bytes + */ export const MAX_DOCUMENT_SIZE = 16_000_000 +/** @internal */ export const STREAM_TYPE_NAME = 'MID' +/** @internal */ export const STREAM_TYPE_ID = 3 diff --git a/packages/model-instance-protocol/src/stream-id.ts b/packages/model-instance-protocol/src/stream-id.ts index 25d1c90..4c9f853 100644 --- a/packages/model-instance-protocol/src/stream-id.ts +++ b/packages/model-instance-protocol/src/stream-id.ts @@ -4,6 +4,9 @@ import type { CID } from 'multiformats/cid' import { DocumentInitEventHeader } from './codecs.js' import { STREAM_TYPE_ID } from './constants.js' +/** + * Get the StreamID of a deterministic ModelInstanceDocument based on its init header + */ export function getDeterministicStreamID( header: DocumentInitEventHeader, ): StreamID { @@ -20,6 +23,9 @@ export function getDeterministicStreamID( }) } +/** + * Get the StreamID of a ModelInstanceDocument based on its init CID + */ export function getStreamID(cid: CID): StreamID { return new StreamID(STREAM_TYPE_ID, cid) } diff --git a/packages/model-protocol/README.md b/packages/model-protocol/README.md index 566c859..fd7bf80 100644 --- a/packages/model-protocol/README.md +++ b/packages/model-protocol/README.md @@ -1,5 +1,15 @@ # Ceramic Model stream protocol +## Installation + +```sh +npm install @ceramic-sdk/model-protocol +``` + +## Documentation + +[API reference](https://github.com/ceramicstudio/ceramic-sdk/tree/main/docs/@ceramic-sdk/model-protocol) + ## License Dual licensed under MIT and Apache 2 diff --git a/packages/model-protocol/src/assertions.ts b/packages/model-protocol/src/assertions.ts index 85f8914..d5c8a48 100644 --- a/packages/model-protocol/src/assertions.ts +++ b/packages/model-protocol/src/assertions.ts @@ -19,6 +19,7 @@ type Schema = Exclude /** * Asserts that all the required fields for the Model are set, and throws an error if not. * @param content + * @internal */ export function assertValidDefinition( content: unknown, @@ -26,8 +27,10 @@ export function assertValidDefinition( decode(ModelDefinition, content) } +/** @internal */ export const MODEL_VERSION_REGEXP = /^[0-9]+\.[0-9]+$/ +/** @internal */ export function parseModelVersion(version: string): [number, number] { if (!MODEL_VERSION_REGEXP.test(version)) { throw new Error(`Unsupported version format: ${version}`) @@ -49,6 +52,7 @@ export type ValidVersionSatisfies = 'major' | 'minor' * Asserts that the version of the model definition is supported. * @param content - Model definition object * @param satisfies - Version range to satisfy + * @internal */ export function assertValidVersion( content: ModelDefinition, @@ -72,8 +76,8 @@ export function assertValidVersion( } /** - * Asserts that the relations properties of the given ModelDefinition are well formed, and throws - * an error if not. + * Asserts that the relations properties of the given ModelDefinition are well formed, and throws an error if not. + * @internal */ export function assertValidRelations(content: ModelDefinition) { if (content.relations != null) { @@ -81,6 +85,7 @@ export function assertValidRelations(content: ModelDefinition) { } } +/** @internal */ export function assertValidCacao(cacao: Cacao, controller: string): void { if (cacao.p.iss !== controller) { throw new Error( @@ -101,6 +106,7 @@ export function assertValidCacao(cacao: Cacao, controller: string): void { } } +/** @internal */ export async function validateController( controller: string, cacaoBlock?: Uint8Array, @@ -126,6 +132,7 @@ const SUPPORTED_FIELD_TYPES = ['boolean', 'integer', 'number', 'string'] * Validate model schema fields used by the SET account relation * @param fields - Array of field names used by the SET account relation * @param modelSchema - JSON schema of the model + * @internal */ export function assertValidSetFields( fields: Array, @@ -185,6 +192,7 @@ export function assertValidSetFields( } } +/** @internal */ export function assertValidAccountRelation(content: ModelDefinition) { if (content.version !== '1.0' && content.accountRelation.type === 'set') { assertValidSetFields(content.accountRelation.fields, content.schema) @@ -196,7 +204,6 @@ export function assertValidAccountRelation(content: ModelDefinition) { * * @param schema a SchemaObject schema from JSON Schema standard * @param fn a function taking schema's properties and calls recursiveMap recursively on them, if they're object properties - * */ function recursiveMap(schema: Schema, fn: (schemaProperty: object) => void) { fn(schema) @@ -228,6 +235,7 @@ function validateAdditionalProperties(schema: Schema): void { } } +/** @internal */ export function assertValidSchema( schema: unknown, ): asserts schema is JSONSchema.Object { @@ -235,6 +243,11 @@ export function assertValidSchema( recursiveMap(decoded, validateAdditionalProperties) } +/** + * Asserts that the model definition is valid and throws an error if it's not. + * + * @param content the model definition object + */ export function assertValidModelContent(content: ModelDefinition) { assertValidVersion(content, 'minor') assertValidDefinition(content) diff --git a/packages/model-protocol/src/codecs.ts b/packages/model-protocol/src/codecs.ts index 2c18bcc..34c6d45 100644 --- a/packages/model-protocol/src/codecs.ts +++ b/packages/model-protocol/src/codecs.ts @@ -29,6 +29,7 @@ import 'ts-essentials' // Import needed for TS reference import { MODEL } from './constants.js' +/** @internal */ export const ajv = new Ajv({ strict: true, allErrors: true, @@ -50,6 +51,7 @@ export type SchemaType = /** * Create a codec for a specific JSON Schema type such as Object, String, etc. + * @internal */ export function createSchemaType( type: T['type'], diff --git a/packages/model-protocol/src/constants.ts b/packages/model-protocol/src/constants.ts index b7465db..3d3a8ef 100644 --- a/packages/model-protocol/src/constants.ts +++ b/packages/model-protocol/src/constants.ts @@ -1,15 +1,22 @@ import { StreamID } from '@ceramic-sdk/identifiers' -// The hardcoded "model" StreamID that all Model streams have in their metadata. This provides -// a "model" StreamID that can be indexed to query the set of all published Models. -// The StreamID uses the "UNLOADABLE" StreamType, and has string representation: "kh4q0ozorrgaq2mezktnrmdwleo1d" +/** + * The hardcoded "model" StreamID that all Model streams have in their metadata. This provides + * a "model" StreamID that can be indexed to query the set of all published Models. + * The StreamID uses the "UNLOADABLE" StreamType, and has string representation: "kh4q0ozorrgaq2mezktnrmdwleo1d" + */ export const MODEL_STREAM_ID = 'kh4q0ozorrgaq2mezktnrmdwleo1d' export const MODEL = StreamID.fromString(MODEL_STREAM_ID) +/** @internal */ export const MODEL_RESOURCE_URI = `ceramic://*?model=${MODEL_STREAM_ID}` +/** @internal */ export const CACAO_MODEL_RESOURCES = [MODEL_RESOURCE_URI, 'ceramic://*'] +/** @internal */ export const STREAM_TYPE_NAME = 'model' +/** @internal */ export const STREAM_TYPE_ID = 2 +/** @internal */ export const VERSION = '2.0' diff --git a/packages/model-protocol/src/stream-id.ts b/packages/model-protocol/src/stream-id.ts index 9821a11..6b0fb05 100644 --- a/packages/model-protocol/src/stream-id.ts +++ b/packages/model-protocol/src/stream-id.ts @@ -3,6 +3,10 @@ import type { CID } from 'multiformats/cid' import { STREAM_TYPE_ID } from './constants.js' +/** + * Get a model StreamID from its init event CID + * @param cid - the CID of the init event + */ export function getModelStreamID(cid: CID): StreamID { return new StreamID(STREAM_TYPE_ID, cid) } diff --git a/packages/test-utils/package.json b/packages/test-utils/package.json index d1f47f9..58e4bb2 100644 --- a/packages/test-utils/package.json +++ b/packages/test-utils/package.json @@ -37,7 +37,7 @@ "caip": "^1.1.1", "did-session": "^4.0.0", "dids": "^5.0.2", - "viem": "^2.21.8" + "viem": "^2.21.9" }, "devDependencies": { "@didtools/pkh-ethereum": "^0.6.0" diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml index b9a88eb..1925e20 100644 --- a/pnpm-lock.yaml +++ b/pnpm-lock.yaml @@ -19,13 +19,13 @@ importers: version: 0.2.2 '@swc/cli': specifier: ^0.4.0 - version: 0.4.0(@swc/core@1.7.18)(chokidar@4.0.0) + version: 0.4.0(@swc/core@1.7.26)(chokidar@4.0.0) '@swc/core': - specifier: ^1.7.11 - version: 1.7.18 + specifier: ^1.7.24 + version: 1.7.26 '@swc/jest': specifier: ^0.2.36 - version: 0.2.36(@swc/core@1.7.18) + version: 0.2.36(@swc/core@1.7.26) '@types/jest': specifier: ^29.5.13 version: 29.5.13 @@ -44,6 +44,12 @@ importers: turbo: specifier: ^2.1.2 version: 2.1.2 + typedoc: + specifier: ^0.26.7 + version: 0.26.7(typescript@5.6.2) + typedoc-plugin-markdown: + specifier: ^4.2.7 + version: 4.2.7(typedoc@0.26.7(typescript@5.6.2)) typescript: specifier: ^5.6.2 version: 5.6.2 @@ -81,8 +87,8 @@ importers: specifier: ^5.56.2 version: 5.56.2(react@18.3.1) '@tanstack/react-router': - specifier: ^1.57.17 - version: 1.57.17(@tanstack/router-generator@1.57.15)(react-dom@18.3.1(react@18.3.1))(react@18.3.1) + specifier: ^1.58.3 + version: 1.58.3(@tanstack/router-generator@1.58.1)(react-dom@18.3.1(react@18.3.1))(react@18.3.1) codeco: specifier: ^1.4.3 version: 1.4.3 @@ -106,11 +112,11 @@ importers: specifier: workspace:^ version: link:../../packages/model-instance-client '@tanstack/router-devtools': - specifier: ^1.57.17 - version: 1.57.17(@tanstack/react-router@1.57.17(@tanstack/router-generator@1.57.15)(react-dom@18.3.1(react@18.3.1))(react@18.3.1))(csstype@3.1.3)(react-dom@18.3.1(react@18.3.1))(react@18.3.1) + specifier: ^1.58.3 + version: 1.58.3(@tanstack/react-router@1.58.3(@tanstack/router-generator@1.58.1)(react-dom@18.3.1(react@18.3.1))(react@18.3.1))(csstype@3.1.3)(react-dom@18.3.1(react@18.3.1))(react@18.3.1) '@tanstack/router-plugin': - specifier: ^1.57.15 - version: 1.57.15(vite@5.4.6(@types/node@22.5.5)(sugarss@4.0.1(postcss@8.4.47)))(webpack-sources@3.2.3) + specifier: ^1.58.4 + version: 1.58.4(vite@5.4.6(@types/node@22.5.5)(sugarss@4.0.1(postcss@8.4.47)))(webpack-sources@3.2.3) '@types/react': specifier: ^18.3.7 version: 18.3.7 @@ -464,8 +470,8 @@ importers: specifier: ^5.0.2 version: 5.0.2(typescript@5.6.2)(zod@3.23.8) viem: - specifier: ^2.21.8 - version: 2.21.8(typescript@5.6.2)(zod@3.23.8) + specifier: ^2.21.9 + version: 2.21.9(typescript@5.6.2)(zod@3.23.8) devDependencies: '@didtools/pkh-ethereum': specifier: ^0.6.0 @@ -597,8 +603,8 @@ packages: resolution: {integrity: sha512-BcYH1CVJBO9tvyIZ2jVeXgSIMvGZ2FDRvDdOIVQyuklNKSsx+eppDEBq/g47Ayw+RqNFE+URvOShmf+f/qwAlA==} engines: {node: '>=6.9.0'} - '@babel/compat-data@7.25.2': - resolution: {integrity: sha512-bYcppcpKBvX4znYaPEeFau03bp89ShqNMLs+rmdptMw+heSZh9+z84d2YG+K7cYLbWwzdjtDoW/uqZmPjulClQ==} + '@babel/compat-data@7.25.4': + resolution: {integrity: sha512-+LGRog6RAsCJrrrg/IO6LGmpphNe5DiK30dGjCoxxeGv49B10/3XYGxPsAwrDlMFcFEvdAUavDT8r9k/hSyQqQ==} engines: {node: '>=6.9.0'} '@babel/core@7.25.2': @@ -647,8 +653,8 @@ packages: resolution: {integrity: sha512-xb8t9tD1MHLungh/AIoWYN+gVHaB9kwlu8gffXGSt3FFEIT7RjS+xWbc2vUD1UTZdIpKj/ab3rdqJ7ufngyi2Q==} engines: {node: '>=6.9.0'} - '@babel/helpers@7.25.0': - resolution: {integrity: sha512-MjgLZ42aCm0oGjJj8CtSM3DB8NOOf8h2l7DCTePJs29u+v7yO/RBX9nShlKMgFnRks/Q4tBAe7Hxnov9VkGwLw==} + '@babel/helpers@7.25.6': + resolution: {integrity: sha512-Xg0tn4HcfTijTwfDwYlvVCl43V6h4KyVVX2aEm4qdO/PC6L2YvzLHFdmxhoeSA3eslcE6+ZVXHgWwopXYLNq4Q==} engines: {node: '>=6.9.0'} '@babel/highlight@7.24.7': @@ -752,10 +758,6 @@ packages: resolution: {integrity: sha512-aOOgh1/5XzKvg1jvVz7AVrx2piJ2XBi227DHmbY6y+bM9H2FlN+IfecYu4Xl0cNiiVejlsCri89LUsbj8vJD9Q==} engines: {node: '>=6.9.0'} - '@babel/traverse@7.25.3': - resolution: {integrity: sha512-HefgyP1x754oGCsKmV5reSmtV7IXj/kpaE1XYY+D9G5PvKKoFfSbiS4M77MdjuwlZKDIKFCffq9rPU+H/s3ZdQ==} - engines: {node: '>=6.9.0'} - '@babel/traverse@7.25.6': resolution: {integrity: sha512-9Vrcx5ZW6UwK5tvqsj0nGpp/XzqthkT0dqIc9g1AdtygFToNtTF67XzYS//dm+SAK9cp3B9R4ZO/46p63SCjlQ==} engines: {node: '>=6.9.0'} @@ -1422,8 +1424,8 @@ packages: '@scure/base@1.1.7': resolution: {integrity: sha512-PPNYBslrLNNUQ/Yad37MHYsNQtK67EhWb6WtSvNLLPo7SdVZgkUjD6Dg+5On7zNwmskf8OX7I7Nx5oN+MIWE0g==} - '@scure/base@1.1.8': - resolution: {integrity: sha512-6CyAclxj3Nb0XT7GHK6K4zK6k2xJm6E4Ft0Ohjt4WgegiFUHEtFb2CGzmPmGBwoIhrLsqNLYfLr04Y1GePrzZg==} + '@scure/base@1.1.9': + resolution: {integrity: sha512-8YKhl8GHiNI/pU2VMaofa2Tor7PJRAjwQLBBuilkJ9L5+13yVbC7JO/wS7piioAvPSwR3JKM1IJ/u4xQzbcXKg==} '@scure/bip32@1.3.2': resolution: {integrity: sha512-N1ZhksgwD3OBlwTv3R6KFEcPojl/W4ElJOeCZdi+vuI5QmTFwLq3OFf2zd2ROpKvxFdgZ6hUpb0dx9bVNEwYCA==} @@ -1437,6 +1439,21 @@ packages: '@scure/bip39@1.4.0': resolution: {integrity: sha512-BEEm6p8IueV/ZTfQLp/0vhw4NPnT9oWf5+28nvmeUICjP99f4vr2d+qc7AVGDDtwRep6ifR43Yed9ERVmiITzw==} + '@shikijs/core@1.17.7': + resolution: {integrity: sha512-ZnIDxFu/yvje3Q8owSHaEHd+bu/jdWhHAaJ17ggjXofHx5rc4bhpCSW+OjC6smUBi5s5dd023jWtZ1gzMu/yrw==} + + '@shikijs/engine-javascript@1.17.7': + resolution: {integrity: sha512-wwSf7lKPsm+hiYQdX+1WfOXujtnUG6fnN4rCmExxa4vo+OTmvZ9B1eKauilvol/LHUPrQgW12G3gzem7pY5ckw==} + + '@shikijs/engine-oniguruma@1.17.7': + resolution: {integrity: sha512-pvSYGnVeEIconU28NEzBXqSQC/GILbuNbAHwMoSfdTBrobKAsV1vq2K4cAgiaW1TJceLV9QMGGh18hi7cCzbVQ==} + + '@shikijs/types@1.17.7': + resolution: {integrity: sha512-+qA4UyhWLH2q4EFd+0z4K7GpERDU+c+CN2XYD3sC+zjvAr5iuwD1nToXZMt1YODshjkEGEDV86G7j66bKjqDdg==} + + '@shikijs/vscode-textmate@9.2.2': + resolution: {integrity: sha512-TMp15K+GGYrWlZM8+Lnj9EaHEFmOen0WJBrfa17hF7taDOYthuPPV0GWzfd/9iMij0akS/8Yw2ikquH7uVi/fg==} + '@sinclair/typebox@0.27.8': resolution: {integrity: sha512-+Fj43pSMwJs4KRrH/938Uf+uAELIgVBmQzg/q1YG10djyfA3TnrU8N8XzqCh/okZdszqBQTZf96idMfE5lnwTA==} @@ -1549,68 +1566,68 @@ packages: chokidar: optional: true - '@swc/core-darwin-arm64@1.7.18': - resolution: {integrity: sha512-MwLc5U+VGPMZm8MjlFBjEB2wyT1EK0NNJ3tn+ps9fmxdFP+PL8EpMiY1O1F2t1ydy2OzBtZz81sycjM9RieFBg==} + '@swc/core-darwin-arm64@1.7.26': + resolution: {integrity: sha512-FF3CRYTg6a7ZVW4yT9mesxoVVZTrcSWtmZhxKCYJX9brH4CS/7PRPjAKNk6kzWgWuRoglP7hkjQcd6EpMcZEAw==} engines: {node: '>=10'} cpu: [arm64] os: [darwin] - '@swc/core-darwin-x64@1.7.18': - resolution: {integrity: sha512-IkukOQUw7/14VkHp446OkYGCZEHqZg9pTmTdBawlUyz2JwZMSn2VodCl7aFSdGCsU4Cwni8zKA8CCgkCCAELhw==} + '@swc/core-darwin-x64@1.7.26': + resolution: {integrity: sha512-az3cibZdsay2HNKmc4bjf62QVukuiMRh5sfM5kHR/JMTrLyS6vSw7Ihs3UTkZjUxkLTT8ro54LI6sV6sUQUbLQ==} engines: {node: '>=10'} cpu: [x64] os: [darwin] - '@swc/core-linux-arm-gnueabihf@1.7.18': - resolution: {integrity: sha512-ATnb6jJaBeXCqrTUawWdoOy7eP9SCI7UMcfXlYIMxX4otKKspLPAEuGA5RaNxlCcj9ObyO0J3YGbtZ6hhD2pjg==} + '@swc/core-linux-arm-gnueabihf@1.7.26': + resolution: {integrity: sha512-VYPFVJDO5zT5U3RpCdHE5v1gz4mmR8BfHecUZTmD2v1JeFY6fv9KArJUpjrHEEsjK/ucXkQFmJ0jaiWXmpOV9Q==} engines: {node: '>=10'} cpu: [arm] os: [linux] - '@swc/core-linux-arm64-gnu@1.7.18': - resolution: {integrity: sha512-poHtH7zL7lEp9K2inY90lGHJABWxURAOgWNeZqrcR5+jwIe7q5KBisysH09Zf/JNF9+6iNns+U0xgWTNJzBuGA==} + '@swc/core-linux-arm64-gnu@1.7.26': + resolution: {integrity: sha512-YKevOV7abpjcAzXrhsl+W48Z9mZvgoVs2eP5nY+uoMAdP2b3GxC0Df1Co0I90o2lkzO4jYBpTMcZlmUXLdXn+Q==} engines: {node: '>=10'} cpu: [arm64] os: [linux] - '@swc/core-linux-arm64-musl@1.7.18': - resolution: {integrity: sha512-qnNI1WmcOV7Wz1ZDyK6WrOlzLvJ01rnni8ec950mMHWkLRMP53QvCvhF3S+7gFplWBwWJTOOPPUqJp/PlSxWyQ==} + '@swc/core-linux-arm64-musl@1.7.26': + resolution: {integrity: sha512-3w8iZICMkQQON0uIcvz7+Q1MPOW6hJ4O5ETjA0LSP/tuKqx30hIniCGOgPDnv3UTMruLUnQbtBwVCZTBKR3Rkg==} engines: {node: '>=10'} cpu: [arm64] os: [linux] - '@swc/core-linux-x64-gnu@1.7.18': - resolution: {integrity: sha512-x9SCqCLzwtlqtD5At3I1a7Gco+EuXnzrJGoucmkpeQohshHuwa+cskqsXO6u1Dz0jXJEuHbBZB9va1wYYfjgFg==} + '@swc/core-linux-x64-gnu@1.7.26': + resolution: {integrity: sha512-c+pp9Zkk2lqb06bNGkR2Looxrs7FtGDMA4/aHjZcCqATgp348hOKH5WPvNLBl+yPrISuWjbKDVn3NgAvfvpH4w==} engines: {node: '>=10'} cpu: [x64] os: [linux] - '@swc/core-linux-x64-musl@1.7.18': - resolution: {integrity: sha512-qtj8iOpMMgKjzxTv+islmEY0JBsbd93nka0gzcTTmGZxKtL5jSUsYQvkxwNPZr5M9NU1fgaR3n1vE6lFmtY0IQ==} + '@swc/core-linux-x64-musl@1.7.26': + resolution: {integrity: sha512-PgtyfHBF6xG87dUSSdTJHwZ3/8vWZfNIXQV2GlwEpslrOkGqy+WaiiyE7Of7z9AvDILfBBBcJvJ/r8u980wAfQ==} engines: {node: '>=10'} cpu: [x64] os: [linux] - '@swc/core-win32-arm64-msvc@1.7.18': - resolution: {integrity: sha512-ltX/Ol9+Qu4SXmISCeuwVgAjSa8nzHTymknpozzVMgjXUoZMoz6lcynfKL1nCh5XLgqh0XNHUKLti5YFF8LrrA==} + '@swc/core-win32-arm64-msvc@1.7.26': + resolution: {integrity: sha512-9TNXPIJqFynlAOrRD6tUQjMq7KApSklK3R/tXgIxc7Qx+lWu8hlDQ/kVPLpU7PWvMMwC/3hKBW+p5f+Tms1hmA==} engines: {node: '>=10'} cpu: [arm64] os: [win32] - '@swc/core-win32-ia32-msvc@1.7.18': - resolution: {integrity: sha512-RgTcFP3wgyxnQbTCJrlgBJmgpeTXo8t807GU9GxApAXfpLZJ3swJ2GgFUmIJVdLWyffSHF5BEkF3FmF6mtH5AQ==} + '@swc/core-win32-ia32-msvc@1.7.26': + resolution: {integrity: sha512-9YngxNcG3177GYdsTum4V98Re+TlCeJEP4kEwEg9EagT5s3YejYdKwVAkAsJszzkXuyRDdnHUpYbTrPG6FiXrQ==} engines: {node: '>=10'} cpu: [ia32] os: [win32] - '@swc/core-win32-x64-msvc@1.7.18': - resolution: {integrity: sha512-XbZ0wAgzR757+DhQcnv60Y/bK9yuWPhDNRQVFFQVRsowvK3+c6EblyfUSytIidpXgyYFzlprq/9A9ZlO/wvDWw==} + '@swc/core-win32-x64-msvc@1.7.26': + resolution: {integrity: sha512-VR+hzg9XqucgLjXxA13MtV5O3C0bK0ywtLIBw/+a+O+Oc6mxFWHtdUeXDbIi5AiPbn0fjgVJMqYnyjGyyX8u0w==} engines: {node: '>=10'} cpu: [x64] os: [win32] - '@swc/core@1.7.18': - resolution: {integrity: sha512-qL9v5N5S38ijmqiQRvCFUUx2vmxWT/JJ2rswElnyaHkOHuVoAFhBB90Ywj4RKjh3R0zOjhEcemENTyF3q3G6WQ==} + '@swc/core@1.7.26': + resolution: {integrity: sha512-f5uYFf+TmMQyYIoxkn/evWhNGuUzC730dFwAKGwBVHHVoPyak1/GvJUm6i1SKl+2Hrj9oN0i3WSoWWZ4pgI8lw==} engines: {node: '>=10'} peerDependencies: '@swc/helpers': '*' @@ -1654,11 +1671,11 @@ packages: peerDependencies: react: ^18 || ^19 - '@tanstack/react-router@1.57.17': - resolution: {integrity: sha512-pvtbZWdfLMMU7JKMHcbw5XFrUF9++IIdqa7pKylVm4jW9tTQOBhewKheUKiOipSox9sxOOmNAGsu10gMfwvR3g==} + '@tanstack/react-router@1.58.3': + resolution: {integrity: sha512-cHpuzrNvRJ/FFDX+dWEw+w+NHp1eYn8j6WJlFs4nIyo6IJBJeL5DQgS5wdto+pOkqMEGAjzqTbJRU+zTcsVaSQ==} engines: {node: '>=12'} peerDependencies: - '@tanstack/router-generator': 1.57.15 + '@tanstack/router-generator': 1.58.1 react: '>=18' react-dom: '>=18' peerDependenciesMeta: @@ -1671,20 +1688,20 @@ packages: react: ^17.0.0 || ^18.0.0 react-dom: ^17.0.0 || ^18.0.0 - '@tanstack/router-devtools@1.57.17': - resolution: {integrity: sha512-F0rx1NfnD1dZ9e11IQY1DSaRYsMJVFDaVHzEAdDEULdTMGWkZ3UHhmxyfFyK+y/M/FajQIqudVfuY9MkyfrMPQ==} + '@tanstack/router-devtools@1.58.3': + resolution: {integrity: sha512-S3uLervhvPQL/7M0HTacTlZzg8joaHhCXnFTcLNOkWQtcST+YzJtJz4xQ2XyfaEjm87VrdoTMZuB3bnTgWbAfQ==} engines: {node: '>=12'} peerDependencies: - '@tanstack/react-router': ^1.57.17 + '@tanstack/react-router': ^1.58.3 react: '>=18' react-dom: '>=18' - '@tanstack/router-generator@1.57.15': - resolution: {integrity: sha512-VcUZVxdqrHZJuVJKwrQfkRcTmZk9iems/E3XBi+Ls6Hrrpx/2u4zwy4cb9btTExYecHZICWY0wwK+2XJOWE/kw==} + '@tanstack/router-generator@1.58.1': + resolution: {integrity: sha512-oj/97KWi8EHFx/w07fAuXXyhWi5xgSMCfzbB9q42c1ZdLbv8wzBo4a6PO1fCi01tpKKHUopA8dSlGIOeJDhBAA==} engines: {node: '>=12'} - '@tanstack/router-plugin@1.57.15': - resolution: {integrity: sha512-iLHa97aP8pj0ZcLvKOgdEaExuTLozVolfLBLoSjc8e4GgDIOesGRf0y80fqHiAOVZd8Y4nDsoEJB0UIGcXcbSg==} + '@tanstack/router-plugin@1.58.4': + resolution: {integrity: sha512-Ypoy+HrHwpv9A41bj7dpHhtLYavu7CU8WyuJnuFBY3SI5ZKWF7s/hMYUtVmEVwwT7fJCVQ8gcTkbfAag4uy/pA==} engines: {node: '>=12'} peerDependencies: '@rsbuild/core': '>=1.0.2' @@ -1732,6 +1749,9 @@ packages: '@types/graceful-fs@4.1.9': resolution: {integrity: sha512-olP3sd1qOEe5dXTSaFvQG+02VdRXcdytWLAZsAq1PecU8uqQAhkrnbli7DagjtXKW/Bl7YJbUsa8MPcuc8LHEQ==} + '@types/hast@3.0.4': + resolution: {integrity: sha512-WPs+bbQw5aCj+x6laNGWLH3wviHtoCv/P3+otBhbOhJgG8qtpdAMlTCxLtsTWA7LH1Oh/bFCHsBn0TPS5m30EQ==} + '@types/http-cache-semantics@4.0.4': resolution: {integrity: sha512-1m0bIFVc7eJWyve9S0RnuRgcQqF/Xd5QsUZAZeQFr1Q3/p9JWoQQEqmVy+DPTNpGXwhgIetAoYF8JSc33q29QA==} @@ -1756,6 +1776,9 @@ packages: '@types/lodash@4.17.7': resolution: {integrity: sha512-8wTvZawATi/lsmNu10/j2hk1KEP0IvjubqPE3cu1Xz7xfXXt5oCq3SNUz4fMIP4XGF9Ky+Ue2tBA3hcS7LSBlA==} + '@types/mdast@4.0.4': + resolution: {integrity: sha512-kGaNbPh1k7AFzgpud/gMdvIm5xuECykRR+JnWKQno9TAXVa6WIVCGTPvYGekIDL4uwCZQSYbUxNBSb1aUo79oA==} + '@types/minimist@1.2.5': resolution: {integrity: sha512-hov8bUuiLiyFPGyFPE1lwWhmzYbirOXQNNo40+y3zow8aFVTeyn3VWL0VFFfdNddA8S4Vf0Tc062rzyNr7Paag==} @@ -1780,6 +1803,9 @@ packages: '@types/stack-utils@2.0.3': resolution: {integrity: sha512-9aEbYZ3TbYMznPdcdr3SmIrLXwC/AKZXQeCf9Pgao5CKb8CyHuEX5jzWPTkvregvhRJHcpRO6BFoGW9ycaOkYw==} + '@types/unist@3.0.3': + resolution: {integrity: sha512-ko/gIFJRv177XgZsZcBwnqJN5x/Gien8qNOn0D5bQU/zAzVf9Zt3BlcUiLqhV9y4ARk0GbT3tnUiPNgnTXzc/Q==} + '@types/varint@6.0.3': resolution: {integrity: sha512-DHukoGWdJ2aYkveZJTB2rN2lp6m7APzVsoJQ7j/qy1fQxyamJTPD5xQzCMoJ2Qtgn0mE3wWeNOpbTyBFvF+dyA==} @@ -1789,6 +1815,9 @@ packages: '@types/yargs@17.0.32': resolution: {integrity: sha512-xQ67Yc/laOG5uMfX/093MRlGGCIBzZMarVa+gfNKJxWAIgykYpVGkBdbqEzGDDfCrVUj6Hiff4mTZ5BA6TmAog==} + '@ungap/structured-clone@1.2.0': + resolution: {integrity: sha512-zuVdFrMJiuCDQUMCzQaD6KL28MjnqqN8XnAqiEq9PNm/hCPTSGfrXCOfwj1ow4LFb/tNymJPwsNbVePc1xFqrQ==} + '@vitejs/plugin-react-swc@3.7.0': resolution: {integrity: sha512-yrknSb3Dci6svCd/qhHqhFPDSw0QtjumcqdKMoNNzmOl5lMXTTiqzjWtG4Qask2HdvvzaNgSunbQGet8/GrKdA==} peerDependencies: @@ -1990,8 +2019,8 @@ packages: resolution: {integrity: sha512-Gmy6FhYlCY7uOElZUSbxo2UCDH8owEk996gkbrpsgGtrJLM3J7jGxl9Ic7Qwwj4ivOE5AWZWRMecDdF7hqGjFA==} engines: {node: '>=10'} - caniuse-lite@1.0.30001649: - resolution: {integrity: sha512-fJegqZZ0ZX8HOWr6rcafGr72+xcgJKI9oWfDW5DrD7ExUtgZC7a7R7ZYmZqplh7XDocFdGeIFn7roAxhOeYrPQ==} + caniuse-lite@1.0.30001662: + resolution: {integrity: sha512-sgMUVwLmGseH8ZIrm1d51UbrhqMCH3jvS7gF/M6byuHOnKyLOBL7W8yz5V02OHwgLGA36o/AFhWzzh4uc5aqTA==} canonicalize@2.0.0: resolution: {integrity: sha512-ulDEYPv7asdKvqahuAY35c1selLdzDwHqugK92hfkzvlDCwXRRelDkR+Er33md/PtnpqHemgkuDPanZ4fiYZ8w==} @@ -2003,6 +2032,9 @@ packages: resolution: {integrity: sha512-XBFbEJ6WMfn9L7woc2t+EzOxF8vGqddoopKBbrhIvZBt2WIUgSlT8xLmM6Aq1xv8eWt4yOSjwxWjYeuHU3CpJA==} hasBin: true + ccount@2.0.1: + resolution: {integrity: sha512-eyrF0jiFpY+3drT6383f1qhkbGsLSifNAjA61IUjZjmLCWjItY6LB9ft9YhoDgwfmclB2zhu51Lc7+95b8NRAg==} + chalk@2.4.2: resolution: {integrity: sha512-Mti+f9lpJNcwF4tWV8/OrTTtF1gZi+f8FqlyAdouralcFWFQWF2+NgCHShjkCb+IFBLq9buZwE1xckQU4peSuQ==} engines: {node: '>=4'} @@ -2022,6 +2054,12 @@ packages: resolution: {integrity: sha512-kWWXztvZ5SBQV+eRgKFeh8q5sLuZY2+8WUIzlxWVTg+oGwY14qylx1KbKzHd8P6ZYkAg0xyIDU9JMHhyJMZ1jw==} engines: {node: '>=10'} + character-entities-html4@2.1.0: + resolution: {integrity: sha512-1v7fgQRj6hnSwFpq1Eu0ynr/CDEw0rXo2B61qXrLNdHZmPKgb7fqS1a2JwF0rISo9q77jDI8VMEHoApn8qDoZA==} + + character-entities-legacy@3.0.0: + resolution: {integrity: sha512-RpPp0asT/6ufRm//AJVwpViZbGM/MkjQFxJccQRHmISF/22NBtsHqAWmL+/pmkPWoIUJdWyeVleTl1wydHATVQ==} + chokidar@3.6.0: resolution: {integrity: sha512-7VT13fmjotKpGipCW9JEQAusEPE+Ei8nl6/g4FBAmIm0GOOLMua9NDDo/DWp0ZAxCr3cPq5ZpBqmPAQgDda2Pw==} engines: {node: '>= 8.10.0'} @@ -2078,6 +2116,9 @@ packages: colorette@1.4.0: resolution: {integrity: sha512-Y2oEozpomLn7Q3HFP7dpww7AtMJplbM9lGZP6RDfHqmbeRjiwRg4n6VM6j4KLmRke85uWEI7JqF17f3pqdRA0g==} + comma-separated-tokens@2.0.3: + resolution: {integrity: sha512-Fu4hJdvzeylCfQPp9SGWidpzrMs7tTrlu6Vb8XGaRGck8QSNZJJp538Wrb60Lax4fPwR64ViY468OIUTbRlGZg==} + commander@12.1.0: resolution: {integrity: sha512-Vw8qHK3bZM9y/P10u3Vib8o/DdkvA2OtPtZvD871QKjy74Wj1WSKFILMPRPSdUSx5RFK1arlJzEtA4PkFgnbuA==} engines: {node: '>=18'} @@ -2185,6 +2226,10 @@ packages: resolution: {integrity: sha512-v2KyNk7efxhlyHpjEvfyxaAihKKK0nWCuf6ZtqZcFFpQRG0bJ12Qsr0RpvsICMjAAZ8DOVCxrlqpxISlMHC4Kg==} engines: {node: '>=14.16'} + dequal@2.0.3: + resolution: {integrity: sha512-0je+qPKHEMohvfRTCEo3CrPG6cAzAYgmzKyxRiYSSDkS6eGJdyVJm7WaYA5ECaAD9wLB2T4EEeymA5aFVcYXCA==} + engines: {node: '>=6'} + detect-newline@3.1.0: resolution: {integrity: sha512-TLz+x/vEXm/Y7P7wn1EJFNLxYpUD4TgMosxY6fAVJUnJMbupHBOncxyWUG9OpTaH9EBD7uFI5LfEgmMOc54DsA==} engines: {node: '>=8'} @@ -2197,6 +2242,9 @@ packages: engines: {node: '>= 4.0.0'} hasBin: true + devlop@1.1.0: + resolution: {integrity: sha512-RWmIqhcFf1lRYBvNmr7qTNuyCt/7/ns2jbpp1+PalgE/rDQcBT0fioSMUpJ93irlUhC5hrg4cYqe6U+0ImW0rA==} + did-jwt@7.4.7: resolution: {integrity: sha512-Apz7nIfIHSKWIMaEP5L/K8xkwByvjezjTG0xiqwKdnNj1x8M0+Yasury5Dm/KPltxi2PlGfRPf3IejRKZrT8mQ==} @@ -2219,8 +2267,8 @@ packages: resolution: {integrity: sha512-WkrWp9GR4KXfKGYzOLmTuGVi1UWFfws377n9cc55/tb6DuqyF6pcQ5AbiHEshaDpY9v6oaSr2XCDidGmMwdzIA==} engines: {node: '>=8'} - electron-to-chromium@1.5.4: - resolution: {integrity: sha512-orzA81VqLyIGUEA77YkVA1D+N+nNfl2isJVjjmOyrlxuooZ19ynb+dOlaDTqd/idKRS9lDCSBmtzM+kyCsMnkA==} + electron-to-chromium@1.5.25: + resolution: {integrity: sha512-kMb204zvK3PsSlgvvwzI3wBIcAw15tRkYk+NQdsjdDtcQWTp2RABbMQ9rUBy8KNEOM+/E6ep+XC3AykiWZld4g==} emittery@0.13.1: resolution: {integrity: sha512-DeWwawk6r5yR9jFgnDKYt4sLS0LmHJJi3ZOnb5/JdbYwj3nW+FxQnHIjhBKz8YLC7oRNPVM9NQ47I3CVx34eqQ==} @@ -2232,6 +2280,10 @@ packages: end-of-stream@1.4.4: resolution: {integrity: sha512-+uw1inIHVPQoaVuHzRyXd21icM+cnt4CzD5rW+NC1wjOUSTOs+Te7FOv7AhN7vS9x/oIyhLP5PR1H+phQAHu5Q==} + entities@4.5.0: + resolution: {integrity: sha512-V0hjH4dGPh9Ao5p0MoRY6BVqtwCjhz6vI5LT8AJ55H+4g9/4vbHx1I54fS0XuclLhDHArPQCiMjDxjaL8fPxhw==} + engines: {node: '>=0.12'} + error-ex@1.3.2: resolution: {integrity: sha512-7dFHNmqeFSEt2ZBsCriorKnn3Z2pj+fd9kmI6QoWw4//DL+icEBfc0U7qJCisqrTsKTjw4fNFy2pW9OqStD84g==} @@ -2249,6 +2301,10 @@ packages: resolution: {integrity: sha512-ErCHMCae19vR8vQGe50xIsVomy19rg6gFu3+r3jkEO46suLMWBksvVyoGgQV+jOfl84ZSOSlmv6Gxa89PmTGmA==} engines: {node: '>=6'} + escalade@3.2.0: + resolution: {integrity: sha512-WUj2qlxaQtO4g6Pq5c29GTcWGDyd8itL8zTlipgECz3JesAiiOKotd8JU6otB3PACgG6xkJUyVhboMS+bje/jA==} + engines: {node: '>=6'} + escape-string-regexp@1.0.5: resolution: {integrity: sha512-vbRorB5FUQWvla16U8R/qgaFIya2qGzwDrNmCZuYKrbdSUMG6I1ZCGQRefkRVhuOkIGVne7BQ35DSfo1qvJqFg==} engines: {node: '>=0.8.0'} @@ -2436,6 +2492,12 @@ packages: resolution: {integrity: sha512-0hJU9SCPvmMzIBdZFqNPXWa6dqh7WdH0cII9y+CyS8rG3nL48Bclra9HmKhVVUHyPWNH5Y7xDwAB7bfgSjkUMQ==} engines: {node: '>= 0.4'} + hast-util-to-html@9.0.3: + resolution: {integrity: sha512-M17uBDzMJ9RPCqLMO92gNNUDuBSq10a25SDBI08iCCxmorf4Yy6sYHK57n9WAbRAAaU+DuR4W6GN9K4DFZesYg==} + + hast-util-whitespace@3.0.0: + resolution: {integrity: sha512-88JUN06ipLwsnv+dVn+OIYOvAuvBMy/Qoi6O7mQHxdPXpjy+Cd6xRkWwux7DKO+4sYILtLBRIKgsdpS2gQc7qw==} + hosted-git-info@4.1.0: resolution: {integrity: sha512-kyCuEOWjJqZuDbRHzL8V93NzQhwIB71oFWSyzVo+KPZI+pnQPPxucdkrOZvkLRnrf5URsQM+IJ09Dw29cRALIA==} engines: {node: '>=10'} @@ -2443,6 +2505,9 @@ packages: html-escaper@2.0.2: resolution: {integrity: sha512-H2iMtd0I4Mt5eYiapRdIDjp+XzelXQ0tFE4JS7YFwFevXXMmOp9myNrUvCg0D6ws8iqkRPBfKHgbwig1SmlLfg==} + html-void-elements@3.0.0: + resolution: {integrity: sha512-bEqo66MRXsUGxWHV5IP0PUiAWwoEjba4VCzg0LjFJBpchPaTfyfCKTG6bc5F8ucKec3q5y6qOdGyYTSBEvhCrg==} + http-cache-semantics@4.1.1: resolution: {integrity: sha512-er295DKPVsV82j5kw1Gjt+ADA/XYHsajl82cGNQG2eyoPkvgUhX+nDIyelzhIWbbsXP39EHcI6l5tYs2FYqYXQ==} @@ -2794,6 +2859,9 @@ packages: lines-and-columns@1.2.4: resolution: {integrity: sha512-7ylylesZQ/PV29jhEDl3Ufjo6ZX7gCqJr5F7PKrqc93v7fzSymt1BpwEU8nAUXs8qzzvqhbjhK5QZg6Mt/HkBg==} + linkify-it@5.0.0: + resolution: {integrity: sha512-5aHCbzQRADcdP+ATqnDuhhJ/MRIqDkZX5pyjFHRRysS8vZ5AbqGEoFIb6pYHPZ+L/OC2Lc+xT8uHVVR5CAK/wQ==} + locate-path@5.0.0: resolution: {integrity: sha512-t7hw9pI+WvuwNJXwk5zVHpyhIqzg2qTlklJOf0mVxGSbe3Fp2VieZcduNYjaLDoy6p9uGpQEGWG87WpMKlNq8g==} engines: {node: '>=8'} @@ -2826,6 +2894,9 @@ packages: resolution: {integrity: sha512-Jo6dJ04CmSjuznwJSS3pUeWmd/H0ffTlkXXgwZi+eq1UCmqQwCh+eLsYOYCwY991i2Fah4h1BEMCx4qThGbsiA==} engines: {node: '>=10'} + lunr@2.3.9: + resolution: {integrity: sha512-zTU3DaZaF3Rt9rhN3uBMGQD3dD2/vFQqnvZCDv4dl5iOzq2IZQqTxu90r4E5J+nP70J3ilqVCrbho2eWaeW8Ow==} + make-dir@4.0.0: resolution: {integrity: sha512-hXdUTZYIVOt1Ex//jAQi+wTZZpUpwBj/0QsOzqegb3rGMMeJiSEu5xLHnYfBrRV4RH2+OCSOO95Is/7x1WJ4bw==} engines: {node: '>=10'} @@ -2845,6 +2916,16 @@ packages: resolution: {integrity: sha512-LK8ArSM1wbfRPTnl+LpdxW1pwkfY6GxtM9p+STr6aDtM7ImR8jLuf4ekei43/AN0f7XDSrohzwwK57eGHSDAuA==} engines: {node: ^14.0.0 || ^16.0.0 || >=18.0.0} + markdown-it@14.1.0: + resolution: {integrity: sha512-a54IwgWPaeBCAAsv13YgmALOF1elABB08FxO9i+r4VFk5Vl4pKokRPeX8u5TCgSsPi6ec1otfLjdOpVcgbpshg==} + hasBin: true + + mdast-util-to-hast@13.2.0: + resolution: {integrity: sha512-QGYKEuUsYT9ykKBCMOEDLsU5JRObWQusAolFMeko/tYPufNkRffBAQjIE+99jbA87xv6FgmjLtwjh9wBWajwAA==} + + mdurl@2.0.0: + resolution: {integrity: sha512-Lf+9+2r+Tdp5wXDXC4PcIBjTDtq4UKjCPMQhKIuzpJNW0b96kVqSwW0bT7FhRSfmAiFYgP+SCRvdrDozfh0U5w==} + meow@10.1.5: resolution: {integrity: sha512-/d+PQ4GKmGvM9Bee/DPa8z3mXs/pkvJE2KEThngVNOqtmljC6K7NMPxtc2JeZYTmpWb9k/TmxjeL18ez3h7vCw==} engines: {node: ^12.20.0 || ^14.13.1 || >=16.0.0} @@ -2856,6 +2937,21 @@ packages: resolution: {integrity: sha512-8q7VEgMJW4J8tcfVPy8g09NcQwZdbwFEqhe/WZkoIzjn/3TGDwtOCYtXGxA3O8tPzpczCCDgv+P2P5y00ZJOOg==} engines: {node: '>= 8'} + micromark-util-character@2.1.0: + resolution: {integrity: sha512-KvOVV+X1yLBfs9dCBSopq/+G1PcgT3lAK07mC4BzXi5E7ahzMAF8oIupDDJ6mievI6F+lAATkbQQlQixJfT3aQ==} + + micromark-util-encode@2.0.0: + resolution: {integrity: sha512-pS+ROfCXAGLWCOc8egcBvT0kf27GoWMqtdarNfDcjb6YLuV5cM3ioG45Ys2qOVqeqSbjaKg72vU+Wby3eddPsA==} + + micromark-util-sanitize-uri@2.0.0: + resolution: {integrity: sha512-WhYv5UEcZrbAtlsnPuChHUAsu/iBPOVaEVsntLBIdpibO0ddy8OzavZz3iL2xVvBZOpolujSliP65Kq0/7KIYw==} + + micromark-util-symbol@2.0.0: + resolution: {integrity: sha512-8JZt9ElZ5kyTnO94muPxIGS8oyElRJaiJO8EzV6ZSyGQ1Is8xwl4Q45qU5UOg+bGH4AikWziz0iN4sFLWs8PGw==} + + micromark-util-types@2.0.0: + resolution: {integrity: sha512-oNh6S2WMHWRZrmutsRmDDfkzKtxF+bc2VxLC9dvtrDIRFln627VsFP6fLMgTryGDljgLPjkrzQSDcPrjPyDJ5w==} + micromatch@4.0.7: resolution: {integrity: sha512-LPP/3KorzCwBxfeUuZmaR6bG2kdeHSbe0P2tY3FLRU4vYrjYz5hI4QZwV0njUx3jeuKe67YukQ1LSPZBKDqO/Q==} engines: {node: '>=8.6'} @@ -2988,6 +3084,9 @@ packages: resolution: {integrity: sha512-kbpaSSGJTWdAY5KPVeMOKXSrPtr8C8C7wodJbcsd51jRnmD+GZu8Y0VoU6Dm5Z4vWr0Ig/1NKuWRKf7j5aaYSg==} engines: {node: '>=6'} + oniguruma-to-js@0.4.3: + resolution: {integrity: sha512-X0jWUcAlxORhOqqBREgPMgnshB7ZGYszBNspP+tS9hPD3l13CdaXcHbgImoHUHlrvGx/7AvFEkTRhAGYh+jzjQ==} + openapi-fetch@0.12.0: resolution: {integrity: sha512-D/g5BUGiOAKqivR5s02veJ2+cMHzrkFJKberKP4Z8Vl2VhE6MMirI6wWOgpp8wlsYCRRK7CX0NCGVL/mt6l1fA==} @@ -3150,12 +3249,19 @@ packages: resolution: {integrity: sha512-NxNv/kLguCA7p3jE8oL2aEBsrJWgAakBpgmgK6lpPWV+WuOmY6r2/zbAVnP+T8bQlA0nzHXSJSJW0Hq7ylaD2Q==} engines: {node: '>= 6'} + property-information@6.5.0: + resolution: {integrity: sha512-PgTgs/BlvHxOu8QuEN7wi5A0OmXaBcHpmCSTehcs6Uuu9IkDIEo13Hy7n898RHfrQ49vKCoGeWZSaAK01nwVig==} + pseudomap@1.0.2: resolution: {integrity: sha512-b/YwNhb8lk1Zz2+bXXpS/LK9OisiZZ1SNsSLxN1x2OXVEhW2Ckr/7mWE5vrC1ZTiJlD9g19jWszTmJsB+oEpFQ==} pump@3.0.0: resolution: {integrity: sha512-LwZy+p3SFs1Pytd/jYct4wpv49HiYCqd9Rlc5ZVdk0V+8Yzv6jR5Blk3TRmPL1ft69TxP0IMZGJ+WPFU2BFhww==} + punycode.js@2.3.1: + resolution: {integrity: sha512-uxFIHU0YlHYhDQtV4R9J6a52SLx28BCjT+4ieh7IGbgwVJWO+km431c4yRlREUAsAmt/uMjQUyQHNEPf0M39CA==} + engines: {node: '>=6'} + pure-rand@6.1.0: resolution: {integrity: sha512-bVWawvoZoBYpp6yIoQtQXHZjmz35RSVHnUOTefl8Vcjr8snTPY1wnpSPMWekcFwbxI6gtmT7rSYPFvz71ldiOA==} @@ -3251,6 +3357,9 @@ packages: regenerator-runtime@0.14.1: resolution: {integrity: sha512-dYnhHh0nJoMfnkZs6GmmhFknAGRrLznOu5nc9ML+EJxGvrx6H7teuevqVqCuPcPK//3eDrrjQhehXVx9cnkGdw==} + regex@4.3.2: + resolution: {integrity: sha512-kK/AA3A9K6q2js89+VMymcboLOlF5lZRCYJv3gzszXFHBr6kO6qLGzbm+UIugBEV8SMMKCTR59txoY6ctRHYVw==} + require-directory@2.1.1: resolution: {integrity: sha512-fGxEI7+wsG9xrvdjsrlmL22OMTTiHRwAMroiEeMgq8gzoLC/PQr7RsRDSTLUg/bZAZtF+TVIkHc6/4RIKrui+Q==} engines: {node: '>=0.10.0'} @@ -3348,6 +3457,9 @@ packages: resolution: {integrity: sha512-7++dFhtcx3353uBaq8DDR4NuxBetBzC7ZQOhmTQInHEd6bSrXdiEyzCvG07Z44UYdLShWUyXt5M/yhz8ekcb1A==} engines: {node: '>=8'} + shiki@1.17.7: + resolution: {integrity: sha512-Zf6hNtWhFyF4XP5OOsXkBTEx9JFPiN0TQx4wSe+Vqeuczewgk2vT4IZhF4gka55uelm052BD5BaHavNqUNZd+A==} + signal-exit@3.0.7: resolution: {integrity: sha512-wnD2ZE+l+SPC/uoS0vXeE9L1+0wuaMqKlfz9AMUo38JsyLSBWSFcHR1Rri62LZc12vLr1gb3jl7iwQhgwpAbGQ==} @@ -3385,6 +3497,9 @@ packages: resolution: {integrity: sha512-l3BikUxvPOcn5E74dZiq5BGsTb5yEwhaTSzccU6t4sDOH8NWJCstKO5QT2CvtFoK6F0saL7p9xHAqHOlCPJygA==} engines: {node: '>= 8'} + space-separated-tokens@2.0.2: + resolution: {integrity: sha512-PEGlAwrG8yXGXRjW32fGbg66JAlOAwbObuqVoJpv/mRgoWDQfgH1wDPvtzWyUSNAXBGSk8h755YDbbcEy3SH2Q==} + spdx-correct@3.2.0: resolution: {integrity: sha512-kN9dJbvnySHULIluDHy32WHRUu3Og7B9sbY7tsFLctQkIqnMh3hErYgdMjTYuqmcXX+lK5T1lnUt3G7zNswmZA==} @@ -3415,6 +3530,9 @@ packages: string_decoder@1.3.0: resolution: {integrity: sha512-hkRX8U1WjJFd8LsDJ2yQ/wWWxaopEsABU1XfkM8A+j0+85JAGppt16cr1Whg6KIbb4okU6Mql6BOj+uup/wKeA==} + stringify-entities@4.0.4: + resolution: {integrity: sha512-IwfBptatlO+QCJUo19AqvrPNqlVMpW9YEL2LIVY+Rpv2qsjCGxaDLNRgeGsQWJhfItebuJhsGSLjaBbNSQ+ieg==} + strip-ansi@6.0.1: resolution: {integrity: sha512-Y38VPSHcqkFrCpFnQ9vuSXmquuv5oXOKpGeT6aGrr3o3Gc9AlVa6JBfUSOCnbxGGZF+/0ooI7KrPuUSztUdU5A==} engines: {node: '>=8'} @@ -3504,6 +3622,9 @@ packages: tr46@0.0.3: resolution: {integrity: sha512-N3WMsuqV66lT30CrXNbEjx4GEwlow3v6rr4mCcv6prnfwhS01rkgyFdjPNBYd9br7LpXV1+Emh01fHnq2Gdgrw==} + trim-lines@3.0.1: + resolution: {integrity: sha512-kRj8B+YHZCc9kQYdWfJB2/oUl9rA99qbowYYBtr4ui4mZyAQ2JpvVBd/6U2YloATfqBhBTSMhTpgBHtU0Mf3Rg==} + trim-newlines@4.1.1: resolution: {integrity: sha512-jRKj0n0jXWo6kh62nA5TEh3+4igKDXLvzBJcPpiizP7oOolUrYIxmVBG9TOtHYFHoddUk6YvAkGeGoSVTXfQXQ==} engines: {node: '>=12'} @@ -3583,11 +3704,27 @@ packages: resolution: {integrity: sha512-yOGpmOAL7CkKe/91I5O3gPICmJNLJ1G4zFYVAsRHg7M64biSnPtRj0WNQt++bRkjYOqjWXrhnUw1utzmVErAdg==} engines: {node: '>=16'} + typedoc-plugin-markdown@4.2.7: + resolution: {integrity: sha512-bLsQdweSm48P9j6kGqQ3/4GCH5zu2EnURSkkxqirNc+uVFE9YK825ogDw+WbNkRHIV6eZK/1U43gT7YfglyYOg==} + engines: {node: '>= 18'} + peerDependencies: + typedoc: 0.26.x + + typedoc@0.26.7: + resolution: {integrity: sha512-gUeI/Wk99vjXXMi8kanwzyhmeFEGv1LTdTQsiyIsmSYsBebvFxhbcyAx7Zjo4cMbpLGxM4Uz3jVIjksu/I2v6Q==} + engines: {node: '>= 18'} + hasBin: true + peerDependencies: + typescript: 4.6.x || 4.7.x || 4.8.x || 4.9.x || 5.0.x || 5.1.x || 5.2.x || 5.3.x || 5.4.x || 5.5.x || 5.6.x + typescript@5.6.2: resolution: {integrity: sha512-NW8ByodCSNCwZeghjN3o+JX5OFH0Ojg6sadjEKY4huZ52TqbJTJnDo5+Tw98lSy63NZvi4n+ez5m2u5d4PkZyw==} engines: {node: '>=14.17'} hasBin: true + uc.micro@2.1.0: + resolution: {integrity: sha512-ARDJmphmdvUk6Glw7y9DQ2bFkKBHwQHLi2lsaH6PPmz/Ka9sFOBsBluozhDltWmnv9u/cF6Rt87znRTPV+yp/A==} + uint8arrays@3.1.1: resolution: {integrity: sha512-+QJa8QRnbdXVpHYjLoTpJIdCTiw9Ir62nocClWuXIq2JIh4Uta0cQsTSpFL678p2CN8B+XSApwcU+pQEqVpKWg==} @@ -3597,6 +3734,21 @@ packages: undici-types@6.19.8: resolution: {integrity: sha512-ve2KP6f/JnbPBFyobGHuerC9g1FYGn/F8n1LWTwNxCEzd6IfqTwUQcNXgEtmmQ6DlRrC1hrSrBnCZPokRrDHjw==} + unist-util-is@6.0.0: + resolution: {integrity: sha512-2qCTHimwdxLfz+YzdGfkqNlH0tLi9xjTnHddPmJwtIG9MGsdbutfTc4P+haPD7l7Cjxf/WZj+we5qfVPvvxfYw==} + + unist-util-position@5.0.0: + resolution: {integrity: sha512-fucsC7HjXvkB5R3kTCO7kUjRdrS0BJt3M/FPxmHMBOm8JQi2BsHAHFsy27E0EolP8rp0NzXsJ+jNPyDWvOJZPA==} + + unist-util-stringify-position@4.0.0: + resolution: {integrity: sha512-0ASV06AAoKCDkS2+xw5RXJywruurpbC4JZSm7nr7MOt1ojAzvyyaO+UxZf18j8FCF6kmzCZKcAgN/yu2gm2XgQ==} + + unist-util-visit-parents@6.0.1: + resolution: {integrity: sha512-L/PqWzfTP9lzzEa6CKs0k2nARxTdZduw3zyh8d2NVBnsyvHjSX4TWse388YrrQKbvI8w20fGjGlhgT96WwKykw==} + + unist-util-visit@5.0.0: + resolution: {integrity: sha512-MR04uvD+07cwl/yhVuVWAtw+3GOR/knlL55Nd/wAdblk27GCVt3lqpTivy/tkJcZoNPzTwS1Y+KMojlLDhoTzg==} + unplugin@1.14.1: resolution: {integrity: sha512-lBlHbfSFPToDYp9pjXlUEFVxYLaue9f9T1HC+4OHlmj+HnMDdz9oZY+erXfoCe/5V/7gKUSY2jpXPb9S7f0f/w==} engines: {node: '>=14.0.0'} @@ -3679,6 +3831,12 @@ packages: varintes@2.0.5: resolution: {integrity: sha512-iF3jlHLko9NrYjaUZvT3VwypP3V20KNNhT1tzqblyIyrVjNiW7HseGOhuP+apgZBp9X/8+5pxa7kNikhJeZlIw==} + vfile-message@4.0.2: + resolution: {integrity: sha512-jRDZ1IMLttGj41KcZvlrYAaI3CfqpLpfpf+Mfig13viT6NKvRzWZ+lXz0Y5D60w6uJIBAOGq9mSHf0gktF0duw==} + + vfile@6.0.3: + resolution: {integrity: sha512-KzIbH/9tXat2u30jf+smMwFCsno4wHVdNmzFyL+T/L3UGqqk6JKfVqOFOZEpZSHADH1k40ab6NUIXZq422ov3Q==} + viem@1.21.4: resolution: {integrity: sha512-BNVYdSaUjeS2zKQgPs+49e5JKocfo60Ib2yiXOWBT6LuVxY1I/6fFX3waEtpXvL1Xn4qu+BVitVtMh9lyThyhQ==} peerDependencies: @@ -3687,8 +3845,8 @@ packages: typescript: optional: true - viem@2.21.8: - resolution: {integrity: sha512-j85Z8pfgcAA7HLtLOd7k7mdyw1ogUjyCxrmwyxzlcAPE8+u8O8GySUMgOxNW/n9mazO2R8XpZ+9nUoXgesAn/g==} + viem@2.21.9: + resolution: {integrity: sha512-fWPDX2ABEo/mLiDN+wsmYJDJk0a/ZCafquxInR2+HZv/7UTgHbLgjZs4SotpEeFAYjgVThJ7A9TPmrRjaaYqvw==} peerDependencies: typescript: '>=5.0.4' peerDependenciesMeta: @@ -3805,6 +3963,11 @@ packages: yaml-ast-parser@0.0.43: resolution: {integrity: sha512-2PTINUwsRqSd+s8XxKaJWQlUuEMHJQyEuh2edBbW8KNJz0SJPwUSD2zRWqezFEdN7IzAgeuYHFUCF7o8zRdZ0A==} + yaml@2.5.1: + resolution: {integrity: sha512-bLQOjaX/ADgQ20isPJRvF0iRUHIxVhYvr53Of7wGcWlO2jvtUlH5m87DsmulFVxRpNLOnI4tB6p/oh8D7kpn9Q==} + engines: {node: '>= 14'} + hasBin: true + yargs-parser@20.2.9: resolution: {integrity: sha512-y11nGElTIV+CT3Zv9t7VKl+Q3hTQoT9a1Qzezhhl6Rp21gJ/IVTW7Z3y9EWXhuUBC2Shnf+DX0antecpAwSP8w==} engines: {node: '>=10'} @@ -3824,6 +3987,9 @@ packages: zod@3.23.8: resolution: {integrity: sha512-XBx9AXhXktjUqnepgTiE5flcKIYWi/rme0Eaj+5Y0lftuGBq+jyRu/md4WnuxqgP1ubdpNCsYEYPxrzVHD8d6g==} + zwitch@2.0.4: + resolution: {integrity: sha512-bXE4cR/kVZhKZX/RjPEflHaKVhUVl85noU3v6b8apfQEc1x4A+zBxjZ4lN8LqGd6WZ3dl98pY4o717VFmoPp+A==} + snapshots: '@adraffy/ens-normalize@1.10.0': {} @@ -3838,22 +4004,22 @@ snapshots: '@babel/highlight': 7.24.7 picocolors: 1.0.1 - '@babel/compat-data@7.25.2': {} + '@babel/compat-data@7.25.4': {} '@babel/core@7.25.2': dependencies: '@ampproject/remapping': 2.3.0 '@babel/code-frame': 7.24.7 - '@babel/generator': 7.25.0 + '@babel/generator': 7.25.6 '@babel/helper-compilation-targets': 7.25.2 '@babel/helper-module-transforms': 7.25.2(@babel/core@7.25.2) - '@babel/helpers': 7.25.0 - '@babel/parser': 7.25.3 + '@babel/helpers': 7.25.6 + '@babel/parser': 7.25.6 '@babel/template': 7.25.0 - '@babel/traverse': 7.25.3 - '@babel/types': 7.25.2 + '@babel/traverse': 7.25.6 + '@babel/types': 7.25.6 convert-source-map: 2.0.0 - debug: 4.3.6 + debug: 4.3.7(supports-color@9.4.0) gensync: 1.0.0-beta.2 json5: 2.2.3 semver: 6.3.1 @@ -3876,7 +4042,7 @@ snapshots: '@babel/helper-compilation-targets@7.25.2': dependencies: - '@babel/compat-data': 7.25.2 + '@babel/compat-data': 7.25.4 '@babel/helper-validator-option': 7.24.8 browserslist: 4.23.3 lru-cache: 5.1.1 @@ -3884,8 +4050,8 @@ snapshots: '@babel/helper-module-imports@7.24.7': dependencies: - '@babel/traverse': 7.25.3 - '@babel/types': 7.25.2 + '@babel/traverse': 7.25.6 + '@babel/types': 7.25.6 transitivePeerDependencies: - supports-color @@ -3895,7 +4061,7 @@ snapshots: '@babel/helper-module-imports': 7.24.7 '@babel/helper-simple-access': 7.24.7 '@babel/helper-validator-identifier': 7.24.7 - '@babel/traverse': 7.25.3 + '@babel/traverse': 7.25.6 transitivePeerDependencies: - supports-color @@ -3903,8 +4069,8 @@ snapshots: '@babel/helper-simple-access@7.24.7': dependencies: - '@babel/traverse': 7.25.3 - '@babel/types': 7.25.2 + '@babel/traverse': 7.25.6 + '@babel/types': 7.25.6 transitivePeerDependencies: - supports-color @@ -3914,10 +4080,10 @@ snapshots: '@babel/helper-validator-option@7.24.8': {} - '@babel/helpers@7.25.0': + '@babel/helpers@7.25.6': dependencies: '@babel/template': 7.25.0 - '@babel/types': 7.25.2 + '@babel/types': 7.25.6 '@babel/highlight@7.24.7': dependencies: @@ -4016,20 +4182,8 @@ snapshots: '@babel/template@7.25.0': dependencies: '@babel/code-frame': 7.24.7 - '@babel/parser': 7.25.3 - '@babel/types': 7.25.2 - - '@babel/traverse@7.25.3': - dependencies: - '@babel/code-frame': 7.24.7 - '@babel/generator': 7.25.0 - '@babel/parser': 7.25.3 - '@babel/template': 7.25.0 - '@babel/types': 7.25.2 - debug: 4.3.6 - globals: 11.12.0 - transitivePeerDependencies: - - supports-color + '@babel/parser': 7.25.6 + '@babel/types': 7.25.6 '@babel/traverse@7.25.6': dependencies: @@ -4711,7 +4865,7 @@ snapshots: '@scure/base@1.1.7': {} - '@scure/base@1.1.8': {} + '@scure/base@1.1.9': {} '@scure/bip32@1.3.2': dependencies: @@ -4723,7 +4877,7 @@ snapshots: dependencies: '@noble/curves': 1.4.0 '@noble/hashes': 1.4.0 - '@scure/base': 1.1.8 + '@scure/base': 1.1.9 '@scure/bip39@1.2.1': dependencies: @@ -4733,7 +4887,34 @@ snapshots: '@scure/bip39@1.4.0': dependencies: '@noble/hashes': 1.5.0 - '@scure/base': 1.1.8 + '@scure/base': 1.1.9 + + '@shikijs/core@1.17.7': + dependencies: + '@shikijs/engine-javascript': 1.17.7 + '@shikijs/engine-oniguruma': 1.17.7 + '@shikijs/types': 1.17.7 + '@shikijs/vscode-textmate': 9.2.2 + '@types/hast': 3.0.4 + hast-util-to-html: 9.0.3 + + '@shikijs/engine-javascript@1.17.7': + dependencies: + '@shikijs/types': 1.17.7 + '@shikijs/vscode-textmate': 9.2.2 + oniguruma-to-js: 0.4.3 + + '@shikijs/engine-oniguruma@1.17.7': + dependencies: + '@shikijs/types': 1.17.7 + '@shikijs/vscode-textmate': 9.2.2 + + '@shikijs/types@1.17.7': + dependencies: + '@shikijs/vscode-textmate': 9.2.2 + '@types/hast': 3.0.4 + + '@shikijs/vscode-textmate@9.2.2': {} '@sinclair/typebox@0.27.8': {} @@ -4886,10 +5067,10 @@ snapshots: '@stablelib/wipe@1.0.1': {} - '@swc/cli@0.4.0(@swc/core@1.7.18)(chokidar@4.0.0)': + '@swc/cli@0.4.0(@swc/core@1.7.26)(chokidar@4.0.0)': dependencies: '@mole-inc/bin-wrapper': 8.0.1 - '@swc/core': 1.7.18 + '@swc/core': 1.7.26 '@swc/counter': 0.1.3 commander: 8.3.0 fast-glob: 3.3.2 @@ -4901,58 +5082,58 @@ snapshots: optionalDependencies: chokidar: 4.0.0 - '@swc/core-darwin-arm64@1.7.18': + '@swc/core-darwin-arm64@1.7.26': optional: true - '@swc/core-darwin-x64@1.7.18': + '@swc/core-darwin-x64@1.7.26': optional: true - '@swc/core-linux-arm-gnueabihf@1.7.18': + '@swc/core-linux-arm-gnueabihf@1.7.26': optional: true - '@swc/core-linux-arm64-gnu@1.7.18': + '@swc/core-linux-arm64-gnu@1.7.26': optional: true - '@swc/core-linux-arm64-musl@1.7.18': + '@swc/core-linux-arm64-musl@1.7.26': optional: true - '@swc/core-linux-x64-gnu@1.7.18': + '@swc/core-linux-x64-gnu@1.7.26': optional: true - '@swc/core-linux-x64-musl@1.7.18': + '@swc/core-linux-x64-musl@1.7.26': optional: true - '@swc/core-win32-arm64-msvc@1.7.18': + '@swc/core-win32-arm64-msvc@1.7.26': optional: true - '@swc/core-win32-ia32-msvc@1.7.18': + '@swc/core-win32-ia32-msvc@1.7.26': optional: true - '@swc/core-win32-x64-msvc@1.7.18': + '@swc/core-win32-x64-msvc@1.7.26': optional: true - '@swc/core@1.7.18': + '@swc/core@1.7.26': dependencies: '@swc/counter': 0.1.3 '@swc/types': 0.1.12 optionalDependencies: - '@swc/core-darwin-arm64': 1.7.18 - '@swc/core-darwin-x64': 1.7.18 - '@swc/core-linux-arm-gnueabihf': 1.7.18 - '@swc/core-linux-arm64-gnu': 1.7.18 - '@swc/core-linux-arm64-musl': 1.7.18 - '@swc/core-linux-x64-gnu': 1.7.18 - '@swc/core-linux-x64-musl': 1.7.18 - '@swc/core-win32-arm64-msvc': 1.7.18 - '@swc/core-win32-ia32-msvc': 1.7.18 - '@swc/core-win32-x64-msvc': 1.7.18 + '@swc/core-darwin-arm64': 1.7.26 + '@swc/core-darwin-x64': 1.7.26 + '@swc/core-linux-arm-gnueabihf': 1.7.26 + '@swc/core-linux-arm64-gnu': 1.7.26 + '@swc/core-linux-arm64-musl': 1.7.26 + '@swc/core-linux-x64-gnu': 1.7.26 + '@swc/core-linux-x64-musl': 1.7.26 + '@swc/core-win32-arm64-msvc': 1.7.26 + '@swc/core-win32-ia32-msvc': 1.7.26 + '@swc/core-win32-x64-msvc': 1.7.26 '@swc/counter@0.1.3': {} - '@swc/jest@0.2.36(@swc/core@1.7.18)': + '@swc/jest@0.2.36(@swc/core@1.7.26)': dependencies: '@jest/create-cache-key-function': 29.7.0 - '@swc/core': 1.7.18 + '@swc/core': 1.7.26 '@swc/counter': 0.1.3 jsonc-parser: 3.3.1 @@ -4980,7 +5161,7 @@ snapshots: '@tanstack/query-core': 5.56.2 react: 18.3.1 - '@tanstack/react-router@1.57.17(@tanstack/router-generator@1.57.15)(react-dom@18.3.1(react@18.3.1))(react@18.3.1)': + '@tanstack/react-router@1.58.3(@tanstack/router-generator@1.58.1)(react-dom@18.3.1(react@18.3.1))(react@18.3.1)': dependencies: '@tanstack/history': 1.57.6 '@tanstack/react-store': 0.5.5(react-dom@18.3.1(react@18.3.1))(react@18.3.1) @@ -4989,7 +5170,7 @@ snapshots: tiny-invariant: 1.3.3 tiny-warning: 1.0.3 optionalDependencies: - '@tanstack/router-generator': 1.57.15 + '@tanstack/router-generator': 1.58.1 '@tanstack/react-store@0.5.5(react-dom@18.3.1(react@18.3.1))(react@18.3.1)': dependencies: @@ -4998,9 +5179,9 @@ snapshots: react-dom: 18.3.1(react@18.3.1) use-sync-external-store: 1.2.2(react@18.3.1) - '@tanstack/router-devtools@1.57.17(@tanstack/react-router@1.57.17(@tanstack/router-generator@1.57.15)(react-dom@18.3.1(react@18.3.1))(react@18.3.1))(csstype@3.1.3)(react-dom@18.3.1(react@18.3.1))(react@18.3.1)': + '@tanstack/router-devtools@1.58.3(@tanstack/react-router@1.58.3(@tanstack/router-generator@1.58.1)(react-dom@18.3.1(react@18.3.1))(react@18.3.1))(csstype@3.1.3)(react-dom@18.3.1(react@18.3.1))(react@18.3.1)': dependencies: - '@tanstack/react-router': 1.57.17(@tanstack/router-generator@1.57.15)(react-dom@18.3.1(react@18.3.1))(react@18.3.1) + '@tanstack/react-router': 1.58.3(@tanstack/router-generator@1.58.1)(react-dom@18.3.1(react@18.3.1))(react@18.3.1) clsx: 2.1.1 goober: 2.1.14(csstype@3.1.3) react: 18.3.1 @@ -5008,14 +5189,14 @@ snapshots: transitivePeerDependencies: - csstype - '@tanstack/router-generator@1.57.15': + '@tanstack/router-generator@1.58.1': dependencies: '@tanstack/virtual-file-routes': 1.56.0 prettier: 3.3.3 tsx: 4.19.1 zod: 3.23.8 - '@tanstack/router-plugin@1.57.15(vite@5.4.6(@types/node@22.5.5)(sugarss@4.0.1(postcss@8.4.47)))(webpack-sources@3.2.3)': + '@tanstack/router-plugin@1.58.4(vite@5.4.6(@types/node@22.5.5)(sugarss@4.0.1(postcss@8.4.47)))(webpack-sources@3.2.3)': dependencies: '@babel/core': 7.25.2 '@babel/generator': 7.25.6 @@ -5025,7 +5206,7 @@ snapshots: '@babel/template': 7.25.0 '@babel/traverse': 7.25.6 '@babel/types': 7.25.6 - '@tanstack/router-generator': 1.57.15 + '@tanstack/router-generator': 1.58.1 '@tanstack/virtual-file-routes': 1.56.0 '@types/babel__core': 7.20.5 '@types/babel__generator': 7.6.8 @@ -5085,6 +5266,10 @@ snapshots: dependencies: '@types/node': 22.5.5 + '@types/hast@3.0.4': + dependencies: + '@types/unist': 3.0.3 + '@types/http-cache-semantics@4.0.4': {} '@types/istanbul-lib-coverage@2.0.6': {} @@ -5112,6 +5297,10 @@ snapshots: '@types/lodash@4.17.7': {} + '@types/mdast@4.0.4': + dependencies: + '@types/unist': 3.0.3 + '@types/minimist@1.2.5': {} '@types/node@22.5.5': @@ -5137,6 +5326,8 @@ snapshots: '@types/stack-utils@2.0.3': {} + '@types/unist@3.0.3': {} + '@types/varint@6.0.3': dependencies: '@types/node': 22.5.5 @@ -5147,9 +5338,11 @@ snapshots: dependencies: '@types/yargs-parser': 21.0.3 + '@ungap/structured-clone@1.2.0': {} + '@vitejs/plugin-react-swc@3.7.0(vite@5.4.6(@types/node@22.5.5)(sugarss@4.0.1(postcss@8.4.47)))': dependencies: - '@swc/core': 1.7.18 + '@swc/core': 1.7.26 vite: 5.4.6(@types/node@22.5.5)(sugarss@4.0.1(postcss@8.4.47)) transitivePeerDependencies: - '@swc/helpers' @@ -5321,8 +5514,8 @@ snapshots: browserslist@4.23.3: dependencies: - caniuse-lite: 1.0.30001649 - electron-to-chromium: 1.5.4 + caniuse-lite: 1.0.30001662 + electron-to-chromium: 1.5.25 node-releases: 2.0.18 update-browserslist-db: 1.1.0(browserslist@4.23.3) @@ -5366,7 +5559,7 @@ snapshots: camelcase@6.3.0: {} - caniuse-lite@1.0.30001649: {} + caniuse-lite@1.0.30001662: {} canonicalize@2.0.0: {} @@ -5379,6 +5572,8 @@ snapshots: cborg@4.2.3: {} + ccount@2.0.1: {} + chalk@2.4.2: dependencies: ansi-styles: 3.2.1 @@ -5396,6 +5591,10 @@ snapshots: char-regex@1.0.2: {} + character-entities-html4@2.1.0: {} + + character-entities-legacy@3.0.0: {} + chokidar@3.6.0: dependencies: anymatch: 3.1.3 @@ -5453,6 +5652,8 @@ snapshots: colorette@1.4.0: {} + comma-separated-tokens@2.0.3: {} + commander@12.1.0: {} commander@8.3.0: {} @@ -5559,6 +5760,8 @@ snapshots: rimraf: 3.0.2 slash: 4.0.0 + dequal@2.0.3: {} + detect-newline@3.1.0: {} detect-node-es@1.1.0: {} @@ -5570,6 +5773,10 @@ snapshots: transitivePeerDependencies: - supports-color + devlop@1.1.0: + dependencies: + dequal: 2.0.3 + did-jwt@7.4.7: dependencies: '@noble/ciphers': 0.4.1 @@ -5624,7 +5831,7 @@ snapshots: dependencies: path-type: 4.0.0 - electron-to-chromium@1.5.4: {} + electron-to-chromium@1.5.25: {} emittery@0.13.1: {} @@ -5634,6 +5841,8 @@ snapshots: dependencies: once: 1.4.0 + entities@4.5.0: {} + error-ex@1.3.2: dependencies: is-arrayish: 0.2.1 @@ -5693,6 +5902,8 @@ snapshots: escalade@3.1.2: {} + escalade@3.2.0: {} + escape-string-regexp@1.0.5: {} escape-string-regexp@2.0.0: {} @@ -5888,12 +6099,32 @@ snapshots: dependencies: function-bind: 1.1.2 + hast-util-to-html@9.0.3: + dependencies: + '@types/hast': 3.0.4 + '@types/unist': 3.0.3 + ccount: 2.0.1 + comma-separated-tokens: 2.0.3 + hast-util-whitespace: 3.0.0 + html-void-elements: 3.0.0 + mdast-util-to-hast: 13.2.0 + property-information: 6.5.0 + space-separated-tokens: 2.0.2 + stringify-entities: 4.0.4 + zwitch: 2.0.4 + + hast-util-whitespace@3.0.0: + dependencies: + '@types/hast': 3.0.4 + hosted-git-info@4.1.0: dependencies: lru-cache: 6.0.0 html-escaper@2.0.2: {} + html-void-elements@3.0.0: {} + http-cache-semantics@4.1.1: {} http2-wrapper@1.0.3: @@ -6396,6 +6627,10 @@ snapshots: lines-and-columns@1.2.4: {} + linkify-it@5.0.0: + dependencies: + uc.micro: 2.1.0 + locate-path@5.0.0: dependencies: p-locate: 4.1.0 @@ -6427,6 +6662,8 @@ snapshots: dependencies: yallist: 4.0.0 + lunr@2.3.9: {} + make-dir@4.0.0: dependencies: semver: 7.6.3 @@ -6441,6 +6678,29 @@ snapshots: mapmoize@1.2.1: {} + markdown-it@14.1.0: + dependencies: + argparse: 2.0.1 + entities: 4.5.0 + linkify-it: 5.0.0 + mdurl: 2.0.0 + punycode.js: 2.3.1 + uc.micro: 2.1.0 + + mdast-util-to-hast@13.2.0: + dependencies: + '@types/hast': 3.0.4 + '@types/mdast': 4.0.4 + '@ungap/structured-clone': 1.2.0 + devlop: 1.1.0 + micromark-util-sanitize-uri: 2.0.0 + trim-lines: 3.0.1 + unist-util-position: 5.0.0 + unist-util-visit: 5.0.0 + vfile: 6.0.3 + + mdurl@2.0.0: {} + meow@10.1.5: dependencies: '@types/minimist': 1.2.5 @@ -6460,6 +6720,23 @@ snapshots: merge2@1.4.1: {} + micromark-util-character@2.1.0: + dependencies: + micromark-util-symbol: 2.0.0 + micromark-util-types: 2.0.0 + + micromark-util-encode@2.0.0: {} + + micromark-util-sanitize-uri@2.0.0: + dependencies: + micromark-util-character: 2.1.0 + micromark-util-encode: 2.0.0 + micromark-util-symbol: 2.0.0 + + micromark-util-symbol@2.0.0: {} + + micromark-util-types@2.0.0: {} + micromatch@4.0.7: dependencies: braces: 3.0.3 @@ -6573,6 +6850,10 @@ snapshots: dependencies: mimic-fn: 2.1.0 + oniguruma-to-js@0.4.3: + dependencies: + regex: 4.3.2 + openapi-fetch@0.12.0: dependencies: openapi-typescript-helpers: 0.0.13 @@ -6720,6 +7001,8 @@ snapshots: kleur: 3.0.3 sisteransi: 1.0.5 + property-information@6.5.0: {} + pseudomap@1.0.2: {} pump@3.0.0: @@ -6727,6 +7010,8 @@ snapshots: end-of-stream: 1.4.4 once: 1.4.0 + punycode.js@2.3.1: {} + pure-rand@6.1.0: {} queue-microtask@1.2.3: {} @@ -6824,6 +7109,8 @@ snapshots: regenerator-runtime@0.14.1: {} + regex@4.3.2: {} + require-directory@2.1.1: {} require-from-string@2.0.2: {} @@ -6916,6 +7203,15 @@ snapshots: shebang-regex@3.0.0: {} + shiki@1.17.7: + dependencies: + '@shikijs/core': 1.17.7 + '@shikijs/engine-javascript': 1.17.7 + '@shikijs/engine-oniguruma': 1.17.7 + '@shikijs/types': 1.17.7 + '@shikijs/vscode-textmate': 9.2.2 + '@types/hast': 3.0.4 + signal-exit@3.0.7: {} sisteransi@1.0.5: {} @@ -6943,6 +7239,8 @@ snapshots: source-map@0.7.4: {} + space-separated-tokens@2.0.2: {} + spdx-correct@3.2.0: dependencies: spdx-expression-parse: 3.0.1 @@ -6978,6 +7276,11 @@ snapshots: dependencies: safe-buffer: 5.2.1 + stringify-entities@4.0.4: + dependencies: + character-entities-html4: 2.1.0 + character-entities-legacy: 3.0.0 + strip-ansi@6.0.1: dependencies: ansi-regex: 5.0.1 @@ -7048,6 +7351,8 @@ snapshots: tr46@0.0.3: {} + trim-lines@3.0.1: {} + trim-newlines@4.1.1: {} trim-repeated@2.0.0: @@ -7109,8 +7414,23 @@ snapshots: type-fest@4.26.1: {} + typedoc-plugin-markdown@4.2.7(typedoc@0.26.7(typescript@5.6.2)): + dependencies: + typedoc: 0.26.7(typescript@5.6.2) + + typedoc@0.26.7(typescript@5.6.2): + dependencies: + lunr: 2.3.9 + markdown-it: 14.1.0 + minimatch: 9.0.5 + shiki: 1.17.7 + typescript: 5.6.2 + yaml: 2.5.1 + typescript@5.6.2: {} + uc.micro@2.1.0: {} + uint8arrays@3.1.1: dependencies: multiformats: 9.9.0 @@ -7121,6 +7441,29 @@ snapshots: undici-types@6.19.8: {} + unist-util-is@6.0.0: + dependencies: + '@types/unist': 3.0.3 + + unist-util-position@5.0.0: + dependencies: + '@types/unist': 3.0.3 + + unist-util-stringify-position@4.0.0: + dependencies: + '@types/unist': 3.0.3 + + unist-util-visit-parents@6.0.1: + dependencies: + '@types/unist': 3.0.3 + unist-util-is: 6.0.0 + + unist-util-visit@5.0.0: + dependencies: + '@types/unist': 3.0.3 + unist-util-is: 6.0.0 + unist-util-visit-parents: 6.0.1 + unplugin@1.14.1(webpack-sources@3.2.3): dependencies: acorn: 8.12.1 @@ -7131,8 +7474,8 @@ snapshots: update-browserslist-db@1.1.0(browserslist@4.23.3): dependencies: browserslist: 4.23.3 - escalade: 3.1.2 - picocolors: 1.0.1 + escalade: 3.2.0 + picocolors: 1.1.0 uri-js-replace@1.0.1: {} @@ -7189,6 +7532,16 @@ snapshots: varintes@2.0.5: {} + vfile-message@4.0.2: + dependencies: + '@types/unist': 3.0.3 + unist-util-stringify-position: 4.0.0 + + vfile@6.0.3: + dependencies: + '@types/unist': 3.0.3 + vfile-message: 4.0.2 + viem@1.21.4(typescript@5.6.2)(zod@3.23.8): dependencies: '@adraffy/ens-normalize': 1.10.0 @@ -7206,7 +7559,7 @@ snapshots: - utf-8-validate - zod - viem@2.21.8(typescript@5.6.2)(zod@3.23.8): + viem@2.21.9(typescript@5.6.2)(zod@3.23.8): dependencies: '@adraffy/ens-normalize': 1.10.0 '@noble/curves': 1.4.0 @@ -7290,6 +7643,8 @@ snapshots: yaml-ast-parser@0.0.43: {} + yaml@2.5.1: {} + yargs-parser@20.2.9: {} yargs-parser@21.1.1: {} @@ -7307,3 +7662,5 @@ snapshots: yocto-queue@0.1.0: {} zod@3.23.8: {} + + zwitch@2.0.4: {} diff --git a/tsconfig.build.json b/tsconfig.build.json index 11de2b1..244a6b8 100644 --- a/tsconfig.build.json +++ b/tsconfig.build.json @@ -14,7 +14,8 @@ "noFallthroughCasesInSwitch": true, "moduleResolution": "node", "resolveJsonModule": true, - "esModuleInterop": true + "esModuleInterop": true, + "skipLibCheck": true }, "include": ["./src"] } diff --git a/typedoc.json b/typedoc.json new file mode 100644 index 0000000..7e411d6 --- /dev/null +++ b/typedoc.json @@ -0,0 +1,24 @@ +{ + "$schema": "https://typedoc-plugin-markdown.org/schema.json", + "entryPointStrategy": "packages", + "entryPoints": [ + "packages/events", + "packages/http-client", + "packages/identifiers", + "packages/model-client", + "packages/model-instance-client", + "packages/model-instance-protocol", + "packages/model-protocol" + ], + "name": "Ceramic SDK", + "packageOptions": { + "entryPoints": ["src/index.ts"], + "excludeExternals": true, + "excludeInternal": true, + "includeVersion": true, + "readme": "none" + }, + "out": "./docs", + "plugin": ["typedoc-plugin-markdown"], + "readme": "none" +}