From 6acf5c7ed28bb18ccb0e455ddab2ac9153f99dab Mon Sep 17 00:00:00 2001 From: Paul Le Cam Date: Tue, 24 Sep 2024 10:45:22 +0100 Subject: [PATCH 1/7] Add stream client classes --- apps/explorer/package.json | 12 +- package.json | 6 +- packages/http-client/package.json | 4 +- packages/http-client/src/index.ts | 9 + packages/model-client/package.json | 8 +- packages/model-client/src/index.ts | 41 +- packages/model-client/test/lib.test.ts | 46 +- packages/model-instance-client/package.json | 3 +- packages/model-instance-client/src/client.ts | 94 +++ packages/model-instance-client/src/index.ts | 7 + .../model-instance-client/test/lib.test.ts | 87 +++ packages/test-utils/package.json | 2 +- pnpm-lock.yaml | 540 +++++++++--------- 13 files changed, 566 insertions(+), 293 deletions(-) create mode 100644 packages/model-instance-client/src/client.ts diff --git a/apps/explorer/package.json b/apps/explorer/package.json index 954672f..5e7b964 100644 --- a/apps/explorer/package.json +++ b/apps/explorer/package.json @@ -22,9 +22,9 @@ "@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.7", "codeco": "^1.4.3", - "jotai": "^2.9.2", + "jotai": "^2.10.0", "multiformats": "^13.3.0", "react": "^18.3.1", "react-dom": "^18.3.1" @@ -32,9 +32,9 @@ "devDependencies": { "@ceramic-sdk/model-client": "workspace:^", "@ceramic-sdk/model-instance-client": "workspace:^", - "@tanstack/router-devtools": "^1.57.17", - "@tanstack/router-plugin": "^1.57.15", - "@types/react": "^18.3.7", + "@tanstack/router-devtools": "^1.58.7", + "@tanstack/router-plugin": "^1.58.4", + "@types/react": "^18.3.8", "@types/react-dom": "^18.3.0", "@vitejs/plugin-react-swc": "^3.5.0", "postcss": "^8.4.47", @@ -42,6 +42,6 @@ "postcss-simple-vars": "^7.0.1", "ts-essentials": "^10.0.2", "typescript": "^5.6.2", - "vite": "^5.4.6" + "vite": "^5.4.7" } } diff --git a/package.json b/package.json index 4ad035a..28871a8 100644 --- a/package.json +++ b/package.json @@ -10,17 +10,17 @@ "test:ci": "turbo run test:ci -- --passWithNoTests" }, "devDependencies": { - "@biomejs/biome": "1.9.1", + "@biomejs/biome": "1.9.2", "@jest/globals": "^29.7.0", "@skypack/package-check": "^0.2.2", "@swc/cli": "^0.4.0", "@swc/core": "^1.7.11", "@swc/jest": "^0.2.36", "@types/jest": "^29.5.13", - "@types/node": "^22.5.5", + "@types/node": "^22.6.1", "del-cli": "^5.1.0", "jest": "^29.7.0", - "tsx": "^4.19.0", + "tsx": "^4.19.1", "turbo": "^2.1.2", "typescript": "^5.6.2" }, diff --git a/packages/http-client/package.json b/packages/http-client/package.json index 5dc1def..918a4ad 100644 --- a/packages/http-client/package.json +++ b/packages/http-client/package.json @@ -34,13 +34,13 @@ }, "dependencies": { "@ceramic-sdk/events": "workspace:^", - "openapi-fetch": "^0.12.0" + "openapi-fetch": "^0.12.2" }, "devDependencies": { "cartonne": "^3.0.1", "codeco": "^1.4.3", "multiformats": "^13.3.0", - "openapi-typescript": "^7.4.0", + "openapi-typescript": "^7.4.1", "type-fest": "^4.26.1" }, "jest": { diff --git a/packages/http-client/src/index.ts b/packages/http-client/src/index.ts index 3307195..fe11712 100644 --- a/packages/http-client/src/index.ts +++ b/packages/http-client/src/index.ts @@ -121,3 +121,12 @@ export class CeramicClient { } } } + +/** @internal */ +export function getCeramicClient( + ceramic: CeramicClient | string, +): CeramicClient { + return typeof ceramic === 'string' + ? new CeramicClient({ url: ceramic }) + : ceramic +} diff --git a/packages/model-client/package.json b/packages/model-client/package.json index 20628b8..564309e 100644 --- a/packages/model-client/package.json +++ b/packages/model-client/package.json @@ -33,12 +33,14 @@ }, "dependencies": { "@ceramic-sdk/events": "workspace:^", - "@ceramic-sdk/model-protocol": "workspace:^", - "dids": "^5.0.2" + "@ceramic-sdk/http-client": "workspace:^", + "@ceramic-sdk/model-protocol": "workspace:^" }, "devDependencies": { + "@ceramic-sdk/identifiers": "workspace:^", "@ceramic-sdk/test-utils": "workspace:^", - "@didtools/key-did": "^1.0.0" + "@didtools/key-did": "^1.0.0", + "dids": "^5.0.2" }, "jest": { "extensionsToTreatAsEsm": [".ts"], diff --git a/packages/model-client/src/index.ts b/packages/model-client/src/index.ts index e02ec46..2f80f47 100644 --- a/packages/model-client/src/index.ts +++ b/packages/model-client/src/index.ts @@ -1,12 +1,15 @@ import { type PartialInitEventHeader, - type SignedEvent, + SignedEvent, createSignedInitEvent, } from '@ceramic-sdk/events' +import { type CeramicClient, getCeramicClient } from '@ceramic-sdk/http-client' +import type { StreamID } from '@ceramic-sdk/identifiers' import { MODEL, type ModelDefinition, assertValidModelContent, + getModelStreamID, validateController, } from '@ceramic-sdk/model-protocol' import type { DID } from 'dids' @@ -26,3 +29,39 @@ export async function createInitEvent( await validateController(controller, event.cacaoBlock) return event } + +export type ModelClientParams = { + ceramic: CeramicClient | string + did?: DID +} + +export class ModelClient { + #ceramic: CeramicClient + #did?: DID + + constructor(params: ModelClientParams) { + this.#ceramic = getCeramicClient(params.ceramic) + this.#did = params.did + } + + /** @private */ + _getDID(provided?: DID): DID { + if (provided != null) { + return provided + } + if (this.#did != null) { + return this.#did + } + throw new Error('Missing DID') + } + + async postModel( + definition: ModelDefinition, + useDID?: DID, + ): Promise { + const did = this._getDID(useDID) + const event = await createInitEvent(did, definition) + const cid = await this.#ceramic.postEventType(SignedEvent, event) + return getModelStreamID(cid) + } +} diff --git a/packages/model-client/test/lib.test.ts b/packages/model-client/test/lib.test.ts index 606befa..a3ea433 100644 --- a/packages/model-client/test/lib.test.ts +++ b/packages/model-client/test/lib.test.ts @@ -1,12 +1,17 @@ import { assertSignedEvent } from '@ceramic-sdk/events' +import type { CeramicClient } from '@ceramic-sdk/http-client' +import { StreamID, randomCID } from '@ceramic-sdk/identifiers' import { MODEL_RESOURCE_URI, type ModelDefinition, + STREAM_TYPE_ID, } from '@ceramic-sdk/model-protocol' import { EthereumDID } from '@ceramic-sdk/test-utils' import { getAuthenticatedDID } from '@didtools/key-did' +import { jest } from '@jest/globals' +import { DID } from 'dids' -import { createInitEvent } from '../src/index.js' +import { ModelClient, createInitEvent } from '../src/index.js' const authenticatedDID = await getAuthenticatedDID(new Uint8Array(32)) @@ -69,3 +74,42 @@ describe('createInitEvent()', () => { assertSignedEvent(event) }) }) + +describe('ModelClient', () => { + describe('_getDID() method', () => { + test('throws if no DID is provided or set in the constructor', () => { + const client = new ModelClient({ ceramic: 'http://localhost:5101' }) + expect(() => client._getDID()).toThrow('Missing DID') + }) + + test('returns the DID set in the constructor', () => { + const client = new ModelClient({ + ceramic: 'http://localhost:5101', + did: authenticatedDID, + }) + expect(client._getDID()).toBe(authenticatedDID) + }) + + test('returns the DID provided as argument', async () => { + const did = new DID() + const client = new ModelClient({ + ceramic: 'http://localhost:5101', + did: authenticatedDID, + }) + expect(client._getDID(did)).toBe(did) + }) + }) + + describe('postDeterministicInit() method', () => { + test('posts the signed event and returns the model StreamID', async () => { + const postEventType = jest.fn(() => randomCID()) + const ceramic = { postEventType } as unknown as CeramicClient + const client = new ModelClient({ ceramic, did: authenticatedDID }) + + const id = await client.postModel(testModelV1) + expect(postEventType).toHaveBeenCalled() + expect(id).toBeInstanceOf(StreamID) + expect(id.type).toBe(STREAM_TYPE_ID) + }) + }) +}) diff --git a/packages/model-instance-client/package.json b/packages/model-instance-client/package.json index 96e6fe8..4a6c2ae 100644 --- a/packages/model-instance-client/package.json +++ b/packages/model-instance-client/package.json @@ -33,12 +33,13 @@ }, "dependencies": { "@ceramic-sdk/events": "workspace:^", + "@ceramic-sdk/http-client": "workspace:^", + "@ceramic-sdk/identifiers": "workspace:^", "@ceramic-sdk/model-instance-protocol": "workspace:^", "@didtools/codecs": "^3.0.0", "fast-json-patch": "^3.1.1" }, "devDependencies": { - "@ceramic-sdk/identifiers": "workspace:^", "@didtools/key-did": "^1.0.0", "dids": "^5.0.2", "uint8arrays": "^5.1.0" diff --git a/packages/model-instance-client/src/client.ts b/packages/model-instance-client/src/client.ts new file mode 100644 index 0000000..0ad0ca6 --- /dev/null +++ b/packages/model-instance-client/src/client.ts @@ -0,0 +1,94 @@ +import { InitEventPayload, SignedEvent } from '@ceramic-sdk/events' +import { type CeramicClient, getCeramicClient } from '@ceramic-sdk/http-client' +import { CommitID, type StreamID } from '@ceramic-sdk/identifiers' +import { getStreamID } from '@ceramic-sdk/model-instance-protocol' +import type { DIDString } from '@didtools/codecs' +import type { DID } from 'dids' + +import { + type CreateDataEventParams, + type CreateInitEventParams, + createDataEvent, + createInitEvent, + getDeterministicInitEventPayload, +} from './events.js' +import type { UnknownContent } from './types.js' + +export type PostDeterministicInitParams = { + model: StreamID + controller: DIDString | string + uniqueValue?: Uint8Array +} + +export type PostSignedInitParams = + Omit, 'controller'> & { + controller?: DID + } + +export type PostDataParams = Omit< + CreateDataEventParams, + 'controller' +> & { + controller?: DID +} + +export type DocumentClientParams = { + ceramic: CeramicClient | string + did?: DID +} + +export class DocumentClient { + #ceramic: CeramicClient + #did?: DID + + constructor(params: DocumentClientParams) { + this.#ceramic = getCeramicClient(params.ceramic) + this.#did = params.did + } + + _getDID(provided?: DID): DID { + if (provided != null) { + return provided + } + if (this.#did != null) { + return this.#did + } + throw new Error('Missing DID') + } + + async postDeterministicInit( + params: PostDeterministicInitParams, + ): Promise { + const event = getDeterministicInitEventPayload( + params.model, + params.controller, + params.uniqueValue, + ) + const cid = await this.#ceramic.postEventType(InitEventPayload, event) + return CommitID.fromStream(getStreamID(cid)) + } + + async postSignedInit( + params: PostSignedInitParams, + ): Promise { + const { controller, ...rest } = params + const event = await createInitEvent({ + ...rest, + controller: this._getDID(controller), + }) + const cid = await this.#ceramic.postEventType(SignedEvent, event) + return CommitID.fromStream(getStreamID(cid)) + } + + async postData( + params: PostDataParams, + ): Promise { + const { controller, ...rest } = params + const event = await createDataEvent({ + ...rest, + controller: this._getDID(controller), + }) + const cid = await this.#ceramic.postEventType(SignedEvent, event) + return CommitID.fromStream(params.currentID.baseID, cid) + } +} diff --git a/packages/model-instance-client/src/index.ts b/packages/model-instance-client/src/index.ts index 95cb652..381eb5b 100644 --- a/packages/model-instance-client/src/index.ts +++ b/packages/model-instance-client/src/index.ts @@ -1,3 +1,10 @@ +export { + type DocumentClientParams, + DocumentClient, + type PostDataParams, + type PostDeterministicInitParams, + type PostSignedInitParams, +} from './client.js' export { type CreateDataEventParams, type CreateInitEventParams, diff --git a/packages/model-instance-client/test/lib.test.ts b/packages/model-instance-client/test/lib.test.ts index c84010f..d3bdef0 100644 --- a/packages/model-instance-client/test/lib.test.ts +++ b/packages/model-instance-client/test/lib.test.ts @@ -1,13 +1,18 @@ import { assertSignedEvent, getSignedEventPayload } from '@ceramic-sdk/events' +import type { CeramicClient } from '@ceramic-sdk/http-client' import { CommitID, randomCID, randomStreamID } from '@ceramic-sdk/identifiers' import { DataInitEventPayload, DocumentDataEventPayload, + STREAM_TYPE_ID, } from '@ceramic-sdk/model-instance-protocol' import { getAuthenticatedDID } from '@didtools/key-did' +import { jest } from '@jest/globals' +import { DID } from 'dids' import { equals } from 'uint8arrays' import { + DocumentClient, createDataEvent, createInitEvent, getDeterministicInitEvent, @@ -130,3 +135,85 @@ describe('createDataEvent()', () => { expect(payload.header).toEqual({ shouldIndex: true }) }) }) + +describe('DocumentClient', () => { + describe('_getDID() method', () => { + test('throws if no DID is provided or set in the constructor', () => { + const client = new DocumentClient({ ceramic: 'http://localhost:5101' }) + expect(() => client._getDID()).toThrow('Missing DID') + }) + + test('returns the DID set in the constructor', () => { + const client = new DocumentClient({ + ceramic: 'http://localhost:5101', + did: authenticatedDID, + }) + expect(client._getDID()).toBe(authenticatedDID) + }) + + test('returns the DID provided as argument', async () => { + const did = new DID() + const client = new DocumentClient({ + ceramic: 'http://localhost:5101', + did: authenticatedDID, + }) + expect(client._getDID(did)).toBe(did) + }) + }) + + describe('postDeterministicInit() method', () => { + test('posts the deterministic init event and returns the MID init CommitID', async () => { + const postEventType = jest.fn(() => randomCID()) + const ceramic = { postEventType } as unknown as CeramicClient + const client = new DocumentClient({ ceramic, did: authenticatedDID }) + + const id = await client.postDeterministicInit({ + controller: 'did:key:123', + model: randomStreamID(), + }) + expect(postEventType).toHaveBeenCalled() + expect(id).toBeInstanceOf(CommitID) + expect(id.baseID.type).toBe(STREAM_TYPE_ID) + }) + }) + + describe('postSignedInit() method', () => { + test('posts the signed init event and returns the MID init CommitID', async () => { + const postEventType = jest.fn(() => randomCID()) + const ceramic = { postEventType } as unknown as CeramicClient + const client = new DocumentClient({ ceramic, did: authenticatedDID }) + + const id = await client.postSignedInit({ + content: { test: true }, + controller: authenticatedDID, + model: randomStreamID(), + }) + expect(postEventType).toHaveBeenCalled() + expect(id).toBeInstanceOf(CommitID) + expect(id.baseID.type).toBe(STREAM_TYPE_ID) + }) + }) + + describe('postData() method', () => { + test('posts the signed data event and returns the CommitID', async () => { + const postEventType = jest.fn(() => randomCID()) + const ceramic = { postEventType } as unknown as CeramicClient + const client = new DocumentClient({ ceramic, did: authenticatedDID }) + + const initCommitID = await client.postSignedInit({ + content: { test: 0 }, + controller: authenticatedDID, + model: randomStreamID(), + }) + expect(postEventType).toHaveBeenCalledTimes(1) + + const dataCommitID = await client.postData({ + controller: authenticatedDID, + currentID: initCommitID, + newContent: { test: 1 }, + }) + expect(dataCommitID).toBeInstanceOf(CommitID) + expect(dataCommitID.baseID.equals(initCommitID.baseID)).toBe(true) + }) + }) +}) diff --git a/packages/test-utils/package.json b/packages/test-utils/package.json index d1f47f9..cfd8492 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.14" }, "devDependencies": { "@didtools/pkh-ethereum": "^0.6.0" diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml index b9a88eb..3d5bfc1 100644 --- a/pnpm-lock.yaml +++ b/pnpm-lock.yaml @@ -9,8 +9,8 @@ importers: .: devDependencies: '@biomejs/biome': - specifier: 1.9.1 - version: 1.9.1 + specifier: 1.9.2 + version: 1.9.2 '@jest/globals': specifier: ^29.7.0 version: 29.7.0 @@ -19,7 +19,7 @@ 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.18)(chokidar@4.0.1) '@swc/core': specifier: ^1.7.11 version: 1.7.18 @@ -30,17 +30,17 @@ importers: specifier: ^29.5.13 version: 29.5.13 '@types/node': - specifier: ^22.5.5 - version: 22.5.5 + specifier: ^22.6.1 + version: 22.6.1 del-cli: specifier: ^5.1.0 version: 5.1.0 jest: specifier: ^29.7.0 - version: 29.7.0(@types/node@22.5.5) + version: 29.7.0(@types/node@22.6.1) tsx: - specifier: ^4.19.0 - version: 4.19.0 + specifier: ^4.19.1 + version: 4.19.1 turbo: specifier: ^2.1.2 version: 2.1.2 @@ -70,7 +70,7 @@ importers: version: 1.0.0(typescript@5.6.2)(zod@3.23.8) '@mantine/core': specifier: ^7.12.2 - version: 7.12.2(@mantine/hooks@7.12.2(react@18.3.1))(@types/react@18.3.7)(react-dom@18.3.1(react@18.3.1))(react@18.3.1) + version: 7.12.2(@mantine/hooks@7.12.2(react@18.3.1))(@types/react@18.3.8)(react-dom@18.3.1(react@18.3.1))(react@18.3.1) '@mantine/hooks': specifier: ^7.12.2 version: 7.12.2(react@18.3.1) @@ -81,14 +81,14 @@ 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.7 + version: 1.58.7(@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 jotai: - specifier: ^2.9.2 - version: 2.9.3(@types/react@18.3.7)(react@18.3.1) + specifier: ^2.10.0 + version: 2.10.0(@types/react@18.3.8)(react@18.3.1) multiformats: specifier: ^13.3.0 version: 13.3.0 @@ -106,20 +106,20 @@ 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.7 + version: 1.58.7(@tanstack/react-router@1.58.7(@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.7(@types/node@22.6.1)(sugarss@4.0.1(postcss@8.4.47)))(webpack-sources@3.2.3) '@types/react': - specifier: ^18.3.7 - version: 18.3.7 + specifier: ^18.3.8 + version: 18.3.8 '@types/react-dom': specifier: ^18.3.0 version: 18.3.0 '@vitejs/plugin-react-swc': specifier: ^3.5.0 - version: 3.7.0(vite@5.4.6(@types/node@22.5.5)(sugarss@4.0.1(postcss@8.4.47))) + version: 3.7.0(vite@5.4.7(@types/node@22.6.1)(sugarss@4.0.1(postcss@8.4.47))) postcss: specifier: ^8.4.47 version: 8.4.47 @@ -136,8 +136,8 @@ importers: specifier: ^5.6.2 version: 5.6.2 vite: - specifier: ^5.4.6 - version: 5.4.6(@types/node@22.5.5)(sugarss@4.0.1(postcss@8.4.47)) + specifier: ^5.4.7 + version: 5.4.7(@types/node@22.6.1)(sugarss@4.0.1(postcss@8.4.47)) packages/events: dependencies: @@ -188,8 +188,8 @@ importers: specifier: workspace:^ version: link:../events openapi-fetch: - specifier: ^0.12.0 - version: 0.12.0 + specifier: ^0.12.2 + version: 0.12.2 devDependencies: cartonne: specifier: ^3.0.1 @@ -201,8 +201,8 @@ importers: specifier: ^13.3.0 version: 13.3.0 openapi-typescript: - specifier: ^7.4.0 - version: 7.4.0(typescript@5.6.2) + specifier: ^7.4.1 + version: 7.4.1(typescript@5.6.2) type-fest: specifier: ^4.26.1 version: 4.26.1 @@ -253,19 +253,25 @@ importers: '@ceramic-sdk/events': specifier: workspace:^ version: link:../events + '@ceramic-sdk/http-client': + specifier: workspace:^ + version: link:../http-client '@ceramic-sdk/model-protocol': specifier: workspace:^ version: link:../model-protocol - dids: - specifier: ^5.0.2 - version: 5.0.2(typescript@5.6.2)(zod@3.23.8) devDependencies: + '@ceramic-sdk/identifiers': + specifier: workspace:^ + version: link:../identifiers '@ceramic-sdk/test-utils': specifier: workspace:^ version: link:../test-utils '@didtools/key-did': specifier: ^1.0.0 version: 1.0.0(typescript@5.6.2)(zod@3.23.8) + dids: + specifier: ^5.0.2 + version: 5.0.2(typescript@5.6.2)(zod@3.23.8) packages/model-handler: dependencies: @@ -312,6 +318,12 @@ importers: '@ceramic-sdk/events': specifier: workspace:^ version: link:../events + '@ceramic-sdk/http-client': + specifier: workspace:^ + version: link:../http-client + '@ceramic-sdk/identifiers': + specifier: workspace:^ + version: link:../identifiers '@ceramic-sdk/model-instance-protocol': specifier: workspace:^ version: link:../model-instance-protocol @@ -322,9 +334,6 @@ importers: specifier: ^3.1.1 version: 3.1.1 devDependencies: - '@ceramic-sdk/identifiers': - specifier: workspace:^ - version: link:../identifiers '@didtools/key-did': specifier: ^1.0.0 version: 1.0.0(typescript@5.6.2)(zod@3.23.8) @@ -464,8 +473,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.14 + version: 2.21.14(typescript@5.6.2)(zod@3.23.8) devDependencies: '@didtools/pkh-ethereum': specifier: ^0.6.0 @@ -771,55 +780,55 @@ packages: '@bcoe/v8-coverage@0.2.3': resolution: {integrity: sha512-0hYQ8SB4Db5zvZB4axdMHGwEaQjkZzFjQiN9LVYvIFB2nSUHW9tYpxWriPrWDASIxiaXax83REcLxuSdnGPZtw==} - '@biomejs/biome@1.9.1': - resolution: {integrity: sha512-Ps0Rg0zg3B1zpx+zQHMz5b0n0PBNCAaXttHEDTVrJD5YXR6Uj3T+abTDgeS3wsu4z5i2whqcE1lZxGyWH4bZYg==} + '@biomejs/biome@1.9.2': + resolution: {integrity: sha512-4j2Gfwft8Jqp1X0qLYvK4TEy4xhTo4o6rlvJPsjPeEame8gsmbGQfOPBkw7ur+7/Z/f0HZmCZKqbMvR7vTXQYQ==} engines: {node: '>=14.21.3'} hasBin: true - '@biomejs/cli-darwin-arm64@1.9.1': - resolution: {integrity: sha512-js0brHswq/BoeKgfSEUJYOjUOlML6p65Nantti+PsoQ61u9+YVGIZ7325LK7iUpDH8KVJT+Bx7K2b/6Q//W1Pw==} + '@biomejs/cli-darwin-arm64@1.9.2': + resolution: {integrity: sha512-rbs9uJHFmhqB3Td0Ro+1wmeZOHhAPTL3WHr8NtaVczUmDhXkRDWScaxicG9+vhSLj1iLrW47itiK6xiIJy6vaA==} engines: {node: '>=14.21.3'} cpu: [arm64] os: [darwin] - '@biomejs/cli-darwin-x64@1.9.1': - resolution: {integrity: sha512-2zVyjUg5rN0k8XrytkubQWLbp2r/AS5wPhXs4vgVjvqbLnzo32EGX8p61gzroF2dH9DCUCfskdrigCGqNdEbpg==} + '@biomejs/cli-darwin-x64@1.9.2': + resolution: {integrity: sha512-BlfULKijNaMigQ9GH9fqJVt+3JTDOSiZeWOQtG/1S1sa8Lp046JHG3wRJVOvekTPL9q/CNFW1NVG8J0JN+L1OA==} engines: {node: '>=14.21.3'} cpu: [x64] os: [darwin] - '@biomejs/cli-linux-arm64-musl@1.9.1': - resolution: {integrity: sha512-L/JmXKvhsZ1lTgqOr3tWkzuY/NRppdIscHeC9aaiR72WjnBgJS94mawl9BWmGB3aWBc0q6oSDWnBS7617EMMmA==} + '@biomejs/cli-linux-arm64-musl@1.9.2': + resolution: {integrity: sha512-ZATvbUWhNxegSALUnCKWqetTZqrK72r2RsFD19OK5jXDj/7o1hzI1KzDNG78LloZxftrwr3uI9SqCLh06shSZw==} engines: {node: '>=14.21.3'} cpu: [arm64] os: [linux] - '@biomejs/cli-linux-arm64@1.9.1': - resolution: {integrity: sha512-QgxwfnG+r2aer5RNGR67Ey91Tv7xXW8E9YckHhwuyWjdLEvKWkrSJrhVG/6ub0kVvTSNkYOuT/7/jMOFBuUbRA==} + '@biomejs/cli-linux-arm64@1.9.2': + resolution: {integrity: sha512-T8TJuSxuBDeQCQzxZu2o3OU4eyLumTofhCxxFd3+aH2AEWVMnH7Z/c3QP1lHI5RRMBP9xIJeMORqDQ5j+gVZzw==} engines: {node: '>=14.21.3'} cpu: [arm64] os: [linux] - '@biomejs/cli-linux-x64-musl@1.9.1': - resolution: {integrity: sha512-gY+eFLIAW45v3WicQHicvjRfA0ntMZHx7h937bXwBMFNFoKmB6rMi6+fKQ6/hiS6juhsFxZdZIz20m15s49J6A==} + '@biomejs/cli-linux-x64-musl@1.9.2': + resolution: {integrity: sha512-CjPM6jT1miV5pry9C7qv8YJk0FIZvZd86QRD3atvDgfgeh9WQU0k2Aoo0xUcPdTnoz0WNwRtDicHxwik63MmSg==} engines: {node: '>=14.21.3'} cpu: [x64] os: [linux] - '@biomejs/cli-linux-x64@1.9.1': - resolution: {integrity: sha512-F0INygtzI2L2n2R1KtYHGr3YWDt9Up1zrUluwembM+iJ1dXN3qzlSb7deFUsSJm4FaIPriqs6Xa56ukdQW6UeQ==} + '@biomejs/cli-linux-x64@1.9.2': + resolution: {integrity: sha512-T0cPk3C3Jr2pVlsuQVTBqk2qPjTm8cYcTD9p/wmR9MeVqui1C/xTVfOIwd3miRODFMrJaVQ8MYSXnVIhV9jTjg==} engines: {node: '>=14.21.3'} cpu: [x64] os: [linux] - '@biomejs/cli-win32-arm64@1.9.1': - resolution: {integrity: sha512-7Jahxar3OB+aTPOgXisMJmMKMsjcK+UmdlG3UIOQjzN/ZFEsPV+GT3bfrVjZDQaCw/zes0Cqd7VTWFjFTC/+MQ==} + '@biomejs/cli-win32-arm64@1.9.2': + resolution: {integrity: sha512-2x7gSty75bNIeD23ZRPXyox6Z/V0M71ObeJtvQBhi1fgrvPdtkEuw7/0wEHg6buNCubzOFuN9WYJm6FKoUHfhg==} engines: {node: '>=14.21.3'} cpu: [arm64] os: [win32] - '@biomejs/cli-win32-x64@1.9.1': - resolution: {integrity: sha512-liSRWjWzFhyG7s1jg/Bbv9FL+ha/CEd5tFO3+dFIJNplL4TnvAivtyfRVi/tu/pNjISbV1k9JwdBewtAKAgA0w==} + '@biomejs/cli-win32-x64@1.9.2': + resolution: {integrity: sha512-JC3XvdYcjmu1FmAehVwVV0SebLpeNTnO2ZaMdGCSOdS7f8O9Fq14T2P1gTG1Q29Q8Dt1S03hh0IdVpIZykOL8g==} engines: {node: '>=14.21.3'} cpu: [x64] os: [win32] @@ -1332,98 +1341,98 @@ packages: '@redocly/ajv@8.11.2': resolution: {integrity: sha512-io1JpnwtIcvojV7QKDUSIuMN/ikdOUd1ReEnUnMKGfDVridQZ31J0MmIuqwuRjWDZfmvr+Q0MqCcfHM2gTivOg==} - '@redocly/config@0.10.1': - resolution: {integrity: sha512-H3LnKVGzOaxskwJu8pmJYwBOWjP61qOK7TuTrbafqArDVckE06fhA6l0nO4KvBbjLPjy1Al7UnlxOu23V4Nl0w==} + '@redocly/config@0.11.0': + resolution: {integrity: sha512-vAc77vCuWsVgLx2LN02P6jqLBhHuot6O1LsSJEAAkWEvXARSGSQVon50QW7jlbCMg9OFTYYYRPN4W6K/YmnM3w==} - '@redocly/openapi-core@1.25.2': - resolution: {integrity: sha512-6lJ3cRwi9xFkz/DDSmZNiv16hrzUeDoiZJQppSckKmw7MHkARu9gqRNARxUjtOAywqvpGMneASVIF9ogmalrQg==} + '@redocly/openapi-core@1.25.3': + resolution: {integrity: sha512-dqJkyydgagW3FXX5cjtSUAnabsld4K6yq7RFgQ+ngI1m43PkEoSQt8pp+SfQDszSEoMbc7QKj8afbe7mZw17TA==} engines: {node: '>=14.19.0', npm: '>=7.0.0'} - '@rollup/rollup-android-arm-eabi@4.21.3': - resolution: {integrity: sha512-MmKSfaB9GX+zXl6E8z4koOr/xU63AMVleLEa64v7R0QF/ZloMs5vcD1sHgM64GXXS1csaJutG+ddtzcueI/BLg==} + '@rollup/rollup-android-arm-eabi@4.22.4': + resolution: {integrity: sha512-Fxamp4aEZnfPOcGA8KSNEohV8hX7zVHOemC8jVBoBUHu5zpJK/Eu3uJwt6BMgy9fkvzxDaurgj96F/NiLukF2w==} cpu: [arm] os: [android] - '@rollup/rollup-android-arm64@4.21.3': - resolution: {integrity: sha512-zrt8ecH07PE3sB4jPOggweBjJMzI1JG5xI2DIsUbkA+7K+Gkjys6eV7i9pOenNSDJH3eOr/jLb/PzqtmdwDq5g==} + '@rollup/rollup-android-arm64@4.22.4': + resolution: {integrity: sha512-VXoK5UMrgECLYaMuGuVTOx5kcuap1Jm8g/M83RnCHBKOqvPPmROFJGQaZhGccnsFtfXQ3XYa4/jMCJvZnbJBdA==} cpu: [arm64] os: [android] - '@rollup/rollup-darwin-arm64@4.21.3': - resolution: {integrity: sha512-P0UxIOrKNBFTQaXTxOH4RxuEBVCgEA5UTNV6Yz7z9QHnUJ7eLX9reOd/NYMO3+XZO2cco19mXTxDMXxit4R/eQ==} + '@rollup/rollup-darwin-arm64@4.22.4': + resolution: {integrity: sha512-xMM9ORBqu81jyMKCDP+SZDhnX2QEVQzTcC6G18KlTQEzWK8r/oNZtKuZaCcHhnsa6fEeOBionoyl5JsAbE/36Q==} cpu: [arm64] os: [darwin] - '@rollup/rollup-darwin-x64@4.21.3': - resolution: {integrity: sha512-L1M0vKGO5ASKntqtsFEjTq/fD91vAqnzeaF6sfNAy55aD+Hi2pBI5DKwCO+UNDQHWsDViJLqshxOahXyLSh3EA==} + '@rollup/rollup-darwin-x64@4.22.4': + resolution: {integrity: sha512-aJJyYKQwbHuhTUrjWjxEvGnNNBCnmpHDvrb8JFDbeSH3m2XdHcxDd3jthAzvmoI8w/kSjd2y0udT+4okADsZIw==} cpu: [x64] os: [darwin] - '@rollup/rollup-linux-arm-gnueabihf@4.21.3': - resolution: {integrity: sha512-btVgIsCjuYFKUjopPoWiDqmoUXQDiW2A4C3Mtmp5vACm7/GnyuprqIDPNczeyR5W8rTXEbkmrJux7cJmD99D2g==} + '@rollup/rollup-linux-arm-gnueabihf@4.22.4': + resolution: {integrity: sha512-j63YtCIRAzbO+gC2L9dWXRh5BFetsv0j0va0Wi9epXDgU/XUi5dJKo4USTttVyK7fGw2nPWK0PbAvyliz50SCQ==} cpu: [arm] os: [linux] - '@rollup/rollup-linux-arm-musleabihf@4.21.3': - resolution: {integrity: sha512-zmjbSphplZlau6ZTkxd3+NMtE4UKVy7U4aVFMmHcgO5CUbw17ZP6QCgyxhzGaU/wFFdTfiojjbLG3/0p9HhAqA==} + '@rollup/rollup-linux-arm-musleabihf@4.22.4': + resolution: {integrity: sha512-dJnWUgwWBX1YBRsuKKMOlXCzh2Wu1mlHzv20TpqEsfdZLb3WoJW2kIEsGwLkroYf24IrPAvOT/ZQ2OYMV6vlrg==} cpu: [arm] os: [linux] - '@rollup/rollup-linux-arm64-gnu@4.21.3': - resolution: {integrity: sha512-nSZfcZtAnQPRZmUkUQwZq2OjQciR6tEoJaZVFvLHsj0MF6QhNMg0fQ6mUOsiCUpTqxTx0/O6gX0V/nYc7LrgPw==} + '@rollup/rollup-linux-arm64-gnu@4.22.4': + resolution: {integrity: sha512-AdPRoNi3NKVLolCN/Sp4F4N1d98c4SBnHMKoLuiG6RXgoZ4sllseuGioszumnPGmPM2O7qaAX/IJdeDU8f26Aw==} cpu: [arm64] os: [linux] - '@rollup/rollup-linux-arm64-musl@4.21.3': - resolution: {integrity: sha512-MnvSPGO8KJXIMGlQDYfvYS3IosFN2rKsvxRpPO2l2cum+Z3exiExLwVU+GExL96pn8IP+GdH8Tz70EpBhO0sIQ==} + '@rollup/rollup-linux-arm64-musl@4.22.4': + resolution: {integrity: sha512-Gl0AxBtDg8uoAn5CCqQDMqAx22Wx22pjDOjBdmG0VIWX3qUBHzYmOKh8KXHL4UpogfJ14G4wk16EQogF+v8hmA==} cpu: [arm64] os: [linux] - '@rollup/rollup-linux-powerpc64le-gnu@4.21.3': - resolution: {integrity: sha512-+W+p/9QNDr2vE2AXU0qIy0qQE75E8RTwTwgqS2G5CRQ11vzq0tbnfBd6brWhS9bCRjAjepJe2fvvkvS3dno+iw==} + '@rollup/rollup-linux-powerpc64le-gnu@4.22.4': + resolution: {integrity: sha512-3aVCK9xfWW1oGQpTsYJJPF6bfpWfhbRnhdlyhak2ZiyFLDaayz0EP5j9V1RVLAAxlmWKTDfS9wyRyY3hvhPoOg==} cpu: [ppc64] os: [linux] - '@rollup/rollup-linux-riscv64-gnu@4.21.3': - resolution: {integrity: sha512-yXH6K6KfqGXaxHrtr+Uoy+JpNlUlI46BKVyonGiaD74ravdnF9BUNC+vV+SIuB96hUMGShhKV693rF9QDfO6nQ==} + '@rollup/rollup-linux-riscv64-gnu@4.22.4': + resolution: {integrity: sha512-ePYIir6VYnhgv2C5Xe9u+ico4t8sZWXschR6fMgoPUK31yQu7hTEJb7bCqivHECwIClJfKgE7zYsh1qTP3WHUA==} cpu: [riscv64] os: [linux] - '@rollup/rollup-linux-s390x-gnu@4.21.3': - resolution: {integrity: sha512-R8cwY9wcnApN/KDYWTH4gV/ypvy9yZUHlbJvfaiXSB48JO3KpwSpjOGqO4jnGkLDSk1hgjYkTbTt6Q7uvPf8eg==} + '@rollup/rollup-linux-s390x-gnu@4.22.4': + resolution: {integrity: sha512-GqFJ9wLlbB9daxhVlrTe61vJtEY99/xB3C8e4ULVsVfflcpmR6c8UZXjtkMA6FhNONhj2eA5Tk9uAVw5orEs4Q==} cpu: [s390x] os: [linux] - '@rollup/rollup-linux-x64-gnu@4.21.3': - resolution: {integrity: sha512-kZPbX/NOPh0vhS5sI+dR8L1bU2cSO9FgxwM8r7wHzGydzfSjLRCFAT87GR5U9scj2rhzN3JPYVC7NoBbl4FZ0g==} + '@rollup/rollup-linux-x64-gnu@4.22.4': + resolution: {integrity: sha512-87v0ol2sH9GE3cLQLNEy0K/R0pz1nvg76o8M5nhMR0+Q+BBGLnb35P0fVz4CQxHYXaAOhE8HhlkaZfsdUOlHwg==} cpu: [x64] os: [linux] - '@rollup/rollup-linux-x64-musl@4.21.3': - resolution: {integrity: sha512-S0Yq+xA1VEH66uiMNhijsWAafffydd2X5b77eLHfRmfLsRSpbiAWiRHV6DEpz6aOToPsgid7TI9rGd6zB1rhbg==} + '@rollup/rollup-linux-x64-musl@4.22.4': + resolution: {integrity: sha512-UV6FZMUgePDZrFjrNGIWzDo/vABebuXBhJEqrHxrGiU6HikPy0Z3LfdtciIttEUQfuDdCn8fqh7wiFJjCNwO+g==} cpu: [x64] os: [linux] - '@rollup/rollup-win32-arm64-msvc@4.21.3': - resolution: {integrity: sha512-9isNzeL34yquCPyerog+IMCNxKR8XYmGd0tHSV+OVx0TmE0aJOo9uw4fZfUuk2qxobP5sug6vNdZR6u7Mw7Q+Q==} + '@rollup/rollup-win32-arm64-msvc@4.22.4': + resolution: {integrity: sha512-BjI+NVVEGAXjGWYHz/vv0pBqfGoUH0IGZ0cICTn7kB9PyjrATSkX+8WkguNjWoj2qSr1im/+tTGRaY+4/PdcQw==} cpu: [arm64] os: [win32] - '@rollup/rollup-win32-ia32-msvc@4.21.3': - resolution: {integrity: sha512-nMIdKnfZfzn1Vsk+RuOvl43ONTZXoAPUUxgcU0tXooqg4YrAqzfKzVenqqk2g5efWh46/D28cKFrOzDSW28gTA==} + '@rollup/rollup-win32-ia32-msvc@4.22.4': + resolution: {integrity: sha512-SiWG/1TuUdPvYmzmYnmd3IEifzR61Tragkbx9D3+R8mzQqDBz8v+BvZNDlkiTtI9T15KYZhP0ehn3Dld4n9J5g==} cpu: [ia32] os: [win32] - '@rollup/rollup-win32-x64-msvc@4.21.3': - resolution: {integrity: sha512-fOvu7PCQjAj4eWDEuD8Xz5gpzFqXzGlxHZozHP4b9Jxv9APtdxL6STqztDzMLuRXEc4UpXGGhx029Xgm91QBeA==} + '@rollup/rollup-win32-x64-msvc@4.22.4': + resolution: {integrity: sha512-j8pPKp53/lq9lMXN57S8cFz0MynJk8OWNuUnXct/9KCpKU7DgU3bYMJhwWmcqC0UU29p8Lr0/7KEVcaM6bf47Q==} cpu: [x64] os: [win32] '@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==} @@ -1654,11 +1663,11 @@ packages: peerDependencies: react: ^18 || ^19 - '@tanstack/react-router@1.57.17': - resolution: {integrity: sha512-pvtbZWdfLMMU7JKMHcbw5XFrUF9++IIdqa7pKylVm4jW9tTQOBhewKheUKiOipSox9sxOOmNAGsu10gMfwvR3g==} + '@tanstack/react-router@1.58.7': + resolution: {integrity: sha512-iu4WtrhXz0YcJzPMlyP4jT3zfEKJH+dVVKViK8ayL1hWjP2n6A08kYE1hcT3YmuK2LmNmMsnGS+Tc7WAFsHgZQ==} engines: {node: '>=12'} peerDependencies: - '@tanstack/router-generator': 1.57.15 + '@tanstack/router-generator': 1.58.1 react: '>=18' react-dom: '>=18' peerDependenciesMeta: @@ -1671,20 +1680,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.7': + resolution: {integrity: sha512-bZL3VDmS63gOW+RKSXRQ7uagATP1k8sM+ucHrcLy98hcVxzYRVwIwVgqTZY2KtUSXgFwb4LXClAdZdiJM9i+gw==} engines: {node: '>=12'} peerDependencies: - '@tanstack/react-router': ^1.57.17 + '@tanstack/react-router': ^1.58.7 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' @@ -1759,8 +1768,8 @@ packages: '@types/minimist@1.2.5': resolution: {integrity: sha512-hov8bUuiLiyFPGyFPE1lwWhmzYbirOXQNNo40+y3zow8aFVTeyn3VWL0VFFfdNddA8S4Vf0Tc062rzyNr7Paag==} - '@types/node@22.5.5': - resolution: {integrity: sha512-Xjs4y5UPO/CLdzpgR6GirZJx36yScjh73+2NlLlkFRSoQN8B0DpfXPdZGnvVmLRLOsqDpOfTNv7D9trgGhmOIA==} + '@types/node@22.6.1': + resolution: {integrity: sha512-V48tCfcKb/e6cVUigLAaJDAILdMP0fUW6BidkPK4GpGjXcfbnoHasCZDwz3N3yVt5we2RHm4XTQCpv0KJz9zqw==} '@types/normalize-package-data@2.4.4': resolution: {integrity: sha512-37i+OaWTh9qeK4LSHPsyRC7NahnGotNuZvjLSgcPzblpHB3rrCJxAOgI5gCdKm7coonsaX1Of0ILiTcnZjbfxA==} @@ -1771,8 +1780,8 @@ packages: '@types/react-dom@18.3.0': resolution: {integrity: sha512-EhwApuTmMBmXuFOikhQLIBUn6uFg81SwLMOAUgodJF14SOBOCMdU04gDoYi0WOJJHD144TL32z4yDqCW3dnkQg==} - '@types/react@18.3.7': - resolution: {integrity: sha512-KUnDCJF5+AiZd8owLIeVHqmW9yM4sqmDVf2JRJiBMFkGvkoZ4/WyV2lL4zVsoinmRS/W3FeEdZLEWFRofnT2FQ==} + '@types/react@18.3.8': + resolution: {integrity: sha512-syBUrW3/XpnW4WJ41Pft+I+aPoDVbrBVQGEnbD7NijDGlVC+8gV/XKRY+7vMDlfPpbwYt0l1vd/Sj8bJGMbs9Q==} '@types/responselike@1.0.3': resolution: {integrity: sha512-H/+L+UkTV33uf49PH5pCAUBVPNj2nDBXTN+qS1dOwyyg24l3CcicicCA7ca+HMvJBZcFgl5r8e+RR6elsb4Lyw==} @@ -2026,8 +2035,8 @@ packages: resolution: {integrity: sha512-7VT13fmjotKpGipCW9JEQAusEPE+Ei8nl6/g4FBAmIm0GOOLMua9NDDo/DWp0ZAxCr3cPq5ZpBqmPAQgDda2Pw==} engines: {node: '>= 8.10.0'} - chokidar@4.0.0: - resolution: {integrity: sha512-mxIojEAQcuEvT/lyXq+jf/3cO/KoA6z4CeNDGGevTybECPOMFCnQy3OPahluUkbqgPNGw5Bi78UC7Po6Lhy+NA==} + chokidar@4.0.1: + resolution: {integrity: sha512-n8enUVCED/KVRQlab1hr3MVpcVMvxtZjmEa956u+4YijlmQED223XMSYj2tLuKvr4jcCTzNNMpQDUer72MMmzA==} engines: {node: '>= 14.16.0'} ci-info@3.9.0: @@ -2386,9 +2395,6 @@ packages: resolution: {integrity: sha512-ts6Wi+2j3jQjqi70w5AlN8DFnkSwC+MqmxEzdEALB2qXZYV3X/b1CTfgPLGJNMeAWxdPfU8FO1ms3NUfaHCPYg==} engines: {node: '>=10'} - get-tsconfig@4.7.6: - resolution: {integrity: sha512-ZAqrLlu18NbDdRaHq+AKXzAmqIUPswPWKUchfytdAjiRFnCe5ojG2bstg6mRiZabkKfCoL/e98pbBELIV/YCeA==} - get-tsconfig@4.8.1: resolution: {integrity: sha512-k9PN+cFBmaLWtVz29SkUoqU5O0slLuHJXt/2P+tMVFT+phsSGXGkp9t3rQIqdz0e+06EHNGs3oM6ZX1s2zHxRg==} @@ -2709,8 +2715,8 @@ packages: node-notifier: optional: true - jotai@2.9.3: - resolution: {integrity: sha512-IqMWKoXuEzWSShjd9UhalNsRGbdju5G2FrqNLQJT+Ih6p41VNYe2sav5hnwQx4HJr25jq9wRqvGSWGviGG6Gjw==} + jotai@2.10.0: + resolution: {integrity: sha512-8W4u0aRlOIwGlLQ0sqfl/c6+eExl5D8lZgAUolirZLktyaj4WnxO/8a0HEPmtriQAB6X5LMhXzZVmw02X0P0qQ==} engines: {node: '>=12.20.0'} peerDependencies: '@types/react': '>=17.0.0' @@ -2988,14 +2994,14 @@ packages: resolution: {integrity: sha512-kbpaSSGJTWdAY5KPVeMOKXSrPtr8C8C7wodJbcsd51jRnmD+GZu8Y0VoU6Dm5Z4vWr0Ig/1NKuWRKf7j5aaYSg==} engines: {node: '>=6'} - openapi-fetch@0.12.0: - resolution: {integrity: sha512-D/g5BUGiOAKqivR5s02veJ2+cMHzrkFJKberKP4Z8Vl2VhE6MMirI6wWOgpp8wlsYCRRK7CX0NCGVL/mt6l1fA==} + openapi-fetch@0.12.2: + resolution: {integrity: sha512-ctMQ4LkkSWfIDUMuf1SYuPMsQ7ePcWAkYaMPW1lCDdk4WlV3Vulq1zoyGrwnFVvrBs5t7OOqNF+EKa8SAaovEA==} openapi-typescript-helpers@0.0.13: resolution: {integrity: sha512-z44WK2e7ygW3aUtAtiurfEACohf/Qt9g6BsejmIYgEoY4REHeRzgFJmO3ium0libsuzPc145I+8lE9aiiZrQvQ==} - openapi-typescript@7.4.0: - resolution: {integrity: sha512-u4iVuTGkzKG4rHFUMA/IFXTks9tYVQzkowZsScMOdzJSvIF10qSNySWHTwnN2fD+MEeWFAM8i1f3IUBlgS92eQ==} + openapi-typescript@7.4.1: + resolution: {integrity: sha512-HrRoWveViADezHCNgQqZmPKmQ74q7nuH/yg9ursFucZaYQNUqsX38fE/V2sKBHVM+pws4tAHpuh/ext2UJ/AoQ==} hasBin: true peerDependencies: typescript: ^5.x @@ -3293,8 +3299,8 @@ packages: deprecated: Rimraf versions prior to v4 are no longer supported hasBin: true - rollup@4.21.3: - resolution: {integrity: sha512-7sqRtBNnEbcBtMeRVc6VRsJMmpI+JU1z9VTvW8D4gXIYQFz0aLcsE6rRkyghZkLfEgUZgVvOG7A5CVz/VW5GIA==} + rollup@4.22.4: + resolution: {integrity: sha512-vD8HJ5raRcWOyymsR6Z3o6+RzfEPCnVLMFJ6vRslO1jt4LO6dUo5Qnpg7y4RkZFM2DMe3WUirkI5c16onjrc6A==} engines: {node: '>=18.0.0', npm: '>=8.0.0'} hasBin: true @@ -3523,11 +3529,6 @@ packages: tslib@2.7.0: resolution: {integrity: sha512-gLXCKdN1/j47AiHiOkJN69hJmcbGTHI0ImLmbYLHykhgeN0jVGola9yVjFgzCUklsZQMW55o+dW7IXv3RCXDzA==} - tsx@4.19.0: - resolution: {integrity: sha512-bV30kM7bsLZKZIOCHeMNVMJ32/LuJzLVajkQI/qf92J2Qr08ueLQvW00PUZGiuLPP760UINwupgUj8qrSCPUKg==} - engines: {node: '>=18.0.0'} - hasBin: true - tsx@4.19.1: resolution: {integrity: sha512-0flMz1lh74BR4wOvBjuh9olbnwqCPc35OOlfyzHba0Dc+QNUeWX/Gq2YTbnwcWPO3BMd8fkzRVrHcsR+a7z7rA==} engines: {node: '>=18.0.0'} @@ -3687,16 +3688,16 @@ packages: typescript: optional: true - viem@2.21.8: - resolution: {integrity: sha512-j85Z8pfgcAA7HLtLOd7k7mdyw1ogUjyCxrmwyxzlcAPE8+u8O8GySUMgOxNW/n9mazO2R8XpZ+9nUoXgesAn/g==} + viem@2.21.14: + resolution: {integrity: sha512-uM6XmY9Q/kJRVSopJAGsakmtNDpk/EswqXUzwOp9DzhGuwgpWtw2MgwpfFdIyqBDFIw+TTypCIUTcwJSgEYSzA==} peerDependencies: typescript: '>=5.0.4' peerDependenciesMeta: typescript: optional: true - vite@5.4.6: - resolution: {integrity: sha512-IeL5f8OO5nylsgzd9tq4qD2QqI0k2CQLGrWD0rCN0EQJZpBK5vJAx0I+GDkMOXxQX/OfFHMuLIx6ddAxGX/k+Q==} + vite@5.4.7: + resolution: {integrity: sha512-5l2zxqMEPVENgvzTuBpHer2awaetimj2BGkhBPdnwKbPNOlHsODU+oiazEZzLK7KhAnOrO+XGYJYn4ZlUhDtDQ==} engines: {node: ^18.0.0 || >=20.0.0} hasBin: true peerDependencies: @@ -4057,39 +4058,39 @@ snapshots: '@bcoe/v8-coverage@0.2.3': {} - '@biomejs/biome@1.9.1': + '@biomejs/biome@1.9.2': optionalDependencies: - '@biomejs/cli-darwin-arm64': 1.9.1 - '@biomejs/cli-darwin-x64': 1.9.1 - '@biomejs/cli-linux-arm64': 1.9.1 - '@biomejs/cli-linux-arm64-musl': 1.9.1 - '@biomejs/cli-linux-x64': 1.9.1 - '@biomejs/cli-linux-x64-musl': 1.9.1 - '@biomejs/cli-win32-arm64': 1.9.1 - '@biomejs/cli-win32-x64': 1.9.1 - - '@biomejs/cli-darwin-arm64@1.9.1': + '@biomejs/cli-darwin-arm64': 1.9.2 + '@biomejs/cli-darwin-x64': 1.9.2 + '@biomejs/cli-linux-arm64': 1.9.2 + '@biomejs/cli-linux-arm64-musl': 1.9.2 + '@biomejs/cli-linux-x64': 1.9.2 + '@biomejs/cli-linux-x64-musl': 1.9.2 + '@biomejs/cli-win32-arm64': 1.9.2 + '@biomejs/cli-win32-x64': 1.9.2 + + '@biomejs/cli-darwin-arm64@1.9.2': optional: true - '@biomejs/cli-darwin-x64@1.9.1': + '@biomejs/cli-darwin-x64@1.9.2': optional: true - '@biomejs/cli-linux-arm64-musl@1.9.1': + '@biomejs/cli-linux-arm64-musl@1.9.2': optional: true - '@biomejs/cli-linux-arm64@1.9.1': + '@biomejs/cli-linux-arm64@1.9.2': optional: true - '@biomejs/cli-linux-x64-musl@1.9.1': + '@biomejs/cli-linux-x64-musl@1.9.2': optional: true - '@biomejs/cli-linux-x64@1.9.1': + '@biomejs/cli-linux-x64@1.9.2': optional: true - '@biomejs/cli-win32-arm64@1.9.1': + '@biomejs/cli-win32-arm64@1.9.2': optional: true - '@biomejs/cli-win32-x64@1.9.1': + '@biomejs/cli-win32-x64@1.9.2': optional: true '@databases/with-container@2.1.1': @@ -4388,7 +4389,7 @@ snapshots: '@jest/console@29.7.0': dependencies: '@jest/types': 29.6.3 - '@types/node': 22.5.5 + '@types/node': 22.6.1 chalk: 4.1.2 jest-message-util: 29.7.0 jest-util: 29.7.0 @@ -4401,14 +4402,14 @@ snapshots: '@jest/test-result': 29.7.0 '@jest/transform': 29.7.0 '@jest/types': 29.6.3 - '@types/node': 22.5.5 + '@types/node': 22.6.1 ansi-escapes: 4.3.2 chalk: 4.1.2 ci-info: 3.9.0 exit: 0.1.2 graceful-fs: 4.2.11 jest-changed-files: 29.7.0 - jest-config: 29.7.0(@types/node@22.5.5) + jest-config: 29.7.0(@types/node@22.6.1) jest-haste-map: 29.7.0 jest-message-util: 29.7.0 jest-regex-util: 29.6.3 @@ -4437,7 +4438,7 @@ snapshots: dependencies: '@jest/fake-timers': 29.7.0 '@jest/types': 29.6.3 - '@types/node': 22.5.5 + '@types/node': 22.6.1 jest-mock: 29.7.0 '@jest/expect-utils@29.7.0': @@ -4455,7 +4456,7 @@ snapshots: dependencies: '@jest/types': 29.6.3 '@sinonjs/fake-timers': 10.3.0 - '@types/node': 22.5.5 + '@types/node': 22.6.1 jest-message-util: 29.7.0 jest-mock: 29.7.0 jest-util: 29.7.0 @@ -4477,7 +4478,7 @@ snapshots: '@jest/transform': 29.7.0 '@jest/types': 29.6.3 '@jridgewell/trace-mapping': 0.3.25 - '@types/node': 22.5.5 + '@types/node': 22.6.1 chalk: 4.1.2 collect-v8-coverage: 1.0.2 exit: 0.1.2 @@ -4547,7 +4548,7 @@ snapshots: '@jest/schemas': 29.6.3 '@types/istanbul-lib-coverage': 2.0.6 '@types/istanbul-reports': 3.0.4 - '@types/node': 22.5.5 + '@types/node': 22.6.1 '@types/yargs': 17.0.32 chalk: 4.1.2 @@ -4568,7 +4569,7 @@ snapshots: '@jridgewell/resolve-uri': 3.1.2 '@jridgewell/sourcemap-codec': 1.5.0 - '@mantine/core@7.12.2(@mantine/hooks@7.12.2(react@18.3.1))(@types/react@18.3.7)(react-dom@18.3.1(react@18.3.1))(react@18.3.1)': + '@mantine/core@7.12.2(@mantine/hooks@7.12.2(react@18.3.1))(@types/react@18.3.8)(react-dom@18.3.1(react@18.3.1))(react@18.3.1)': dependencies: '@floating-ui/react': 0.26.24(react-dom@18.3.1(react@18.3.1))(react@18.3.1) '@mantine/hooks': 7.12.2(react@18.3.1) @@ -4576,8 +4577,8 @@ snapshots: react: 18.3.1 react-dom: 18.3.1(react@18.3.1) react-number-format: 5.4.2(react-dom@18.3.1(react@18.3.1))(react@18.3.1) - react-remove-scroll: 2.6.0(@types/react@18.3.7)(react@18.3.1) - react-textarea-autosize: 8.5.3(@types/react@18.3.7)(react@18.3.1) + react-remove-scroll: 2.6.0(@types/react@18.3.8)(react@18.3.1) + react-textarea-autosize: 8.5.3(@types/react@18.3.8)(react@18.3.1) type-fest: 4.26.1 transitivePeerDependencies: - '@types/react' @@ -4642,12 +4643,12 @@ snapshots: require-from-string: 2.0.2 uri-js-replace: 1.0.1 - '@redocly/config@0.10.1': {} + '@redocly/config@0.11.0': {} - '@redocly/openapi-core@1.25.2(supports-color@9.4.0)': + '@redocly/openapi-core@1.25.3(supports-color@9.4.0)': dependencies: '@redocly/ajv': 8.11.2 - '@redocly/config': 0.10.1 + '@redocly/config': 0.11.0 colorette: 1.4.0 https-proxy-agent: 7.0.5(supports-color@9.4.0) js-levenshtein: 1.1.6 @@ -4661,57 +4662,57 @@ snapshots: - encoding - supports-color - '@rollup/rollup-android-arm-eabi@4.21.3': + '@rollup/rollup-android-arm-eabi@4.22.4': optional: true - '@rollup/rollup-android-arm64@4.21.3': + '@rollup/rollup-android-arm64@4.22.4': optional: true - '@rollup/rollup-darwin-arm64@4.21.3': + '@rollup/rollup-darwin-arm64@4.22.4': optional: true - '@rollup/rollup-darwin-x64@4.21.3': + '@rollup/rollup-darwin-x64@4.22.4': optional: true - '@rollup/rollup-linux-arm-gnueabihf@4.21.3': + '@rollup/rollup-linux-arm-gnueabihf@4.22.4': optional: true - '@rollup/rollup-linux-arm-musleabihf@4.21.3': + '@rollup/rollup-linux-arm-musleabihf@4.22.4': optional: true - '@rollup/rollup-linux-arm64-gnu@4.21.3': + '@rollup/rollup-linux-arm64-gnu@4.22.4': optional: true - '@rollup/rollup-linux-arm64-musl@4.21.3': + '@rollup/rollup-linux-arm64-musl@4.22.4': optional: true - '@rollup/rollup-linux-powerpc64le-gnu@4.21.3': + '@rollup/rollup-linux-powerpc64le-gnu@4.22.4': optional: true - '@rollup/rollup-linux-riscv64-gnu@4.21.3': + '@rollup/rollup-linux-riscv64-gnu@4.22.4': optional: true - '@rollup/rollup-linux-s390x-gnu@4.21.3': + '@rollup/rollup-linux-s390x-gnu@4.22.4': optional: true - '@rollup/rollup-linux-x64-gnu@4.21.3': + '@rollup/rollup-linux-x64-gnu@4.22.4': optional: true - '@rollup/rollup-linux-x64-musl@4.21.3': + '@rollup/rollup-linux-x64-musl@4.22.4': optional: true - '@rollup/rollup-win32-arm64-msvc@4.21.3': + '@rollup/rollup-win32-arm64-msvc@4.22.4': optional: true - '@rollup/rollup-win32-ia32-msvc@4.21.3': + '@rollup/rollup-win32-ia32-msvc@4.22.4': optional: true - '@rollup/rollup-win32-x64-msvc@4.21.3': + '@rollup/rollup-win32-x64-msvc@4.22.4': optional: true '@scure/base@1.1.7': {} - '@scure/base@1.1.8': {} + '@scure/base@1.1.9': {} '@scure/bip32@1.3.2': dependencies: @@ -4723,7 +4724,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 +4734,7 @@ snapshots: '@scure/bip39@1.4.0': dependencies: '@noble/hashes': 1.5.0 - '@scure/base': 1.1.8 + '@scure/base': 1.1.9 '@sinclair/typebox@0.27.8': {} @@ -4886,7 +4887,7 @@ 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.18)(chokidar@4.0.1)': dependencies: '@mole-inc/bin-wrapper': 8.0.1 '@swc/core': 1.7.18 @@ -4899,7 +4900,7 @@ snapshots: slash: 3.0.0 source-map: 0.7.4 optionalDependencies: - chokidar: 4.0.0 + chokidar: 4.0.1 '@swc/core-darwin-arm64@1.7.18': optional: true @@ -4980,7 +4981,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.7(@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 +4990,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 +4999,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.7(@tanstack/react-router@1.58.7(@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.7(@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 +5009,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.7(@types/node@22.6.1)(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 +5026,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 @@ -5036,7 +5037,7 @@ snapshots: unplugin: 1.14.1(webpack-sources@3.2.3) zod: 3.23.8 optionalDependencies: - vite: 5.4.6(@types/node@22.5.5)(sugarss@4.0.1(postcss@8.4.47)) + vite: 5.4.7(@types/node@22.6.1)(sugarss@4.0.1(postcss@8.4.47)) transitivePeerDependencies: - supports-color - webpack-sources @@ -5072,18 +5073,18 @@ snapshots: dependencies: '@types/http-cache-semantics': 4.0.4 '@types/keyv': 3.1.4 - '@types/node': 22.5.5 + '@types/node': 22.6.1 '@types/responselike': 1.0.3 '@types/cross-spawn@6.0.6': dependencies: - '@types/node': 22.5.5 + '@types/node': 22.6.1 '@types/estree@1.0.5': {} '@types/graceful-fs@4.1.9': dependencies: - '@types/node': 22.5.5 + '@types/node': 22.6.1 '@types/http-cache-semantics@4.0.4': {} @@ -5104,7 +5105,7 @@ snapshots: '@types/keyv@3.1.4': dependencies: - '@types/node': 22.5.5 + '@types/node': 22.6.1 '@types/lodash.ismatch@4.4.9': dependencies: @@ -5114,7 +5115,7 @@ snapshots: '@types/minimist@1.2.5': {} - '@types/node@22.5.5': + '@types/node@22.6.1': dependencies: undici-types: 6.19.8 @@ -5124,22 +5125,22 @@ snapshots: '@types/react-dom@18.3.0': dependencies: - '@types/react': 18.3.7 + '@types/react': 18.3.8 - '@types/react@18.3.7': + '@types/react@18.3.8': dependencies: '@types/prop-types': 15.7.13 csstype: 3.1.3 '@types/responselike@1.0.3': dependencies: - '@types/node': 22.5.5 + '@types/node': 22.6.1 '@types/stack-utils@2.0.3': {} '@types/varint@6.0.3': dependencies: - '@types/node': 22.5.5 + '@types/node': 22.6.1 '@types/yargs-parser@21.0.3': {} @@ -5147,10 +5148,10 @@ snapshots: dependencies: '@types/yargs-parser': 21.0.3 - '@vitejs/plugin-react-swc@3.7.0(vite@5.4.6(@types/node@22.5.5)(sugarss@4.0.1(postcss@8.4.47)))': + '@vitejs/plugin-react-swc@3.7.0(vite@5.4.7(@types/node@22.6.1)(sugarss@4.0.1(postcss@8.4.47)))': dependencies: '@swc/core': 1.7.18 - vite: 5.4.6(@types/node@22.5.5)(sugarss@4.0.1(postcss@8.4.47)) + vite: 5.4.7(@types/node@22.6.1)(sugarss@4.0.1(postcss@8.4.47)) transitivePeerDependencies: - '@swc/helpers' @@ -5408,7 +5409,7 @@ snapshots: optionalDependencies: fsevents: 2.3.3 - chokidar@4.0.0: + chokidar@4.0.1: dependencies: readdirp: 4.0.1 optional: true @@ -5465,13 +5466,13 @@ snapshots: convert-source-map@2.0.0: {} - create-jest@29.7.0(@types/node@22.5.5): + create-jest@29.7.0(@types/node@22.6.1): dependencies: '@jest/types': 29.6.3 chalk: 4.1.2 exit: 0.1.2 graceful-fs: 4.2.11 - jest-config: 29.7.0(@types/node@22.5.5) + jest-config: 29.7.0(@types/node@22.6.1) jest-util: 29.7.0 prompts: 2.4.2 transitivePeerDependencies: @@ -5827,10 +5828,6 @@ snapshots: get-stream@6.0.1: {} - get-tsconfig@4.7.6: - dependencies: - resolve-pkg-maps: 1.0.0 - get-tsconfig@4.8.1: dependencies: resolve-pkg-maps: 1.0.0 @@ -6031,7 +6028,7 @@ snapshots: '@jest/expect': 29.7.0 '@jest/test-result': 29.7.0 '@jest/types': 29.6.3 - '@types/node': 22.5.5 + '@types/node': 22.6.1 chalk: 4.1.2 co: 4.6.0 dedent: 1.5.3 @@ -6051,16 +6048,16 @@ snapshots: - babel-plugin-macros - supports-color - jest-cli@29.7.0(@types/node@22.5.5): + jest-cli@29.7.0(@types/node@22.6.1): dependencies: '@jest/core': 29.7.0 '@jest/test-result': 29.7.0 '@jest/types': 29.6.3 chalk: 4.1.2 - create-jest: 29.7.0(@types/node@22.5.5) + create-jest: 29.7.0(@types/node@22.6.1) exit: 0.1.2 import-local: 3.2.0 - jest-config: 29.7.0(@types/node@22.5.5) + jest-config: 29.7.0(@types/node@22.6.1) jest-util: 29.7.0 jest-validate: 29.7.0 yargs: 17.7.2 @@ -6070,7 +6067,7 @@ snapshots: - supports-color - ts-node - jest-config@29.7.0(@types/node@22.5.5): + jest-config@29.7.0(@types/node@22.6.1): dependencies: '@babel/core': 7.25.2 '@jest/test-sequencer': 29.7.0 @@ -6095,7 +6092,7 @@ snapshots: slash: 3.0.0 strip-json-comments: 3.1.1 optionalDependencies: - '@types/node': 22.5.5 + '@types/node': 22.6.1 transitivePeerDependencies: - babel-plugin-macros - supports-color @@ -6124,7 +6121,7 @@ snapshots: '@jest/environment': 29.7.0 '@jest/fake-timers': 29.7.0 '@jest/types': 29.6.3 - '@types/node': 22.5.5 + '@types/node': 22.6.1 jest-mock: 29.7.0 jest-util: 29.7.0 @@ -6134,7 +6131,7 @@ snapshots: dependencies: '@jest/types': 29.6.3 '@types/graceful-fs': 4.1.9 - '@types/node': 22.5.5 + '@types/node': 22.6.1 anymatch: 3.1.3 fb-watchman: 2.0.2 graceful-fs: 4.2.11 @@ -6173,7 +6170,7 @@ snapshots: jest-mock@29.7.0: dependencies: '@jest/types': 29.6.3 - '@types/node': 22.5.5 + '@types/node': 22.6.1 jest-util: 29.7.0 jest-pnp-resolver@1.2.3(jest-resolve@29.7.0): @@ -6208,7 +6205,7 @@ snapshots: '@jest/test-result': 29.7.0 '@jest/transform': 29.7.0 '@jest/types': 29.6.3 - '@types/node': 22.5.5 + '@types/node': 22.6.1 chalk: 4.1.2 emittery: 0.13.1 graceful-fs: 4.2.11 @@ -6236,7 +6233,7 @@ snapshots: '@jest/test-result': 29.7.0 '@jest/transform': 29.7.0 '@jest/types': 29.6.3 - '@types/node': 22.5.5 + '@types/node': 22.6.1 chalk: 4.1.2 cjs-module-lexer: 1.3.1 collect-v8-coverage: 1.0.2 @@ -6282,7 +6279,7 @@ snapshots: jest-util@29.7.0: dependencies: '@jest/types': 29.6.3 - '@types/node': 22.5.5 + '@types/node': 22.6.1 chalk: 4.1.2 ci-info: 3.9.0 graceful-fs: 4.2.11 @@ -6301,7 +6298,7 @@ snapshots: dependencies: '@jest/test-result': 29.7.0 '@jest/types': 29.6.3 - '@types/node': 22.5.5 + '@types/node': 22.6.1 ansi-escapes: 4.3.2 chalk: 4.1.2 emittery: 0.13.1 @@ -6310,26 +6307,26 @@ snapshots: jest-worker@29.7.0: dependencies: - '@types/node': 22.5.5 + '@types/node': 22.6.1 jest-util: 29.7.0 merge-stream: 2.0.0 supports-color: 8.1.1 - jest@29.7.0(@types/node@22.5.5): + jest@29.7.0(@types/node@22.6.1): dependencies: '@jest/core': 29.7.0 '@jest/types': 29.6.3 import-local: 3.2.0 - jest-cli: 29.7.0(@types/node@22.5.5) + jest-cli: 29.7.0(@types/node@22.6.1) transitivePeerDependencies: - '@types/node' - babel-plugin-macros - supports-color - ts-node - jotai@2.9.3(@types/react@18.3.7)(react@18.3.1): + jotai@2.10.0(@types/react@18.3.8)(react@18.3.1): optionalDependencies: - '@types/react': 18.3.7 + '@types/react': 18.3.8 react: 18.3.1 js-levenshtein@1.1.6: {} @@ -6573,15 +6570,15 @@ snapshots: dependencies: mimic-fn: 2.1.0 - openapi-fetch@0.12.0: + openapi-fetch@0.12.2: dependencies: openapi-typescript-helpers: 0.0.13 openapi-typescript-helpers@0.0.13: {} - openapi-typescript@7.4.0(typescript@5.6.2): + openapi-typescript@7.4.1(typescript@5.6.2): dependencies: - '@redocly/openapi-core': 1.25.2(supports-color@9.4.0) + '@redocly/openapi-core': 1.25.3(supports-color@9.4.0) ansi-colors: 4.1.3 change-case: 5.4.4 parse-json: 8.1.0 @@ -6746,40 +6743,40 @@ snapshots: react: 18.3.1 react-dom: 18.3.1(react@18.3.1) - react-remove-scroll-bar@2.3.6(@types/react@18.3.7)(react@18.3.1): + react-remove-scroll-bar@2.3.6(@types/react@18.3.8)(react@18.3.1): dependencies: react: 18.3.1 - react-style-singleton: 2.2.1(@types/react@18.3.7)(react@18.3.1) + react-style-singleton: 2.2.1(@types/react@18.3.8)(react@18.3.1) tslib: 2.7.0 optionalDependencies: - '@types/react': 18.3.7 + '@types/react': 18.3.8 - react-remove-scroll@2.6.0(@types/react@18.3.7)(react@18.3.1): + react-remove-scroll@2.6.0(@types/react@18.3.8)(react@18.3.1): dependencies: react: 18.3.1 - react-remove-scroll-bar: 2.3.6(@types/react@18.3.7)(react@18.3.1) - react-style-singleton: 2.2.1(@types/react@18.3.7)(react@18.3.1) + react-remove-scroll-bar: 2.3.6(@types/react@18.3.8)(react@18.3.1) + react-style-singleton: 2.2.1(@types/react@18.3.8)(react@18.3.1) tslib: 2.7.0 - use-callback-ref: 1.3.2(@types/react@18.3.7)(react@18.3.1) - use-sidecar: 1.1.2(@types/react@18.3.7)(react@18.3.1) + use-callback-ref: 1.3.2(@types/react@18.3.8)(react@18.3.1) + use-sidecar: 1.1.2(@types/react@18.3.8)(react@18.3.1) optionalDependencies: - '@types/react': 18.3.7 + '@types/react': 18.3.8 - react-style-singleton@2.2.1(@types/react@18.3.7)(react@18.3.1): + react-style-singleton@2.2.1(@types/react@18.3.8)(react@18.3.1): dependencies: get-nonce: 1.0.1 invariant: 2.2.4 react: 18.3.1 tslib: 2.7.0 optionalDependencies: - '@types/react': 18.3.7 + '@types/react': 18.3.8 - react-textarea-autosize@8.5.3(@types/react@18.3.7)(react@18.3.1): + react-textarea-autosize@8.5.3(@types/react@18.3.8)(react@18.3.1): dependencies: '@babel/runtime': 7.25.6 react: 18.3.1 use-composed-ref: 1.3.0(react@18.3.1) - use-latest: 1.2.1(@types/react@18.3.7)(react@18.3.1) + use-latest: 1.2.1(@types/react@18.3.8)(react@18.3.1) transitivePeerDependencies: - '@types/react' @@ -6856,26 +6853,26 @@ snapshots: dependencies: glob: 7.2.3 - rollup@4.21.3: + rollup@4.22.4: dependencies: '@types/estree': 1.0.5 optionalDependencies: - '@rollup/rollup-android-arm-eabi': 4.21.3 - '@rollup/rollup-android-arm64': 4.21.3 - '@rollup/rollup-darwin-arm64': 4.21.3 - '@rollup/rollup-darwin-x64': 4.21.3 - '@rollup/rollup-linux-arm-gnueabihf': 4.21.3 - '@rollup/rollup-linux-arm-musleabihf': 4.21.3 - '@rollup/rollup-linux-arm64-gnu': 4.21.3 - '@rollup/rollup-linux-arm64-musl': 4.21.3 - '@rollup/rollup-linux-powerpc64le-gnu': 4.21.3 - '@rollup/rollup-linux-riscv64-gnu': 4.21.3 - '@rollup/rollup-linux-s390x-gnu': 4.21.3 - '@rollup/rollup-linux-x64-gnu': 4.21.3 - '@rollup/rollup-linux-x64-musl': 4.21.3 - '@rollup/rollup-win32-arm64-msvc': 4.21.3 - '@rollup/rollup-win32-ia32-msvc': 4.21.3 - '@rollup/rollup-win32-x64-msvc': 4.21.3 + '@rollup/rollup-android-arm-eabi': 4.22.4 + '@rollup/rollup-android-arm64': 4.22.4 + '@rollup/rollup-darwin-arm64': 4.22.4 + '@rollup/rollup-darwin-x64': 4.22.4 + '@rollup/rollup-linux-arm-gnueabihf': 4.22.4 + '@rollup/rollup-linux-arm-musleabihf': 4.22.4 + '@rollup/rollup-linux-arm64-gnu': 4.22.4 + '@rollup/rollup-linux-arm64-musl': 4.22.4 + '@rollup/rollup-linux-powerpc64le-gnu': 4.22.4 + '@rollup/rollup-linux-riscv64-gnu': 4.22.4 + '@rollup/rollup-linux-s390x-gnu': 4.22.4 + '@rollup/rollup-linux-x64-gnu': 4.22.4 + '@rollup/rollup-linux-x64-musl': 4.22.4 + '@rollup/rollup-win32-arm64-msvc': 4.22.4 + '@rollup/rollup-win32-ia32-msvc': 4.22.4 + '@rollup/rollup-win32-x64-msvc': 4.22.4 fsevents: 2.3.3 rpc-utils@0.6.2: @@ -7060,13 +7057,6 @@ snapshots: tslib@2.7.0: {} - tsx@4.19.0: - dependencies: - esbuild: 0.23.1 - get-tsconfig: 4.7.6 - optionalDependencies: - fsevents: 2.3.3 - tsx@4.19.1: dependencies: esbuild: 0.23.1 @@ -7136,37 +7126,37 @@ snapshots: uri-js-replace@1.0.1: {} - use-callback-ref@1.3.2(@types/react@18.3.7)(react@18.3.1): + use-callback-ref@1.3.2(@types/react@18.3.8)(react@18.3.1): dependencies: react: 18.3.1 tslib: 2.7.0 optionalDependencies: - '@types/react': 18.3.7 + '@types/react': 18.3.8 use-composed-ref@1.3.0(react@18.3.1): dependencies: react: 18.3.1 - use-isomorphic-layout-effect@1.1.2(@types/react@18.3.7)(react@18.3.1): + use-isomorphic-layout-effect@1.1.2(@types/react@18.3.8)(react@18.3.1): dependencies: react: 18.3.1 optionalDependencies: - '@types/react': 18.3.7 + '@types/react': 18.3.8 - use-latest@1.2.1(@types/react@18.3.7)(react@18.3.1): + use-latest@1.2.1(@types/react@18.3.8)(react@18.3.1): dependencies: react: 18.3.1 - use-isomorphic-layout-effect: 1.1.2(@types/react@18.3.7)(react@18.3.1) + use-isomorphic-layout-effect: 1.1.2(@types/react@18.3.8)(react@18.3.1) optionalDependencies: - '@types/react': 18.3.7 + '@types/react': 18.3.8 - use-sidecar@1.1.2(@types/react@18.3.7)(react@18.3.1): + use-sidecar@1.1.2(@types/react@18.3.8)(react@18.3.1): dependencies: detect-node-es: 1.1.0 react: 18.3.1 tslib: 2.7.0 optionalDependencies: - '@types/react': 18.3.7 + '@types/react': 18.3.8 use-sync-external-store@1.2.2(react@18.3.1): dependencies: @@ -7206,7 +7196,7 @@ snapshots: - utf-8-validate - zod - viem@2.21.8(typescript@5.6.2)(zod@3.23.8): + viem@2.21.14(typescript@5.6.2)(zod@3.23.8): dependencies: '@adraffy/ens-normalize': 1.10.0 '@noble/curves': 1.4.0 @@ -7224,13 +7214,13 @@ snapshots: - utf-8-validate - zod - vite@5.4.6(@types/node@22.5.5)(sugarss@4.0.1(postcss@8.4.47)): + vite@5.4.7(@types/node@22.6.1)(sugarss@4.0.1(postcss@8.4.47)): dependencies: esbuild: 0.21.5 postcss: 8.4.47 - rollup: 4.21.3 + rollup: 4.22.4 optionalDependencies: - '@types/node': 22.5.5 + '@types/node': 22.6.1 fsevents: 2.3.3 sugarss: 4.0.1(postcss@8.4.47) From 5b9b23a9f38fa2a20b40c359d1131388424fe425 Mon Sep 17 00:00:00 2001 From: Paul Le Cam Date: Wed, 25 Sep 2024 09:55:40 +0100 Subject: [PATCH 2/7] Add integration tests for stream client classes --- apps/explorer/package.json | 8 +- package.json | 2 +- packages/identifiers/src/codecs.ts | 12 +- packages/model-client/package.json | 2 +- packages/model-client/src/index.ts | 29 ++- packages/model-client/test/lib.test.ts | 43 +++- packages/model-instance-client/src/client.ts | 14 +- .../model-instance-client/test/lib.test.ts | 19 ++ packages/test-vectors/package.json | 2 +- pnpm-lock.yaml | 210 +++++++++--------- tests/c1-integration/test/classes.test.ts | 199 +++++++++++++++++ 11 files changed, 419 insertions(+), 121 deletions(-) create mode 100644 tests/c1-integration/test/classes.test.ts diff --git a/apps/explorer/package.json b/apps/explorer/package.json index 5e7b964..218c35e 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.58.7", + "@tanstack/react-router": "^1.58.9", "codeco": "^1.4.3", "jotai": "^2.10.0", "multiformats": "^13.3.0", @@ -32,9 +32,9 @@ "devDependencies": { "@ceramic-sdk/model-client": "workspace:^", "@ceramic-sdk/model-instance-client": "workspace:^", - "@tanstack/router-devtools": "^1.58.7", + "@tanstack/router-devtools": "^1.58.9", "@tanstack/router-plugin": "^1.58.4", - "@types/react": "^18.3.8", + "@types/react": "^18.3.9", "@types/react-dom": "^18.3.0", "@vitejs/plugin-react-swc": "^3.5.0", "postcss": "^8.4.47", @@ -42,6 +42,6 @@ "postcss-simple-vars": "^7.0.1", "ts-essentials": "^10.0.2", "typescript": "^5.6.2", - "vite": "^5.4.7" + "vite": "^5.4.8" } } diff --git a/package.json b/package.json index 28871a8..a19d4b2 100644 --- a/package.json +++ b/package.json @@ -17,7 +17,7 @@ "@swc/core": "^1.7.11", "@swc/jest": "^0.2.36", "@types/jest": "^29.5.13", - "@types/node": "^22.6.1", + "@types/node": "^22.7.0", "del-cli": "^5.1.0", "jest": "^29.7.0", "tsx": "^4.19.1", diff --git a/packages/identifiers/src/codecs.ts b/packages/identifiers/src/codecs.ts index 7e1b4f7..3837b74 100644 --- a/packages/identifiers/src/codecs.ts +++ b/packages/identifiers/src/codecs.ts @@ -44,12 +44,18 @@ export const streamIDAsString = new Type( /** * codeco codec for StreamID encoded as Uint8Array bytes. */ -export const streamIDAsBytes = new Type( +export const streamIDAsBytes = new Type< + StreamID, + Uint8Array, + StreamID | Uint8Array +>( 'StreamID-as-bytes', (input: unknown): input is StreamID => StreamID.isInstance(input), - (input: Uint8Array, context: Context) => { + (input: StreamID | Uint8Array, context: Context) => { try { - return context.success(StreamID.fromBytes(input)) + return context.success( + StreamID.isInstance(input) ? input : StreamID.fromBytes(input), + ) } catch { return context.failure() } diff --git a/packages/model-client/package.json b/packages/model-client/package.json index 564309e..d168bd7 100644 --- a/packages/model-client/package.json +++ b/packages/model-client/package.json @@ -34,10 +34,10 @@ "dependencies": { "@ceramic-sdk/events": "workspace:^", "@ceramic-sdk/http-client": "workspace:^", + "@ceramic-sdk/identifiers": "workspace:^", "@ceramic-sdk/model-protocol": "workspace:^" }, "devDependencies": { - "@ceramic-sdk/identifiers": "workspace:^", "@ceramic-sdk/test-utils": "workspace:^", "@didtools/key-did": "^1.0.0", "dids": "^5.0.2" diff --git a/packages/model-client/src/index.ts b/packages/model-client/src/index.ts index 2f80f47..c386dee 100644 --- a/packages/model-client/src/index.ts +++ b/packages/model-client/src/index.ts @@ -2,12 +2,14 @@ import { type PartialInitEventHeader, SignedEvent, createSignedInitEvent, + eventToContainer, } from '@ceramic-sdk/events' import { type CeramicClient, getCeramicClient } from '@ceramic-sdk/http-client' -import type { StreamID } from '@ceramic-sdk/identifiers' +import { StreamID } from '@ceramic-sdk/identifiers' import { MODEL, type ModelDefinition, + ModelInitEventPayload, assertValidModelContent, getModelStreamID, validateController, @@ -55,11 +57,30 @@ export class ModelClient { throw new Error('Missing DID') } - async postModel( + async getInitEvent(streamID: StreamID | string): Promise { + const id = + typeof streamID === 'string' ? StreamID.fromString(streamID) : streamID + return await this.#ceramic.getEventType(SignedEvent, id.cid.toString()) + } + + async getPayload( + streamID: StreamID | string, + verifier?: DID, + ): Promise { + const event = await this.getInitEvent(streamID) + const container = await eventToContainer( + this._getDID(verifier), + ModelInitEventPayload, + event, + ) + return container.payload + } + + async postDefinition( definition: ModelDefinition, - useDID?: DID, + signer?: DID, ): Promise { - const did = this._getDID(useDID) + const did = this._getDID(signer) const event = await createInitEvent(did, definition) const cid = await this.#ceramic.postEventType(SignedEvent, event) return getModelStreamID(cid) diff --git a/packages/model-client/test/lib.test.ts b/packages/model-client/test/lib.test.ts index a3ea433..38e862f 100644 --- a/packages/model-client/test/lib.test.ts +++ b/packages/model-client/test/lib.test.ts @@ -1,6 +1,6 @@ -import { assertSignedEvent } from '@ceramic-sdk/events' +import { SignedEvent, assertSignedEvent } from '@ceramic-sdk/events' import type { CeramicClient } from '@ceramic-sdk/http-client' -import { StreamID, randomCID } from '@ceramic-sdk/identifiers' +import { StreamID, randomCID, randomStreamID } from '@ceramic-sdk/identifiers' import { MODEL_RESOURCE_URI, type ModelDefinition, @@ -100,13 +100,48 @@ describe('ModelClient', () => { }) }) - describe('postDeterministicInit() method', () => { + describe('getInitEvent() method', () => { + test('gets the model init event', async () => { + const modelEvent = await createInitEvent(authenticatedDID, testModelV1) + const getEventType = jest.fn(() => modelEvent) + const ceramic = { getEventType } as unknown as CeramicClient + const client = new ModelClient({ ceramic, did: authenticatedDID }) + + const modelID = randomStreamID() + const event = await client.getInitEvent(modelID) + expect(getEventType).toHaveBeenCalledWith( + SignedEvent, + modelID.cid.toString(), + ) + expect(event).toBe(modelEvent) + }) + }) + + describe('getPayload() method', () => { + test('gets the model init event payload', async () => { + const modelEvent = await createInitEvent(authenticatedDID, testModelV1) + const getEventType = jest.fn(() => modelEvent) + const ceramic = { getEventType } as unknown as CeramicClient + const client = new ModelClient({ ceramic, did: authenticatedDID }) + + const modelID = randomStreamID() + const payload = await client.getPayload(modelID) + expect(getEventType).toHaveBeenCalledWith( + SignedEvent, + modelID.cid.toString(), + ) + expect(payload.header.controllers).toEqual([authenticatedDID.id]) + expect(payload.data).toEqual(testModelV1) + }) + }) + + describe('postDefinition() method', () => { test('posts the signed event and returns the model StreamID', async () => { const postEventType = jest.fn(() => randomCID()) const ceramic = { postEventType } as unknown as CeramicClient const client = new ModelClient({ ceramic, did: authenticatedDID }) - const id = await client.postModel(testModelV1) + const id = await client.postDefinition(testModelV1) expect(postEventType).toHaveBeenCalled() expect(id).toBeInstanceOf(StreamID) expect(id.type).toBe(STREAM_TYPE_ID) diff --git a/packages/model-instance-client/src/client.ts b/packages/model-instance-client/src/client.ts index 0ad0ca6..7594760 100644 --- a/packages/model-instance-client/src/client.ts +++ b/packages/model-instance-client/src/client.ts @@ -1,7 +1,10 @@ import { InitEventPayload, SignedEvent } from '@ceramic-sdk/events' import { type CeramicClient, getCeramicClient } from '@ceramic-sdk/http-client' import { CommitID, type StreamID } from '@ceramic-sdk/identifiers' -import { getStreamID } from '@ceramic-sdk/model-instance-protocol' +import { + DocumentEvent, + getStreamID, +} from '@ceramic-sdk/model-instance-protocol' import type { DIDString } from '@didtools/codecs' import type { DID } from 'dids' @@ -56,6 +59,15 @@ export class DocumentClient { throw new Error('Missing DID') } + async getEvent(commitID: CommitID | string): Promise { + const id = + typeof commitID === 'string' ? CommitID.fromString(commitID) : commitID + return (await this.#ceramic.getEventType( + DocumentEvent, + id.commit.toString(), + )) as DocumentEvent + } + async postDeterministicInit( params: PostDeterministicInitParams, ): Promise { diff --git a/packages/model-instance-client/test/lib.test.ts b/packages/model-instance-client/test/lib.test.ts index d3bdef0..45ec814 100644 --- a/packages/model-instance-client/test/lib.test.ts +++ b/packages/model-instance-client/test/lib.test.ts @@ -4,6 +4,7 @@ import { CommitID, randomCID, randomStreamID } from '@ceramic-sdk/identifiers' import { DataInitEventPayload, DocumentDataEventPayload, + DocumentEvent, STREAM_TYPE_ID, } from '@ceramic-sdk/model-instance-protocol' import { getAuthenticatedDID } from '@didtools/key-did' @@ -161,6 +162,24 @@ describe('DocumentClient', () => { }) }) + describe('getEvent() method', () => { + test('gets a MID event by commit ID', async () => { + const streamID = randomStreamID() + const docEvent = getDeterministicInitEvent(streamID, 'did:key:123') + const getEventType = jest.fn(() => docEvent) + const ceramic = { getEventType } as unknown as CeramicClient + const client = new DocumentClient({ ceramic, did: authenticatedDID }) + + const commitID = CommitID.fromStream(streamID) + const event = await client.getEvent(CommitID.fromStream(streamID)) + expect(getEventType).toHaveBeenCalledWith( + DocumentEvent, + commitID.cid.toString(), + ) + expect(event).toBe(docEvent) + }) + }) + describe('postDeterministicInit() method', () => { test('posts the deterministic init event and returns the MID init CommitID', async () => { const postEventType = jest.fn(() => randomCID()) diff --git a/packages/test-vectors/package.json b/packages/test-vectors/package.json index fcdad25..731c62a 100644 --- a/packages/test-vectors/package.json +++ b/packages/test-vectors/package.json @@ -55,7 +55,7 @@ "@noble/curves": "^1.6.0", "@solana/signers": "^2.0.0-rc.1", "caip": "^1.1.1", - "cborg": "^4.2.3", + "cborg": "^4.2.4", "did-session": "^4.0.0", "dids": "^5.0.2", "key-did-resolver": "^4.0.0", diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml index 3d5bfc1..eb9997c 100644 --- a/pnpm-lock.yaml +++ b/pnpm-lock.yaml @@ -30,14 +30,14 @@ importers: specifier: ^29.5.13 version: 29.5.13 '@types/node': - specifier: ^22.6.1 - version: 22.6.1 + specifier: ^22.7.0 + version: 22.7.0 del-cli: specifier: ^5.1.0 version: 5.1.0 jest: specifier: ^29.7.0 - version: 29.7.0(@types/node@22.6.1) + version: 29.7.0(@types/node@22.7.0) tsx: specifier: ^4.19.1 version: 4.19.1 @@ -70,7 +70,7 @@ importers: version: 1.0.0(typescript@5.6.2)(zod@3.23.8) '@mantine/core': specifier: ^7.12.2 - version: 7.12.2(@mantine/hooks@7.12.2(react@18.3.1))(@types/react@18.3.8)(react-dom@18.3.1(react@18.3.1))(react@18.3.1) + version: 7.12.2(@mantine/hooks@7.12.2(react@18.3.1))(@types/react@18.3.9)(react-dom@18.3.1(react@18.3.1))(react@18.3.1) '@mantine/hooks': specifier: ^7.12.2 version: 7.12.2(react@18.3.1) @@ -81,14 +81,14 @@ importers: specifier: ^5.56.2 version: 5.56.2(react@18.3.1) '@tanstack/react-router': - specifier: ^1.58.7 - version: 1.58.7(@tanstack/router-generator@1.58.1)(react-dom@18.3.1(react@18.3.1))(react@18.3.1) + specifier: ^1.58.9 + version: 1.58.9(@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 jotai: specifier: ^2.10.0 - version: 2.10.0(@types/react@18.3.8)(react@18.3.1) + version: 2.10.0(@types/react@18.3.9)(react@18.3.1) multiformats: specifier: ^13.3.0 version: 13.3.0 @@ -106,20 +106,20 @@ importers: specifier: workspace:^ version: link:../../packages/model-instance-client '@tanstack/router-devtools': - specifier: ^1.58.7 - version: 1.58.7(@tanstack/react-router@1.58.7(@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) + specifier: ^1.58.9 + version: 1.58.9(@tanstack/react-router@1.58.9(@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.58.4 - version: 1.58.4(vite@5.4.7(@types/node@22.6.1)(sugarss@4.0.1(postcss@8.4.47)))(webpack-sources@3.2.3) + version: 1.58.4(vite@5.4.8(@types/node@22.7.0)(sugarss@4.0.1(postcss@8.4.47)))(webpack-sources@3.2.3) '@types/react': - specifier: ^18.3.8 - version: 18.3.8 + specifier: ^18.3.9 + version: 18.3.9 '@types/react-dom': specifier: ^18.3.0 version: 18.3.0 '@vitejs/plugin-react-swc': specifier: ^3.5.0 - version: 3.7.0(vite@5.4.7(@types/node@22.6.1)(sugarss@4.0.1(postcss@8.4.47))) + version: 3.7.0(vite@5.4.8(@types/node@22.7.0)(sugarss@4.0.1(postcss@8.4.47))) postcss: specifier: ^8.4.47 version: 8.4.47 @@ -136,8 +136,8 @@ importers: specifier: ^5.6.2 version: 5.6.2 vite: - specifier: ^5.4.7 - version: 5.4.7(@types/node@22.6.1)(sugarss@4.0.1(postcss@8.4.47)) + specifier: ^5.4.8 + version: 5.4.8(@types/node@22.7.0)(sugarss@4.0.1(postcss@8.4.47)) packages/events: dependencies: @@ -256,13 +256,13 @@ importers: '@ceramic-sdk/http-client': specifier: workspace:^ version: link:../http-client + '@ceramic-sdk/identifiers': + specifier: workspace:^ + version: link:../identifiers '@ceramic-sdk/model-protocol': specifier: workspace:^ version: link:../model-protocol devDependencies: - '@ceramic-sdk/identifiers': - specifier: workspace:^ - version: link:../identifiers '@ceramic-sdk/test-utils': specifier: workspace:^ version: link:../test-utils @@ -541,8 +541,8 @@ importers: specifier: ^1.1.1 version: 1.1.1 cborg: - specifier: ^4.2.3 - version: 4.2.3 + specifier: ^4.2.4 + version: 4.2.4 did-session: specifier: ^4.0.0 version: 4.0.0(typescript@5.6.2)(zod@3.23.8) @@ -1663,8 +1663,8 @@ packages: peerDependencies: react: ^18 || ^19 - '@tanstack/react-router@1.58.7': - resolution: {integrity: sha512-iu4WtrhXz0YcJzPMlyP4jT3zfEKJH+dVVKViK8ayL1hWjP2n6A08kYE1hcT3YmuK2LmNmMsnGS+Tc7WAFsHgZQ==} + '@tanstack/react-router@1.58.9': + resolution: {integrity: sha512-ODKOo8bUo8nIPGZmJHa7zNul9U3XAMmohnwZLl2A/A3suU03Q+0R5oOfhUKw+qArPIdIcec1VtqYpNk6y7qfrQ==} engines: {node: '>=12'} peerDependencies: '@tanstack/router-generator': 1.58.1 @@ -1680,11 +1680,11 @@ packages: react: ^17.0.0 || ^18.0.0 react-dom: ^17.0.0 || ^18.0.0 - '@tanstack/router-devtools@1.58.7': - resolution: {integrity: sha512-bZL3VDmS63gOW+RKSXRQ7uagATP1k8sM+ucHrcLy98hcVxzYRVwIwVgqTZY2KtUSXgFwb4LXClAdZdiJM9i+gw==} + '@tanstack/router-devtools@1.58.9': + resolution: {integrity: sha512-caaompIgBaAoGnmz8cn4w/c3DtkvKBPv717hDYoN+nW/oHJgxSgnOyL/QEwGNv1XNtlMHjwEfhlGHnjqorjHKQ==} engines: {node: '>=12'} peerDependencies: - '@tanstack/react-router': ^1.58.7 + '@tanstack/react-router': ^1.58.9 react: '>=18' react-dom: '>=18' @@ -1768,8 +1768,8 @@ packages: '@types/minimist@1.2.5': resolution: {integrity: sha512-hov8bUuiLiyFPGyFPE1lwWhmzYbirOXQNNo40+y3zow8aFVTeyn3VWL0VFFfdNddA8S4Vf0Tc062rzyNr7Paag==} - '@types/node@22.6.1': - resolution: {integrity: sha512-V48tCfcKb/e6cVUigLAaJDAILdMP0fUW6BidkPK4GpGjXcfbnoHasCZDwz3N3yVt5we2RHm4XTQCpv0KJz9zqw==} + '@types/node@22.7.0': + resolution: {integrity: sha512-MOdOibwBs6KW1vfqz2uKMlxq5xAfAZ98SZjO8e3XnAbFnTJtAspqhWk7hrdSAs9/Y14ZWMiy7/MxMUzAOadYEw==} '@types/normalize-package-data@2.4.4': resolution: {integrity: sha512-37i+OaWTh9qeK4LSHPsyRC7NahnGotNuZvjLSgcPzblpHB3rrCJxAOgI5gCdKm7coonsaX1Of0ILiTcnZjbfxA==} @@ -1780,8 +1780,8 @@ packages: '@types/react-dom@18.3.0': resolution: {integrity: sha512-EhwApuTmMBmXuFOikhQLIBUn6uFg81SwLMOAUgodJF14SOBOCMdU04gDoYi0WOJJHD144TL32z4yDqCW3dnkQg==} - '@types/react@18.3.8': - resolution: {integrity: sha512-syBUrW3/XpnW4WJ41Pft+I+aPoDVbrBVQGEnbD7NijDGlVC+8gV/XKRY+7vMDlfPpbwYt0l1vd/Sj8bJGMbs9Q==} + '@types/react@18.3.9': + resolution: {integrity: sha512-+BpAVyTpJkNWWSSnaLBk6ePpHLOGJKnEQNbINNovPWzvEUyAe3e+/d494QdEh71RekM/qV7lw6jzf1HGrJyAtQ==} '@types/responselike@1.0.3': resolution: {integrity: sha512-H/+L+UkTV33uf49PH5pCAUBVPNj2nDBXTN+qS1dOwyyg24l3CcicicCA7ca+HMvJBZcFgl5r8e+RR6elsb4Lyw==} @@ -2012,6 +2012,10 @@ packages: resolution: {integrity: sha512-XBFbEJ6WMfn9L7woc2t+EzOxF8vGqddoopKBbrhIvZBt2WIUgSlT8xLmM6Aq1xv8eWt4yOSjwxWjYeuHU3CpJA==} hasBin: true + cborg@4.2.4: + resolution: {integrity: sha512-ns2xY95zViHIVy4lq+qdLmfXTpnT3XjmKradz4RJxxbr5jc/A5gS5FiFLcPGhSdHVlSeeoizT1fuKdI1Kcd6oA==} + hasBin: true + chalk@2.4.2: resolution: {integrity: sha512-Mti+f9lpJNcwF4tWV8/OrTTtF1gZi+f8FqlyAdouralcFWFQWF2+NgCHShjkCb+IFBLq9buZwE1xckQU4peSuQ==} engines: {node: '>=4'} @@ -3696,8 +3700,8 @@ packages: typescript: optional: true - vite@5.4.7: - resolution: {integrity: sha512-5l2zxqMEPVENgvzTuBpHer2awaetimj2BGkhBPdnwKbPNOlHsODU+oiazEZzLK7KhAnOrO+XGYJYn4ZlUhDtDQ==} + vite@5.4.8: + resolution: {integrity: sha512-FqrItQ4DT1NC4zCUqMB4c4AZORMKIa0m8/URVCZ77OZ/QSNeJ54bU1vrFADbDsuwfIPcgknRkmqakQcgnL4GiQ==} engines: {node: ^18.0.0 || >=20.0.0} hasBin: true peerDependencies: @@ -4140,7 +4144,7 @@ snapshots: '@ipld/dag-cbor': 9.2.1 '@noble/curves': 1.6.0 caip: 1.1.1 - cborg: 4.2.3 + cborg: 4.2.4 multiformats: 13.3.0 uint8arrays: 5.1.0 varint: 6.0.0 @@ -4389,7 +4393,7 @@ snapshots: '@jest/console@29.7.0': dependencies: '@jest/types': 29.6.3 - '@types/node': 22.6.1 + '@types/node': 22.7.0 chalk: 4.1.2 jest-message-util: 29.7.0 jest-util: 29.7.0 @@ -4402,14 +4406,14 @@ snapshots: '@jest/test-result': 29.7.0 '@jest/transform': 29.7.0 '@jest/types': 29.6.3 - '@types/node': 22.6.1 + '@types/node': 22.7.0 ansi-escapes: 4.3.2 chalk: 4.1.2 ci-info: 3.9.0 exit: 0.1.2 graceful-fs: 4.2.11 jest-changed-files: 29.7.0 - jest-config: 29.7.0(@types/node@22.6.1) + jest-config: 29.7.0(@types/node@22.7.0) jest-haste-map: 29.7.0 jest-message-util: 29.7.0 jest-regex-util: 29.6.3 @@ -4438,7 +4442,7 @@ snapshots: dependencies: '@jest/fake-timers': 29.7.0 '@jest/types': 29.6.3 - '@types/node': 22.6.1 + '@types/node': 22.7.0 jest-mock: 29.7.0 '@jest/expect-utils@29.7.0': @@ -4456,7 +4460,7 @@ snapshots: dependencies: '@jest/types': 29.6.3 '@sinonjs/fake-timers': 10.3.0 - '@types/node': 22.6.1 + '@types/node': 22.7.0 jest-message-util: 29.7.0 jest-mock: 29.7.0 jest-util: 29.7.0 @@ -4478,7 +4482,7 @@ snapshots: '@jest/transform': 29.7.0 '@jest/types': 29.6.3 '@jridgewell/trace-mapping': 0.3.25 - '@types/node': 22.6.1 + '@types/node': 22.7.0 chalk: 4.1.2 collect-v8-coverage: 1.0.2 exit: 0.1.2 @@ -4548,7 +4552,7 @@ snapshots: '@jest/schemas': 29.6.3 '@types/istanbul-lib-coverage': 2.0.6 '@types/istanbul-reports': 3.0.4 - '@types/node': 22.6.1 + '@types/node': 22.7.0 '@types/yargs': 17.0.32 chalk: 4.1.2 @@ -4569,7 +4573,7 @@ snapshots: '@jridgewell/resolve-uri': 3.1.2 '@jridgewell/sourcemap-codec': 1.5.0 - '@mantine/core@7.12.2(@mantine/hooks@7.12.2(react@18.3.1))(@types/react@18.3.8)(react-dom@18.3.1(react@18.3.1))(react@18.3.1)': + '@mantine/core@7.12.2(@mantine/hooks@7.12.2(react@18.3.1))(@types/react@18.3.9)(react-dom@18.3.1(react@18.3.1))(react@18.3.1)': dependencies: '@floating-ui/react': 0.26.24(react-dom@18.3.1(react@18.3.1))(react@18.3.1) '@mantine/hooks': 7.12.2(react@18.3.1) @@ -4577,8 +4581,8 @@ snapshots: react: 18.3.1 react-dom: 18.3.1(react@18.3.1) react-number-format: 5.4.2(react-dom@18.3.1(react@18.3.1))(react@18.3.1) - react-remove-scroll: 2.6.0(@types/react@18.3.8)(react@18.3.1) - react-textarea-autosize: 8.5.3(@types/react@18.3.8)(react@18.3.1) + react-remove-scroll: 2.6.0(@types/react@18.3.9)(react@18.3.1) + react-textarea-autosize: 8.5.3(@types/react@18.3.9)(react@18.3.1) type-fest: 4.26.1 transitivePeerDependencies: - '@types/react' @@ -4981,7 +4985,7 @@ snapshots: '@tanstack/query-core': 5.56.2 react: 18.3.1 - '@tanstack/react-router@1.58.7(@tanstack/router-generator@1.58.1)(react-dom@18.3.1(react@18.3.1))(react@18.3.1)': + '@tanstack/react-router@1.58.9(@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) @@ -4999,9 +5003,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.58.7(@tanstack/react-router@1.58.7(@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-devtools@1.58.9(@tanstack/react-router@1.58.9(@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.58.7(@tanstack/router-generator@1.58.1)(react-dom@18.3.1(react@18.3.1))(react@18.3.1) + '@tanstack/react-router': 1.58.9(@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 @@ -5016,7 +5020,7 @@ snapshots: tsx: 4.19.1 zod: 3.23.8 - '@tanstack/router-plugin@1.58.4(vite@5.4.7(@types/node@22.6.1)(sugarss@4.0.1(postcss@8.4.47)))(webpack-sources@3.2.3)': + '@tanstack/router-plugin@1.58.4(vite@5.4.8(@types/node@22.7.0)(sugarss@4.0.1(postcss@8.4.47)))(webpack-sources@3.2.3)': dependencies: '@babel/core': 7.25.2 '@babel/generator': 7.25.6 @@ -5037,7 +5041,7 @@ snapshots: unplugin: 1.14.1(webpack-sources@3.2.3) zod: 3.23.8 optionalDependencies: - vite: 5.4.7(@types/node@22.6.1)(sugarss@4.0.1(postcss@8.4.47)) + vite: 5.4.8(@types/node@22.7.0)(sugarss@4.0.1(postcss@8.4.47)) transitivePeerDependencies: - supports-color - webpack-sources @@ -5073,18 +5077,18 @@ snapshots: dependencies: '@types/http-cache-semantics': 4.0.4 '@types/keyv': 3.1.4 - '@types/node': 22.6.1 + '@types/node': 22.7.0 '@types/responselike': 1.0.3 '@types/cross-spawn@6.0.6': dependencies: - '@types/node': 22.6.1 + '@types/node': 22.7.0 '@types/estree@1.0.5': {} '@types/graceful-fs@4.1.9': dependencies: - '@types/node': 22.6.1 + '@types/node': 22.7.0 '@types/http-cache-semantics@4.0.4': {} @@ -5105,7 +5109,7 @@ snapshots: '@types/keyv@3.1.4': dependencies: - '@types/node': 22.6.1 + '@types/node': 22.7.0 '@types/lodash.ismatch@4.4.9': dependencies: @@ -5115,7 +5119,7 @@ snapshots: '@types/minimist@1.2.5': {} - '@types/node@22.6.1': + '@types/node@22.7.0': dependencies: undici-types: 6.19.8 @@ -5125,22 +5129,22 @@ snapshots: '@types/react-dom@18.3.0': dependencies: - '@types/react': 18.3.8 + '@types/react': 18.3.9 - '@types/react@18.3.8': + '@types/react@18.3.9': dependencies: '@types/prop-types': 15.7.13 csstype: 3.1.3 '@types/responselike@1.0.3': dependencies: - '@types/node': 22.6.1 + '@types/node': 22.7.0 '@types/stack-utils@2.0.3': {} '@types/varint@6.0.3': dependencies: - '@types/node': 22.6.1 + '@types/node': 22.7.0 '@types/yargs-parser@21.0.3': {} @@ -5148,10 +5152,10 @@ snapshots: dependencies: '@types/yargs-parser': 21.0.3 - '@vitejs/plugin-react-swc@3.7.0(vite@5.4.7(@types/node@22.6.1)(sugarss@4.0.1(postcss@8.4.47)))': + '@vitejs/plugin-react-swc@3.7.0(vite@5.4.8(@types/node@22.7.0)(sugarss@4.0.1(postcss@8.4.47)))': dependencies: '@swc/core': 1.7.18 - vite: 5.4.7(@types/node@22.6.1)(sugarss@4.0.1(postcss@8.4.47)) + vite: 5.4.8(@types/node@22.7.0)(sugarss@4.0.1(postcss@8.4.47)) transitivePeerDependencies: - '@swc/helpers' @@ -5380,6 +5384,8 @@ snapshots: cborg@4.2.3: {} + cborg@4.2.4: {} + chalk@2.4.2: dependencies: ansi-styles: 3.2.1 @@ -5466,13 +5472,13 @@ snapshots: convert-source-map@2.0.0: {} - create-jest@29.7.0(@types/node@22.6.1): + create-jest@29.7.0(@types/node@22.7.0): dependencies: '@jest/types': 29.6.3 chalk: 4.1.2 exit: 0.1.2 graceful-fs: 4.2.11 - jest-config: 29.7.0(@types/node@22.6.1) + jest-config: 29.7.0(@types/node@22.7.0) jest-util: 29.7.0 prompts: 2.4.2 transitivePeerDependencies: @@ -6028,7 +6034,7 @@ snapshots: '@jest/expect': 29.7.0 '@jest/test-result': 29.7.0 '@jest/types': 29.6.3 - '@types/node': 22.6.1 + '@types/node': 22.7.0 chalk: 4.1.2 co: 4.6.0 dedent: 1.5.3 @@ -6048,16 +6054,16 @@ snapshots: - babel-plugin-macros - supports-color - jest-cli@29.7.0(@types/node@22.6.1): + jest-cli@29.7.0(@types/node@22.7.0): dependencies: '@jest/core': 29.7.0 '@jest/test-result': 29.7.0 '@jest/types': 29.6.3 chalk: 4.1.2 - create-jest: 29.7.0(@types/node@22.6.1) + create-jest: 29.7.0(@types/node@22.7.0) exit: 0.1.2 import-local: 3.2.0 - jest-config: 29.7.0(@types/node@22.6.1) + jest-config: 29.7.0(@types/node@22.7.0) jest-util: 29.7.0 jest-validate: 29.7.0 yargs: 17.7.2 @@ -6067,7 +6073,7 @@ snapshots: - supports-color - ts-node - jest-config@29.7.0(@types/node@22.6.1): + jest-config@29.7.0(@types/node@22.7.0): dependencies: '@babel/core': 7.25.2 '@jest/test-sequencer': 29.7.0 @@ -6092,7 +6098,7 @@ snapshots: slash: 3.0.0 strip-json-comments: 3.1.1 optionalDependencies: - '@types/node': 22.6.1 + '@types/node': 22.7.0 transitivePeerDependencies: - babel-plugin-macros - supports-color @@ -6121,7 +6127,7 @@ snapshots: '@jest/environment': 29.7.0 '@jest/fake-timers': 29.7.0 '@jest/types': 29.6.3 - '@types/node': 22.6.1 + '@types/node': 22.7.0 jest-mock: 29.7.0 jest-util: 29.7.0 @@ -6131,7 +6137,7 @@ snapshots: dependencies: '@jest/types': 29.6.3 '@types/graceful-fs': 4.1.9 - '@types/node': 22.6.1 + '@types/node': 22.7.0 anymatch: 3.1.3 fb-watchman: 2.0.2 graceful-fs: 4.2.11 @@ -6170,7 +6176,7 @@ snapshots: jest-mock@29.7.0: dependencies: '@jest/types': 29.6.3 - '@types/node': 22.6.1 + '@types/node': 22.7.0 jest-util: 29.7.0 jest-pnp-resolver@1.2.3(jest-resolve@29.7.0): @@ -6205,7 +6211,7 @@ snapshots: '@jest/test-result': 29.7.0 '@jest/transform': 29.7.0 '@jest/types': 29.6.3 - '@types/node': 22.6.1 + '@types/node': 22.7.0 chalk: 4.1.2 emittery: 0.13.1 graceful-fs: 4.2.11 @@ -6233,7 +6239,7 @@ snapshots: '@jest/test-result': 29.7.0 '@jest/transform': 29.7.0 '@jest/types': 29.6.3 - '@types/node': 22.6.1 + '@types/node': 22.7.0 chalk: 4.1.2 cjs-module-lexer: 1.3.1 collect-v8-coverage: 1.0.2 @@ -6279,7 +6285,7 @@ snapshots: jest-util@29.7.0: dependencies: '@jest/types': 29.6.3 - '@types/node': 22.6.1 + '@types/node': 22.7.0 chalk: 4.1.2 ci-info: 3.9.0 graceful-fs: 4.2.11 @@ -6298,7 +6304,7 @@ snapshots: dependencies: '@jest/test-result': 29.7.0 '@jest/types': 29.6.3 - '@types/node': 22.6.1 + '@types/node': 22.7.0 ansi-escapes: 4.3.2 chalk: 4.1.2 emittery: 0.13.1 @@ -6307,26 +6313,26 @@ snapshots: jest-worker@29.7.0: dependencies: - '@types/node': 22.6.1 + '@types/node': 22.7.0 jest-util: 29.7.0 merge-stream: 2.0.0 supports-color: 8.1.1 - jest@29.7.0(@types/node@22.6.1): + jest@29.7.0(@types/node@22.7.0): dependencies: '@jest/core': 29.7.0 '@jest/types': 29.6.3 import-local: 3.2.0 - jest-cli: 29.7.0(@types/node@22.6.1) + jest-cli: 29.7.0(@types/node@22.7.0) transitivePeerDependencies: - '@types/node' - babel-plugin-macros - supports-color - ts-node - jotai@2.10.0(@types/react@18.3.8)(react@18.3.1): + jotai@2.10.0(@types/react@18.3.9)(react@18.3.1): optionalDependencies: - '@types/react': 18.3.8 + '@types/react': 18.3.9 react: 18.3.1 js-levenshtein@1.1.6: {} @@ -6743,40 +6749,40 @@ snapshots: react: 18.3.1 react-dom: 18.3.1(react@18.3.1) - react-remove-scroll-bar@2.3.6(@types/react@18.3.8)(react@18.3.1): + react-remove-scroll-bar@2.3.6(@types/react@18.3.9)(react@18.3.1): dependencies: react: 18.3.1 - react-style-singleton: 2.2.1(@types/react@18.3.8)(react@18.3.1) + react-style-singleton: 2.2.1(@types/react@18.3.9)(react@18.3.1) tslib: 2.7.0 optionalDependencies: - '@types/react': 18.3.8 + '@types/react': 18.3.9 - react-remove-scroll@2.6.0(@types/react@18.3.8)(react@18.3.1): + react-remove-scroll@2.6.0(@types/react@18.3.9)(react@18.3.1): dependencies: react: 18.3.1 - react-remove-scroll-bar: 2.3.6(@types/react@18.3.8)(react@18.3.1) - react-style-singleton: 2.2.1(@types/react@18.3.8)(react@18.3.1) + react-remove-scroll-bar: 2.3.6(@types/react@18.3.9)(react@18.3.1) + react-style-singleton: 2.2.1(@types/react@18.3.9)(react@18.3.1) tslib: 2.7.0 - use-callback-ref: 1.3.2(@types/react@18.3.8)(react@18.3.1) - use-sidecar: 1.1.2(@types/react@18.3.8)(react@18.3.1) + use-callback-ref: 1.3.2(@types/react@18.3.9)(react@18.3.1) + use-sidecar: 1.1.2(@types/react@18.3.9)(react@18.3.1) optionalDependencies: - '@types/react': 18.3.8 + '@types/react': 18.3.9 - react-style-singleton@2.2.1(@types/react@18.3.8)(react@18.3.1): + react-style-singleton@2.2.1(@types/react@18.3.9)(react@18.3.1): dependencies: get-nonce: 1.0.1 invariant: 2.2.4 react: 18.3.1 tslib: 2.7.0 optionalDependencies: - '@types/react': 18.3.8 + '@types/react': 18.3.9 - react-textarea-autosize@8.5.3(@types/react@18.3.8)(react@18.3.1): + react-textarea-autosize@8.5.3(@types/react@18.3.9)(react@18.3.1): dependencies: '@babel/runtime': 7.25.6 react: 18.3.1 use-composed-ref: 1.3.0(react@18.3.1) - use-latest: 1.2.1(@types/react@18.3.8)(react@18.3.1) + use-latest: 1.2.1(@types/react@18.3.9)(react@18.3.1) transitivePeerDependencies: - '@types/react' @@ -7126,37 +7132,37 @@ snapshots: uri-js-replace@1.0.1: {} - use-callback-ref@1.3.2(@types/react@18.3.8)(react@18.3.1): + use-callback-ref@1.3.2(@types/react@18.3.9)(react@18.3.1): dependencies: react: 18.3.1 tslib: 2.7.0 optionalDependencies: - '@types/react': 18.3.8 + '@types/react': 18.3.9 use-composed-ref@1.3.0(react@18.3.1): dependencies: react: 18.3.1 - use-isomorphic-layout-effect@1.1.2(@types/react@18.3.8)(react@18.3.1): + use-isomorphic-layout-effect@1.1.2(@types/react@18.3.9)(react@18.3.1): dependencies: react: 18.3.1 optionalDependencies: - '@types/react': 18.3.8 + '@types/react': 18.3.9 - use-latest@1.2.1(@types/react@18.3.8)(react@18.3.1): + use-latest@1.2.1(@types/react@18.3.9)(react@18.3.1): dependencies: react: 18.3.1 - use-isomorphic-layout-effect: 1.1.2(@types/react@18.3.8)(react@18.3.1) + use-isomorphic-layout-effect: 1.1.2(@types/react@18.3.9)(react@18.3.1) optionalDependencies: - '@types/react': 18.3.8 + '@types/react': 18.3.9 - use-sidecar@1.1.2(@types/react@18.3.8)(react@18.3.1): + use-sidecar@1.1.2(@types/react@18.3.9)(react@18.3.1): dependencies: detect-node-es: 1.1.0 react: 18.3.1 tslib: 2.7.0 optionalDependencies: - '@types/react': 18.3.8 + '@types/react': 18.3.9 use-sync-external-store@1.2.2(react@18.3.1): dependencies: @@ -7214,13 +7220,13 @@ snapshots: - utf-8-validate - zod - vite@5.4.7(@types/node@22.6.1)(sugarss@4.0.1(postcss@8.4.47)): + vite@5.4.8(@types/node@22.7.0)(sugarss@4.0.1(postcss@8.4.47)): dependencies: esbuild: 0.21.5 postcss: 8.4.47 rollup: 4.22.4 optionalDependencies: - '@types/node': 22.6.1 + '@types/node': 22.7.0 fsevents: 2.3.3 sugarss: 4.0.1(postcss@8.4.47) diff --git a/tests/c1-integration/test/classes.test.ts b/tests/c1-integration/test/classes.test.ts new file mode 100644 index 0000000..e5d899b --- /dev/null +++ b/tests/c1-integration/test/classes.test.ts @@ -0,0 +1,199 @@ +/** + * @jest-environment ceramic + * @jest-environment-options {"containerName":"ceramic-test-classes","externalPort":5203} + */ + +import { StreamID } from '@ceramic-sdk/identifiers' +import { ModelClient } from '@ceramic-sdk/model-client' +import { + type ModelState, + handleInitEvent as handleModel, +} from '@ceramic-sdk/model-handler' +import { DocumentClient } from '@ceramic-sdk/model-instance-client' +import { + type DocumentState, + handleEvent as handleDocument, +} from '@ceramic-sdk/model-instance-handler' +import type { ModelDefinition } from '@ceramic-sdk/model-protocol' +import { getAuthenticatedDID } from '@didtools/key-did' +import 'jest-environment-ceramic' + +const authenticatedDID = await getAuthenticatedDID(new Uint8Array(32)) + +test('create and update deterministic document', async () => { + const testModel: ModelDefinition = { + version: '2.0', + name: 'TestModel', + description: 'Test model', + accountRelation: { type: 'single' }, + interface: false, + implements: [], + schema: { + type: 'object', + properties: { + test: { type: 'string', maxLength: 10 }, + }, + additionalProperties: false, + }, + } + + const modelClient = new ModelClient({ + ceramic: ceramic.client, + did: authenticatedDID, + }) + const modelID = await modelClient.postDefinition(testModel) + const modelEvent = await modelClient.getInitEvent(modelID) + + const modelsStore: Record = {} + const contextDocumentModel = modelID.baseID.toString() + let docState: DocumentState + const context = { + getDocumentModel: async () => contextDocumentModel, + getDocumentState: async () => docState, + getModelDefinition: async (id) => { + const cid = StreamID.fromString(id).cid.toString() + const state = modelsStore[cid] + if (state == null) { + throw new Error(`State not found for model: ${id}`) + } + return state.content + }, + verifier: authenticatedDID, + } + const modelCIDstring = modelID.cid.toString() + modelsStore[modelCIDstring] = await handleModel( + modelCIDstring, + modelEvent, + context, + ) + + const docClient = new DocumentClient({ + ceramic: ceramic.client, + did: authenticatedDID, + }) + + const initCommitID = await docClient.postDeterministicInit({ + controller: authenticatedDID.id, + model: modelID, + }) + const initEvent = await docClient.getEvent(initCommitID) + docState = await handleDocument( + initCommitID.commit.toString(), + initEvent, + context, + ) + expect(docState.content).toBeNull() + + const updateCommitID = await docClient.postData({ + currentID: initCommitID, + newContent: { test: 'set' }, + }) + const updateEvent = await docClient.getEvent(updateCommitID) + docState = await handleDocument( + updateCommitID.commit.toString(), + updateEvent, + context, + ) + expect(docState.content).toEqual({ test: 'set' }) + + const finalCommitID = await docClient.postData({ + currentID: updateCommitID, + newContent: { test: 'changed' }, + }) + const finalEvent = await docClient.getEvent(finalCommitID) + docState = await handleDocument( + finalCommitID.commit.toString(), + finalEvent, + context, + ) + expect(docState.content).toEqual({ test: 'changed' }) +}) + +test('create and update non-deterministic document', async () => { + const testModel: ModelDefinition = { + version: '2.0', + name: 'TestModel', + description: 'Test model', + accountRelation: { type: 'list' }, + interface: false, + implements: [], + schema: { + type: 'object', + properties: { + test: { type: 'string', maxLength: 10 }, + }, + additionalProperties: false, + }, + } + + const modelClient = new ModelClient({ + ceramic: ceramic.client, + did: authenticatedDID, + }) + const modelID = await modelClient.postDefinition(testModel) + const modelEvent = await modelClient.getInitEvent(modelID) + + const modelsStore: Record = {} + const contextDocumentModel = modelID.baseID.toString() + let docState: DocumentState + const context = { + getDocumentModel: async () => contextDocumentModel, + getDocumentState: async () => docState, + getModelDefinition: async (id) => { + const cid = StreamID.fromString(id).cid.toString() + const state = modelsStore[cid] + if (state == null) { + throw new Error(`State not found for model: ${id}`) + } + return state.content + }, + verifier: authenticatedDID, + } + const modelCIDstring = modelID.cid.toString() + modelsStore[modelCIDstring] = await handleModel( + modelCIDstring, + modelEvent, + context, + ) + + const docClient = new DocumentClient({ + ceramic: ceramic.client, + did: authenticatedDID, + }) + + const initCommitID = await docClient.postSignedInit({ + content: { test: 'one' }, + model: modelID, + }) + const initEvent = await docClient.getEvent(initCommitID) + docState = await handleDocument( + initCommitID.commit.toString(), + initEvent, + context, + ) + expect(docState.content).toEqual({ test: 'one' }) + + const updateCommitID = await docClient.postData({ + currentID: initCommitID, + newContent: { test: 'two' }, + }) + const updateEvent = await docClient.getEvent(updateCommitID) + docState = await handleDocument( + updateCommitID.commit.toString(), + updateEvent, + context, + ) + expect(docState.content).toEqual({ test: 'two' }) + + const finalCommitID = await docClient.postData({ + currentID: updateCommitID, + newContent: { test: 'three' }, + }) + const finalEvent = await docClient.getEvent(finalCommitID) + docState = await handleDocument( + finalCommitID.commit.toString(), + finalEvent, + context, + ) + expect(docState.content).toEqual({ test: 'three' }) +}) From 1df32e8cd54e2c9349842640b8f55ebb296d4127 Mon Sep 17 00:00:00 2001 From: Paul Le Cam Date: Wed, 25 Sep 2024 11:49:17 +0100 Subject: [PATCH 3/7] Add stream client package --- packages/model-client/package.json | 5 +- packages/model-client/src/index.ts | 36 +++---------- packages/model-client/test/lib.test.ts | 25 --------- packages/model-instance-client/package.json | 3 +- packages/model-instance-client/src/client.ts | 39 +++----------- packages/model-instance-client/src/index.ts | 1 - .../model-instance-client/test/lib.test.ts | 25 --------- packages/stream-client/LICENSE-APACHE | 5 ++ packages/stream-client/LICENSE-MIT | 19 +++++++ packages/stream-client/README.md | 5 ++ packages/stream-client/package.json | 54 +++++++++++++++++++ packages/stream-client/src/index.ts | 31 +++++++++++ packages/stream-client/test/lib.test.ts | 41 ++++++++++++++ packages/stream-client/tsconfig.json | 7 +++ pnpm-lock.yaml | 50 ++++++++--------- 15 files changed, 206 insertions(+), 140 deletions(-) create mode 100644 packages/stream-client/LICENSE-APACHE create mode 100644 packages/stream-client/LICENSE-MIT create mode 100644 packages/stream-client/README.md create mode 100644 packages/stream-client/package.json create mode 100644 packages/stream-client/src/index.ts create mode 100644 packages/stream-client/test/lib.test.ts create mode 100644 packages/stream-client/tsconfig.json diff --git a/packages/model-client/package.json b/packages/model-client/package.json index d168bd7..4645a41 100644 --- a/packages/model-client/package.json +++ b/packages/model-client/package.json @@ -33,11 +33,12 @@ }, "dependencies": { "@ceramic-sdk/events": "workspace:^", - "@ceramic-sdk/http-client": "workspace:^", "@ceramic-sdk/identifiers": "workspace:^", - "@ceramic-sdk/model-protocol": "workspace:^" + "@ceramic-sdk/model-protocol": "workspace:^", + "@ceramic-sdk/stream-client": "workspace:^" }, "devDependencies": { + "@ceramic-sdk/http-client": "workspace:^", "@ceramic-sdk/test-utils": "workspace:^", "@didtools/key-did": "^1.0.0", "dids": "^5.0.2" diff --git a/packages/model-client/src/index.ts b/packages/model-client/src/index.ts index c386dee..b7c7e97 100644 --- a/packages/model-client/src/index.ts +++ b/packages/model-client/src/index.ts @@ -4,7 +4,6 @@ import { createSignedInitEvent, eventToContainer, } from '@ceramic-sdk/events' -import { type CeramicClient, getCeramicClient } from '@ceramic-sdk/http-client' import { StreamID } from '@ceramic-sdk/identifiers' import { MODEL, @@ -14,6 +13,7 @@ import { getModelStreamID, validateController, } from '@ceramic-sdk/model-protocol' +import { StreamClient } from '@ceramic-sdk/stream-client' import type { DID } from 'dids' const header: PartialInitEventHeader = { model: MODEL, sep: 'model' } @@ -32,35 +32,11 @@ export async function createInitEvent( return event } -export type ModelClientParams = { - ceramic: CeramicClient | string - did?: DID -} - -export class ModelClient { - #ceramic: CeramicClient - #did?: DID - - constructor(params: ModelClientParams) { - this.#ceramic = getCeramicClient(params.ceramic) - this.#did = params.did - } - - /** @private */ - _getDID(provided?: DID): DID { - if (provided != null) { - return provided - } - if (this.#did != null) { - return this.#did - } - throw new Error('Missing DID') - } - +export class ModelClient extends StreamClient { async getInitEvent(streamID: StreamID | string): Promise { const id = typeof streamID === 'string' ? StreamID.fromString(streamID) : streamID - return await this.#ceramic.getEventType(SignedEvent, id.cid.toString()) + return await this.ceramic.getEventType(SignedEvent, id.cid.toString()) } async getPayload( @@ -69,7 +45,7 @@ export class ModelClient { ): Promise { const event = await this.getInitEvent(streamID) const container = await eventToContainer( - this._getDID(verifier), + this.getDID(verifier), ModelInitEventPayload, event, ) @@ -80,9 +56,9 @@ export class ModelClient { definition: ModelDefinition, signer?: DID, ): Promise { - const did = this._getDID(signer) + const did = this.getDID(signer) const event = await createInitEvent(did, definition) - const cid = await this.#ceramic.postEventType(SignedEvent, event) + const cid = await this.ceramic.postEventType(SignedEvent, event) return getModelStreamID(cid) } } diff --git a/packages/model-client/test/lib.test.ts b/packages/model-client/test/lib.test.ts index 38e862f..039ca1c 100644 --- a/packages/model-client/test/lib.test.ts +++ b/packages/model-client/test/lib.test.ts @@ -9,7 +9,6 @@ import { import { EthereumDID } from '@ceramic-sdk/test-utils' import { getAuthenticatedDID } from '@didtools/key-did' import { jest } from '@jest/globals' -import { DID } from 'dids' import { ModelClient, createInitEvent } from '../src/index.js' @@ -76,30 +75,6 @@ describe('createInitEvent()', () => { }) describe('ModelClient', () => { - describe('_getDID() method', () => { - test('throws if no DID is provided or set in the constructor', () => { - const client = new ModelClient({ ceramic: 'http://localhost:5101' }) - expect(() => client._getDID()).toThrow('Missing DID') - }) - - test('returns the DID set in the constructor', () => { - const client = new ModelClient({ - ceramic: 'http://localhost:5101', - did: authenticatedDID, - }) - expect(client._getDID()).toBe(authenticatedDID) - }) - - test('returns the DID provided as argument', async () => { - const did = new DID() - const client = new ModelClient({ - ceramic: 'http://localhost:5101', - did: authenticatedDID, - }) - expect(client._getDID(did)).toBe(did) - }) - }) - describe('getInitEvent() method', () => { test('gets the model init event', async () => { const modelEvent = await createInitEvent(authenticatedDID, testModelV1) diff --git a/packages/model-instance-client/package.json b/packages/model-instance-client/package.json index 4a6c2ae..adc712a 100644 --- a/packages/model-instance-client/package.json +++ b/packages/model-instance-client/package.json @@ -33,13 +33,14 @@ }, "dependencies": { "@ceramic-sdk/events": "workspace:^", - "@ceramic-sdk/http-client": "workspace:^", "@ceramic-sdk/identifiers": "workspace:^", "@ceramic-sdk/model-instance-protocol": "workspace:^", + "@ceramic-sdk/stream-client": "workspace:^", "@didtools/codecs": "^3.0.0", "fast-json-patch": "^3.1.1" }, "devDependencies": { + "@ceramic-sdk/http-client": "workspace:^", "@didtools/key-did": "^1.0.0", "dids": "^5.0.2", "uint8arrays": "^5.1.0" diff --git a/packages/model-instance-client/src/client.ts b/packages/model-instance-client/src/client.ts index 7594760..3b8b7b9 100644 --- a/packages/model-instance-client/src/client.ts +++ b/packages/model-instance-client/src/client.ts @@ -1,10 +1,10 @@ import { InitEventPayload, SignedEvent } from '@ceramic-sdk/events' -import { type CeramicClient, getCeramicClient } from '@ceramic-sdk/http-client' import { CommitID, type StreamID } from '@ceramic-sdk/identifiers' import { DocumentEvent, getStreamID, } from '@ceramic-sdk/model-instance-protocol' +import { StreamClient } from '@ceramic-sdk/stream-client' import type { DIDString } from '@didtools/codecs' import type { DID } from 'dids' @@ -35,34 +35,11 @@ export type PostDataParams = Omit< controller?: DID } -export type DocumentClientParams = { - ceramic: CeramicClient | string - did?: DID -} - -export class DocumentClient { - #ceramic: CeramicClient - #did?: DID - - constructor(params: DocumentClientParams) { - this.#ceramic = getCeramicClient(params.ceramic) - this.#did = params.did - } - - _getDID(provided?: DID): DID { - if (provided != null) { - return provided - } - if (this.#did != null) { - return this.#did - } - throw new Error('Missing DID') - } - +export class DocumentClient extends StreamClient { async getEvent(commitID: CommitID | string): Promise { const id = typeof commitID === 'string' ? CommitID.fromString(commitID) : commitID - return (await this.#ceramic.getEventType( + return (await this.ceramic.getEventType( DocumentEvent, id.commit.toString(), )) as DocumentEvent @@ -76,7 +53,7 @@ export class DocumentClient { params.controller, params.uniqueValue, ) - const cid = await this.#ceramic.postEventType(InitEventPayload, event) + const cid = await this.ceramic.postEventType(InitEventPayload, event) return CommitID.fromStream(getStreamID(cid)) } @@ -86,9 +63,9 @@ export class DocumentClient { const { controller, ...rest } = params const event = await createInitEvent({ ...rest, - controller: this._getDID(controller), + controller: this.getDID(controller), }) - const cid = await this.#ceramic.postEventType(SignedEvent, event) + const cid = await this.ceramic.postEventType(SignedEvent, event) return CommitID.fromStream(getStreamID(cid)) } @@ -98,9 +75,9 @@ export class DocumentClient { const { controller, ...rest } = params const event = await createDataEvent({ ...rest, - controller: this._getDID(controller), + controller: this.getDID(controller), }) - const cid = await this.#ceramic.postEventType(SignedEvent, event) + const cid = await this.ceramic.postEventType(SignedEvent, event) return CommitID.fromStream(params.currentID.baseID, cid) } } diff --git a/packages/model-instance-client/src/index.ts b/packages/model-instance-client/src/index.ts index 381eb5b..06bee5d 100644 --- a/packages/model-instance-client/src/index.ts +++ b/packages/model-instance-client/src/index.ts @@ -1,5 +1,4 @@ export { - type DocumentClientParams, DocumentClient, type PostDataParams, type PostDeterministicInitParams, diff --git a/packages/model-instance-client/test/lib.test.ts b/packages/model-instance-client/test/lib.test.ts index 45ec814..d6783f3 100644 --- a/packages/model-instance-client/test/lib.test.ts +++ b/packages/model-instance-client/test/lib.test.ts @@ -9,7 +9,6 @@ import { } from '@ceramic-sdk/model-instance-protocol' import { getAuthenticatedDID } from '@didtools/key-did' import { jest } from '@jest/globals' -import { DID } from 'dids' import { equals } from 'uint8arrays' import { @@ -138,30 +137,6 @@ describe('createDataEvent()', () => { }) describe('DocumentClient', () => { - describe('_getDID() method', () => { - test('throws if no DID is provided or set in the constructor', () => { - const client = new DocumentClient({ ceramic: 'http://localhost:5101' }) - expect(() => client._getDID()).toThrow('Missing DID') - }) - - test('returns the DID set in the constructor', () => { - const client = new DocumentClient({ - ceramic: 'http://localhost:5101', - did: authenticatedDID, - }) - expect(client._getDID()).toBe(authenticatedDID) - }) - - test('returns the DID provided as argument', async () => { - const did = new DID() - const client = new DocumentClient({ - ceramic: 'http://localhost:5101', - did: authenticatedDID, - }) - expect(client._getDID(did)).toBe(did) - }) - }) - describe('getEvent() method', () => { test('gets a MID event by commit ID', async () => { const streamID = randomStreamID() diff --git a/packages/stream-client/LICENSE-APACHE b/packages/stream-client/LICENSE-APACHE new file mode 100644 index 0000000..14478a3 --- /dev/null +++ b/packages/stream-client/LICENSE-APACHE @@ -0,0 +1,5 @@ +Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at + +http://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. diff --git a/packages/stream-client/LICENSE-MIT b/packages/stream-client/LICENSE-MIT new file mode 100644 index 0000000..749aa1e --- /dev/null +++ b/packages/stream-client/LICENSE-MIT @@ -0,0 +1,19 @@ +The MIT License (MIT) + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in +all copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN +THE SOFTWARE. \ No newline at end of file diff --git a/packages/stream-client/README.md b/packages/stream-client/README.md new file mode 100644 index 0000000..cf5134d --- /dev/null +++ b/packages/stream-client/README.md @@ -0,0 +1,5 @@ +# Ceramic generic stream client + +## License + +Dual licensed under MIT and Apache 2 diff --git a/packages/stream-client/package.json b/packages/stream-client/package.json new file mode 100644 index 0000000..84f73d0 --- /dev/null +++ b/packages/stream-client/package.json @@ -0,0 +1,54 @@ +{ + "name": "@ceramic-sdk/stream-client", + "version": "0.1.0", + "author": "3Box Labs", + "license": "(Apache-2.0 OR MIT)", + "keywords": ["ceramic", "stream", "client"], + "repository": { + "type": "git", + "url": "https://github.com/ceramicstudio/ceramic-sdk", + "directory": "packages/stream-client" + }, + "type": "module", + "main": "dist/index.js", + "types": "dist/index.d.ts", + "exports": { + ".": "./dist/index.js" + }, + "files": ["dist"], + "engines": { + "node": ">=20" + }, + "sideEffects": false, + "scripts": { + "build:clean": "del dist", + "build:js": "swc src -d ./dist --config-file ../../.swcrc --strip-leading-paths", + "build:types": "tsc --project tsconfig.json --emitDeclarationOnly --skipLibCheck", + "build": "pnpm build:clean && pnpm build:types && pnpm build:js", + "lint": "eslint src --fix", + "test": "node --experimental-vm-modules ../../node_modules/jest/bin/jest.js", + "test:ci": "pnpm run test --ci --coverage", + "prepare": "pnpm build", + "prepublishOnly": "package-check" + }, + "dependencies": { + "@ceramic-sdk/http-client": "workspace:^" + }, + "devDependencies": { + "dids": "^5.0.2" + }, + "jest": { + "extensionsToTreatAsEsm": [".ts"], + "moduleNameMapper": { + "^(\\.{1,2}/.*)\\.js$": "$1" + }, + "transform": { + "^.+\\.(t|j)s$": [ + "@swc/jest", + { + "root": "../.." + } + ] + } + } +} diff --git a/packages/stream-client/src/index.ts b/packages/stream-client/src/index.ts new file mode 100644 index 0000000..7d46cbf --- /dev/null +++ b/packages/stream-client/src/index.ts @@ -0,0 +1,31 @@ +import { type CeramicClient, getCeramicClient } from '@ceramic-sdk/http-client' +import type { DID } from 'dids' + +export type StreamClientParams = { + ceramic: CeramicClient | string + did?: DID +} + +export class StreamClient { + #ceramic: CeramicClient + #did?: DID + + constructor(params: StreamClientParams) { + this.#ceramic = getCeramicClient(params.ceramic) + this.#did = params.did + } + + get ceramic(): CeramicClient { + return this.#ceramic + } + + getDID(provided?: DID): DID { + if (provided != null) { + return provided + } + if (this.#did != null) { + return this.#did + } + throw new Error('Missing DID') + } +} diff --git a/packages/stream-client/test/lib.test.ts b/packages/stream-client/test/lib.test.ts new file mode 100644 index 0000000..f163900 --- /dev/null +++ b/packages/stream-client/test/lib.test.ts @@ -0,0 +1,41 @@ +import { CeramicClient } from '@ceramic-sdk/http-client' +import { DID } from 'dids' + +import { StreamClient } from '../src/index.js' + +describe('StreamClient', () => { + describe('ceramic getter', () => { + test('returns the CeramicClient instance set in constructor', () => { + const ceramic = new CeramicClient({ url: 'http://localhost:5101' }) + const client = new StreamClient({ ceramic }) + expect(client.ceramic).toBe(ceramic) + }) + + test('returns a CeramicClient instance using the provided URL', () => { + const client = new StreamClient({ ceramic: 'http://localhost:5101' }) + expect(client.ceramic).toBeInstanceOf(CeramicClient) + }) + }) + + describe('getDID() method', () => { + test('throws if no DID is provided or set in the constructor', () => { + const client = new StreamClient({ ceramic: 'http://localhost:5101' }) + expect(() => client.getDID()).toThrow('Missing DID') + }) + + test('returns the DID set in the constructor', () => { + const did = new DID() + const client = new StreamClient({ ceramic: 'http://localhost:5101', did }) + expect(client.getDID()).toBe(did) + }) + + test('returns the DID provided as argument', async () => { + const did = new DID() + const client = new StreamClient({ + ceramic: 'http://localhost:5101', + did: new DID(), + }) + expect(client.getDID(did)).toBe(did) + }) + }) +}) diff --git a/packages/stream-client/tsconfig.json b/packages/stream-client/tsconfig.json new file mode 100644 index 0000000..34756dd --- /dev/null +++ b/packages/stream-client/tsconfig.json @@ -0,0 +1,7 @@ +{ + "extends": "../../tsconfig.build.json", + "compilerOptions": { + "outDir": "./dist" + }, + "include": ["src"] +} diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml index eb9997c..140a51e 100644 --- a/pnpm-lock.yaml +++ b/pnpm-lock.yaml @@ -19,7 +19,7 @@ importers: version: 0.2.2 '@swc/cli': specifier: ^0.4.0 - version: 0.4.0(@swc/core@1.7.18)(chokidar@4.0.1) + version: 0.4.0(@swc/core@1.7.18)(chokidar@3.6.0) '@swc/core': specifier: ^1.7.11 version: 1.7.18 @@ -253,16 +253,19 @@ importers: '@ceramic-sdk/events': specifier: workspace:^ version: link:../events - '@ceramic-sdk/http-client': - specifier: workspace:^ - version: link:../http-client '@ceramic-sdk/identifiers': specifier: workspace:^ version: link:../identifiers '@ceramic-sdk/model-protocol': specifier: workspace:^ version: link:../model-protocol + '@ceramic-sdk/stream-client': + specifier: workspace:^ + version: link:../stream-client devDependencies: + '@ceramic-sdk/http-client': + specifier: workspace:^ + version: link:../http-client '@ceramic-sdk/test-utils': specifier: workspace:^ version: link:../test-utils @@ -318,15 +321,15 @@ importers: '@ceramic-sdk/events': specifier: workspace:^ version: link:../events - '@ceramic-sdk/http-client': - specifier: workspace:^ - version: link:../http-client '@ceramic-sdk/identifiers': specifier: workspace:^ version: link:../identifiers '@ceramic-sdk/model-instance-protocol': specifier: workspace:^ version: link:../model-instance-protocol + '@ceramic-sdk/stream-client': + specifier: workspace:^ + version: link:../stream-client '@didtools/codecs': specifier: ^3.0.0 version: 3.0.0 @@ -334,6 +337,9 @@ importers: specifier: ^3.1.1 version: 3.1.1 devDependencies: + '@ceramic-sdk/http-client': + specifier: workspace:^ + version: link:../http-client '@didtools/key-did': specifier: ^1.0.0 version: 1.0.0(typescript@5.6.2)(zod@3.23.8) @@ -455,6 +461,16 @@ importers: specifier: ^10.0.2 version: 10.0.2(typescript@5.6.2) + packages/stream-client: + dependencies: + '@ceramic-sdk/http-client': + specifier: workspace:^ + version: link:../http-client + devDependencies: + dids: + specifier: ^5.0.2 + version: 5.0.2(typescript@5.6.2)(zod@3.23.8) + packages/test-utils: dependencies: '@didtools/cacao': @@ -2039,10 +2055,6 @@ packages: resolution: {integrity: sha512-7VT13fmjotKpGipCW9JEQAusEPE+Ei8nl6/g4FBAmIm0GOOLMua9NDDo/DWp0ZAxCr3cPq5ZpBqmPAQgDda2Pw==} engines: {node: '>= 8.10.0'} - chokidar@4.0.1: - resolution: {integrity: sha512-n8enUVCED/KVRQlab1hr3MVpcVMvxtZjmEa956u+4YijlmQED223XMSYj2tLuKvr4jcCTzNNMpQDUer72MMmzA==} - engines: {node: '>= 14.16.0'} - ci-info@3.9.0: resolution: {integrity: sha512-NIxF55hv4nSqQswkAeiOi1r83xy8JldOFDTWiug55KBu9Jnblncd2U6ViHmYgHf01TPZS77NJBhBMKdWj9HQMQ==} engines: {node: '>=8'} @@ -3250,10 +3262,6 @@ packages: resolution: {integrity: sha512-hOS089on8RduqdbhvQ5Z37A0ESjsqz6qnRcffsMU3495FuTdqSm+7bhJ29JvIOsBDEEnan5DPu9t3To9VRlMzA==} engines: {node: '>=8.10.0'} - readdirp@4.0.1: - resolution: {integrity: sha512-GkMg9uOTpIWWKbSsgwb5fA4EavTR+SG/PMPoAY8hkhHfEEY0/vqljY+XHqtDf2cr2IJtoNRDbrrEpZUiZCkYRw==} - engines: {node: '>= 14.16.0'} - redent@4.0.0: resolution: {integrity: sha512-tYkDkVVtYkSVhuQ4zBgfvciymHaeuel+zFKXShfDnFP5SyVEP7qo70Rf1jTOTCx3vGNAbnEi/xFkcfQVMIBWag==} engines: {node: '>=12'} @@ -4891,7 +4899,7 @@ snapshots: '@stablelib/wipe@1.0.1': {} - '@swc/cli@0.4.0(@swc/core@1.7.18)(chokidar@4.0.1)': + '@swc/cli@0.4.0(@swc/core@1.7.18)(chokidar@3.6.0)': dependencies: '@mole-inc/bin-wrapper': 8.0.1 '@swc/core': 1.7.18 @@ -4904,7 +4912,7 @@ snapshots: slash: 3.0.0 source-map: 0.7.4 optionalDependencies: - chokidar: 4.0.1 + chokidar: 3.6.0 '@swc/core-darwin-arm64@1.7.18': optional: true @@ -5415,11 +5423,6 @@ snapshots: optionalDependencies: fsevents: 2.3.3 - chokidar@4.0.1: - dependencies: - readdirp: 4.0.1 - optional: true - ci-info@3.9.0: {} cjs-module-lexer@1.3.1: {} @@ -6817,9 +6820,6 @@ snapshots: dependencies: picomatch: 2.3.1 - readdirp@4.0.1: - optional: true - redent@4.0.0: dependencies: indent-string: 5.0.0 From e043767d95b95602528fbfa191ede034ec066c06 Mon Sep 17 00:00:00 2001 From: Paul Le Cam Date: Wed, 25 Sep 2024 14:19:50 +0100 Subject: [PATCH 4/7] Cache C1 docker image in GitHub actions --- .github/workflows/integration-test.yml | 23 +++++++++++++++++++++-- packages/jest-environment/src/index.ts | 7 +++++-- 2 files changed, 26 insertions(+), 4 deletions(-) diff --git a/.github/workflows/integration-test.yml b/.github/workflows/integration-test.yml index 6cefb08..7684e65 100644 --- a/.github/workflows/integration-test.yml +++ b/.github/workflows/integration-test.yml @@ -3,8 +3,12 @@ on: push: branches: ["main"] pull_request: + env: + C1_REGISTRY: "public.ecr.aws/r5b3e0r5/3box/ceramic-one" + C1_VERSION: "0.35.0" CI: true + jobs: test: name: Run integration tests @@ -32,8 +36,8 @@ jobs: run: | echo "STORE_PATH=$(pnpm store path)" >> $GITHUB_OUTPUT - - uses: actions/cache@v4 - name: Setup pnpm cache + - name: Setup pnpm cache + uses: actions/cache@v4 with: path: ${{ steps.pnpm-cache.outputs.STORE_PATH }} key: pnpm-store-${{ hashFiles('**/pnpm-lock.yaml') }} @@ -42,5 +46,20 @@ jobs: - name: Install dependencies and build run: pnpm install --frozen-lockfile + - name: Restore C1 Docker image if it exists + id: cache-docker-c1 + uses: actions/cache@v4 + with: + path: ci/cache/docker/c1 + key: cache-docker-c1-${{ env.C1_VERSION }} + + - name: Update C1 Docker image if cache miss + if: steps.cache-docker-c1.outputs.cache-hit != 'true' + run: docker pull ${{ env.C1_REGISTRY }}:${{ env.C1_VERSION }} && mkdir -p ci/cache/docker/c1 && docker image save ${{ env.C1_REGISTRY }}:${{ env.C1_VERSION }} --output ./ci/cache/docker/c1/${{ env.C1_VERSION }}.tar + + - name: Use C1 Docker image if cache hit + if: steps.cache-docker-c1.outputs.cache-hit == 'true' + run: docker image load --input ./ci/cache/docker/c1/${{ env.C1_VERSION }}.tar + - name: Test run: cd tests/c1-integration && pnpm run test diff --git a/packages/jest-environment/src/index.ts b/packages/jest-environment/src/index.ts index 6409209..1b886d1 100644 --- a/packages/jest-environment/src/index.ts +++ b/packages/jest-environment/src/index.ts @@ -33,7 +33,8 @@ declare global { export type EnvironmentOptions = { debug?: boolean // default to false - image?: string // default to "public.ecr.aws/r5b3e0r5/3box/ceramic-one:latest" + image?: string // default to "public.ecr.aws/r5b3e0r5/3box/ceramic-one:{version}" + version?: string // default to "latest" containerName?: string // default to "ceramic-one" internalPort?: number // default to 5001 defaultExternalPort?: number // default to 5001 @@ -60,9 +61,11 @@ export default class CeramicEnvironment extends NodeEnvironment { ? { ...DEFAULT_ENVIRONMENT, ...envOverrides } : DEFAULT_ENVIRONMENT + const version = options.version ?? (process.env.C1_VERSION || 'latest') this.#container = await startContainer({ debug: options.debug ?? false, - image: options.image ?? 'public.ecr.aws/r5b3e0r5/3box/ceramic-one:latest', + image: + options.image ?? `public.ecr.aws/r5b3e0r5/3box/ceramic-one:${version}`, containerName: options.containerName ?? `ceramic-${Math.random().toString(36).slice(6)}`, From 3ecee6bd78bc4252133ceb8600748770d07c3782 Mon Sep 17 00:00:00 2001 From: Paul Le Cam Date: Thu, 26 Sep 2024 12:18:21 +0100 Subject: [PATCH 5/7] Add docs for stream client classes --- .../events/functions/assertSignedEvent.md | 4 - .../events/functions/assertTimeEvent.md | 4 - .../events/functions/carFromString.md | 4 - .../events/functions/carToString.md | 4 - .../events/functions/createSignedInitEvent.md | 4 - .../events/functions/decodeSignedEvent.md | 4 - .../events/functions/decodeTimeEvent.md | 4 - .../events/functions/encodeEventToCAR.md | 4 - .../events/functions/eventFromCAR.md | 4 - .../events/functions/eventFromString.md | 4 - .../events/functions/eventToCAR.md | 4 - .../events/functions/eventToContainer.md | 4 - .../events/functions/eventToString.md | 4 - .../events/functions/getSignedEventPayload.md | 4 - .../events/functions/signEvent.md | 4 - .../events/functions/signedEventToCAR.md | 4 - .../functions/signedEventToContainer.md | 4 - .../functions/unsignedEventToContainer.md | 4 - .../events/type-aliases/EventContainer.md | 4 - .../events/type-aliases/InitEventHeader.md | 4 - .../events/type-aliases/InitEventPayload.md | 4 - .../type-aliases/PartialInitEventHeader.md | 4 - .../events/type-aliases/SignedEvent.md | 4 - .../type-aliases/SignedEventContainer.md | 4 - .../events/type-aliases/TimeEvent.md | 4 - .../type-aliases/UnsignedEventContainer.md | 4 - .../events/variables/InitEventHeader.md | 8 +- .../events/variables/InitEventPayload.md | 8 +- .../events/variables/SignedEvent.md | 4 - .../events/variables/TimeEvent.md | 4 - .../http-client/classes/CeramicClient.md | 46 ------ .../http-client/type-aliases/CeramicAPI.md | 4 - .../http-client/type-aliases/ClientParams.md | 4 - .../type-aliases/EventsFeedParams.md | 4 - .../http-client/type-aliases/Schema.md | 4 - .../http-client/type-aliases/Schemas.md | 4 - .../identifiers/classes/CommitID.md | 48 ------ .../identifiers/classes/StreamID.md | 46 ------ .../identifiers/type-aliases/StreamType.md | 4 - .../type-aliases/StreamTypeCode.md | 4 - .../type-aliases/StreamTypeName.md | 4 - .../identifiers/variables/streamIDAsBytes.md | 6 +- .../identifiers/variables/streamIDAsString.md | 4 - .../identifiers/variables/streamIDString.md | 4 - docs/@ceramic-sdk/model-client/README.md | 4 + .../model-client/classes/ModelClient.md | 119 +++++++++++++++ .../model-client/functions/createInitEvent.md | 4 - .../model-instance-client/README.md | 7 + .../classes/DocumentClient.md | 139 ++++++++++++++++++ .../functions/createDataEvent.md | 4 - .../functions/createDataEventPayload.md | 4 - .../functions/createInitEvent.md | 4 - .../functions/getDeterministicInitEvent.md | 4 - .../getDeterministicInitEventPayload.md | 4 - .../type-aliases/CreateDataEventParams.md | 4 - .../type-aliases/CreateInitEventParams.md | 4 - .../type-aliases/PostDataParams.md | 19 +++ .../PostDeterministicInitParams.md | 23 +++ .../type-aliases/PostSignedInitParams.md | 19 +++ .../type-aliases/UnknownContent.md | 4 - .../functions/getDeterministicStreamID.md | 4 - .../functions/getStreamID.md | 4 - .../type-aliases/DataInitEventPayload.md | 4 - .../DeterministicInitEventPayload.md | 4 - .../type-aliases/DocumentDataEventHeader.md | 4 - .../type-aliases/DocumentDataEventPayload.md | 4 - .../type-aliases/DocumentEvent.md | 4 - .../type-aliases/DocumentInitEventHeader.md | 4 - .../type-aliases/DocumentInitEventPayload.md | 4 - .../type-aliases/DocumentMetadata.md | 4 - .../EncodedDeterministicInitEventPayload.md | 4 - .../type-aliases/EncodedDocumentMetadata.md | 4 - .../type-aliases/JSONPatchOperation.md | 4 - .../variables/DataInitEventPayload.md | 8 +- .../DeterministicInitEventPayload.md | 8 +- .../variables/DocumentDataEventHeader.md | 4 - .../variables/DocumentDataEventPayload.md | 4 - .../variables/DocumentEvent.md | 4 - .../variables/DocumentInitEventHeader.md | 8 +- .../variables/DocumentInitEventPayload.md | 4 - .../variables/DocumentMetadata.md | 4 - .../variables/JSONPatchAddOperation.md | 4 - .../variables/JSONPatchCopyOperation.md | 4 - .../variables/JSONPatchMoveOperation.md | 4 - .../variables/JSONPatchOperation.md | 4 - .../variables/JSONPatchRemoveOperation.md | 4 - .../variables/JSONPatchReplaceOperation.md | 4 - .../variables/JSONPatchTestOperation.md | 4 - .../variables/MAX_DOCUMENT_SIZE.md | 4 - .../functions/assertValidModelContent.md | 4 - .../functions/getModelStreamID.md | 4 - .../type-aliases/ModelAccountRelation.md | 4 - .../type-aliases/ModelAccountRelationV2.md | 4 - .../type-aliases/ModelDefinition.md | 4 - .../type-aliases/ModelDefinitionV1.md | 4 - .../type-aliases/ModelDefinitionV2.md | 4 - .../ModelDocumentMetadataViewDefinition.md | 4 - .../model-protocol/type-aliases/ModelEvent.md | 4 - .../type-aliases/ModelEventHeader.md | 4 - .../type-aliases/ModelInitEventPayload.md | 4 - .../type-aliases/ModelMetadata.md | 4 - .../type-aliases/ModelRelationDefinition.md | 4 - .../type-aliases/ModelRelationDefinitionV2.md | 4 - .../ModelRelationViewDefinition.md | 4 - .../ModelRelationViewDefinitionV2.md | 4 - .../type-aliases/ModelRelationsDefinition.md | 4 - .../ModelRelationsDefinitionV2.md | 4 - .../type-aliases/ModelViewDefinition.md | 4 - .../type-aliases/ModelViewDefinitionV2.md | 4 - .../type-aliases/ModelViewsDefinition.md | 4 - .../type-aliases/ModelViewsDefinitionV2.md | 4 - .../type-aliases/ObjectSchema.md | 4 - .../model-protocol/type-aliases/SchemaType.md | 4 - .../type-aliases/ValidVersionSatisfies.md | 4 - .../model-protocol/variables/MODEL.md | 4 - .../variables/MODEL_STREAM_ID.md | 4 - .../variables/ModelAccountRelation.md | 4 - .../variables/ModelAccountRelationV2.md | 4 - .../variables/ModelDefinition.md | 4 - .../variables/ModelDefinitionV1.md | 4 - .../variables/ModelDefinitionV2.md | 4 - .../ModelDocumentMetadataViewDefinition.md | 4 - .../model-protocol/variables/ModelEvent.md | 4 - .../variables/ModelEventHeader.md | 4 - .../variables/ModelInitEventPayload.md | 4 - .../model-protocol/variables/ModelMetadata.md | 4 - .../variables/ModelRelationDefinition.md | 4 - .../variables/ModelRelationDefinitionV2.md | 4 - .../variables/ModelRelationViewDefinition.md | 4 - .../ModelRelationViewDefinitionV2.md | 4 - .../variables/ModelRelationsDefinition.md | 4 - .../variables/ModelRelationsDefinitionV2.md | 4 - .../variables/ModelViewDefinition.md | 4 - .../variables/ModelViewDefinitionV2.md | 4 - .../variables/ModelViewsDefinition.md | 4 - .../variables/ModelViewsDefinitionV2.md | 4 - .../model-protocol/variables/ObjectSchema.md | 4 - .../variables/optionalModelString.md | 4 - docs/@ceramic-sdk/stream-client/README.md | 15 ++ .../stream-client/classes/StreamClient.md | 53 +++++++ .../type-aliases/StreamClientParams.md | 23 +++ docs/README.md | 1 + packages/model-client/src/index.ts | 3 + packages/model-instance-client/src/client.ts | 4 + packages/stream-client/README.md | 10 ++ packages/stream-client/src/index.ts | 4 + typedoc.json | 4 +- 147 files changed, 457 insertions(+), 664 deletions(-) create mode 100644 docs/@ceramic-sdk/model-client/classes/ModelClient.md create mode 100644 docs/@ceramic-sdk/model-instance-client/classes/DocumentClient.md create mode 100644 docs/@ceramic-sdk/model-instance-client/type-aliases/PostDataParams.md create mode 100644 docs/@ceramic-sdk/model-instance-client/type-aliases/PostDeterministicInitParams.md create mode 100644 docs/@ceramic-sdk/model-instance-client/type-aliases/PostSignedInitParams.md create mode 100644 docs/@ceramic-sdk/stream-client/README.md create mode 100644 docs/@ceramic-sdk/stream-client/classes/StreamClient.md create mode 100644 docs/@ceramic-sdk/stream-client/type-aliases/StreamClientParams.md diff --git a/docs/@ceramic-sdk/events/functions/assertSignedEvent.md b/docs/@ceramic-sdk/events/functions/assertSignedEvent.md index c8fc6c8..3e74028 100644 --- a/docs/@ceramic-sdk/events/functions/assertSignedEvent.md +++ b/docs/@ceramic-sdk/events/functions/assertSignedEvent.md @@ -17,7 +17,3 @@ Assert the provided `input` is a SignedEvent ## 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 index 63a2680..57053b7 100644 --- a/docs/@ceramic-sdk/events/functions/assertTimeEvent.md +++ b/docs/@ceramic-sdk/events/functions/assertTimeEvent.md @@ -17,7 +17,3 @@ Assert the provided `input` is a TimeEvent ## 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 index e547c20..548c213 100644 --- a/docs/@ceramic-sdk/events/functions/carFromString.md +++ b/docs/@ceramic-sdk/events/functions/carFromString.md @@ -19,7 +19,3 @@ Decode a CAR from a string, using the given base (defaults to base64) ## 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 index 234d3ec..1fb000e 100644 --- a/docs/@ceramic-sdk/events/functions/carToString.md +++ b/docs/@ceramic-sdk/events/functions/carToString.md @@ -19,7 +19,3 @@ Encode a CAR into a string, using the given base (defaults to base64) ## 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 index b28116d..b4a9a05 100644 --- a/docs/@ceramic-sdk/events/functions/createSignedInitEvent.md +++ b/docs/@ceramic-sdk/events/functions/createSignedInitEvent.md @@ -27,7 +27,3 @@ Create a signed init event using the provided DID, data and header ## 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 index b4c7d2a..9dfbe97 100644 --- a/docs/@ceramic-sdk/events/functions/decodeSignedEvent.md +++ b/docs/@ceramic-sdk/events/functions/decodeSignedEvent.md @@ -17,7 +17,3 @@ Decode the provided `input` as a SignedEvent. Throws if decoding fails. ## 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 index 6ebadbb..ded886e 100644 --- a/docs/@ceramic-sdk/events/functions/decodeTimeEvent.md +++ b/docs/@ceramic-sdk/events/functions/decodeTimeEvent.md @@ -17,7 +17,3 @@ Decode the provided `input` as a TimeEvent. Throws if decoding fails. ## 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 index b48a1d4..1da15ea 100644 --- a/docs/@ceramic-sdk/events/functions/encodeEventToCAR.md +++ b/docs/@ceramic-sdk/events/functions/encodeEventToCAR.md @@ -19,7 +19,3 @@ Encode an unsigned event into a CAR using the provided codec ## 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 index 992cec0..ffd3728 100644 --- a/docs/@ceramic-sdk/events/functions/eventFromCAR.md +++ b/docs/@ceramic-sdk/events/functions/eventFromCAR.md @@ -25,7 +25,3 @@ Decode an event from a string using the provided codec for unsigned events ## 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 index 7c62382..41225e4 100644 --- a/docs/@ceramic-sdk/events/functions/eventFromString.md +++ b/docs/@ceramic-sdk/events/functions/eventFromString.md @@ -25,7 +25,3 @@ Decode an event from a string using the provided codec for unsigned events and t ## 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 index 02a0b24..4633702 100644 --- a/docs/@ceramic-sdk/events/functions/eventToCAR.md +++ b/docs/@ceramic-sdk/events/functions/eventToCAR.md @@ -19,7 +19,3 @@ Encode an event into a CAR using the provided codec for unsigned events ## 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 index f0a243b..571fece 100644 --- a/docs/@ceramic-sdk/events/functions/eventToContainer.md +++ b/docs/@ceramic-sdk/events/functions/eventToContainer.md @@ -25,7 +25,3 @@ Decode a Ceramic event into a container using the provided verifier DID and payl ## 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 index 3bc6f54..469f335 100644 --- a/docs/@ceramic-sdk/events/functions/eventToString.md +++ b/docs/@ceramic-sdk/events/functions/eventToString.md @@ -21,7 +21,3 @@ Encode an event into a string using the provided codec for unsigned events and t ## 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 index 0fc4f1c..43c7e95 100644 --- a/docs/@ceramic-sdk/events/functions/getSignedEventPayload.md +++ b/docs/@ceramic-sdk/events/functions/getSignedEventPayload.md @@ -23,7 +23,3 @@ Decode the payload of a signed event using the provided decoder ## 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 index 82adf4b..3c3c3b3 100644 --- a/docs/@ceramic-sdk/events/functions/signEvent.md +++ b/docs/@ceramic-sdk/events/functions/signEvent.md @@ -21,7 +21,3 @@ Sign an event payload using the provided DID ## 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 index 1242773..b0c69d3 100644 --- a/docs/@ceramic-sdk/events/functions/signedEventToCAR.md +++ b/docs/@ceramic-sdk/events/functions/signedEventToCAR.md @@ -17,7 +17,3 @@ Encode a signed event into a CAR ## 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 index 902c6d8..803763c 100644 --- a/docs/@ceramic-sdk/events/functions/signedEventToContainer.md +++ b/docs/@ceramic-sdk/events/functions/signedEventToContainer.md @@ -25,7 +25,3 @@ Decode a signed Ceramic event into a container using the provided verifier DID a ## 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 index bc4acd8..e2f6b87 100644 --- a/docs/@ceramic-sdk/events/functions/unsignedEventToContainer.md +++ b/docs/@ceramic-sdk/events/functions/unsignedEventToContainer.md @@ -23,7 +23,3 @@ Decode an unsigned Ceramic event into a container using the provided payload dec ## 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 index 2feb575..92e0c94 100644 --- a/docs/@ceramic-sdk/events/type-aliases/EventContainer.md +++ b/docs/@ceramic-sdk/events/type-aliases/EventContainer.md @@ -13,7 +13,3 @@ 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 index 58e69d8..ade1e32 100644 --- a/docs/@ceramic-sdk/events/type-aliases/InitEventHeader.md +++ b/docs/@ceramic-sdk/events/type-aliases/InitEventHeader.md @@ -7,7 +7,3 @@ # 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 index ce52987..2e06894 100644 --- a/docs/@ceramic-sdk/events/type-aliases/InitEventPayload.md +++ b/docs/@ceramic-sdk/events/type-aliases/InitEventPayload.md @@ -21,7 +21,3 @@ ### 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 index 5d0f166..778823e 100644 --- a/docs/@ceramic-sdk/events/type-aliases/PartialInitEventHeader.md +++ b/docs/@ceramic-sdk/events/type-aliases/PartialInitEventHeader.md @@ -13,7 +13,3 @@ ### 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 index 538510d..5ae7fc7 100644 --- a/docs/@ceramic-sdk/events/type-aliases/SignedEvent.md +++ b/docs/@ceramic-sdk/events/type-aliases/SignedEvent.md @@ -7,7 +7,3 @@ # 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 index 6ccafcf..c9700e3 100644 --- a/docs/@ceramic-sdk/events/type-aliases/SignedEventContainer.md +++ b/docs/@ceramic-sdk/events/type-aliases/SignedEventContainer.md @@ -35,7 +35,3 @@ Container for a signed Ceramic event ### 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 index c1704ad..d6b9124 100644 --- a/docs/@ceramic-sdk/events/type-aliases/TimeEvent.md +++ b/docs/@ceramic-sdk/events/type-aliases/TimeEvent.md @@ -7,7 +7,3 @@ # 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 index dc26cbd..55d0ca5 100644 --- a/docs/@ceramic-sdk/events/type-aliases/UnsignedEventContainer.md +++ b/docs/@ceramic-sdk/events/type-aliases/UnsignedEventContainer.md @@ -23,7 +23,3 @@ Container for an unsigned Ceramic event ### 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 index 113172b..4f9e752 100644 --- a/docs/@ceramic-sdk/events/variables/InitEventHeader.md +++ b/docs/@ceramic-sdk/events/variables/InitEventHeader.md @@ -14,7 +14,7 @@ Header structure of Init events ### context -> **context**: `OptionalCodec`\<`Type`\<[`StreamID`](../../identifiers/classes/StreamID.md), `Uint8Array`, `Uint8Array`\>\> +> **context**: `OptionalCodec`\<`Type`\<[`StreamID`](../../identifiers/classes/StreamID.md), `Uint8Array`, [`StreamID`](../../identifiers/classes/StreamID.md) \| `Uint8Array`\>\> ### controllers @@ -22,7 +22,7 @@ Header structure of Init events ### model -> **model**: `Type`\<[`StreamID`](../../identifiers/classes/StreamID.md), `Uint8Array`, `Uint8Array`\> = `streamIDAsBytes` +> **model**: `Type`\<[`StreamID`](../../identifiers/classes/StreamID.md), `Uint8Array`, [`StreamID`](../../identifiers/classes/StreamID.md) \| `Uint8Array`\> = `streamIDAsBytes` ### sep @@ -35,7 +35,3 @@ Header structure of Init events ### 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 index ff866d5..1014d6a 100644 --- a/docs/@ceramic-sdk/events/variables/InitEventPayload.md +++ b/docs/@ceramic-sdk/events/variables/InitEventPayload.md @@ -24,7 +24,7 @@ Payload structure of Init events ##### context -> **context**: `OptionalCodec`\<`Type`\<[`StreamID`](../../identifiers/classes/StreamID.md), `Uint8Array`, `Uint8Array`\>\> +> **context**: `OptionalCodec`\<`Type`\<[`StreamID`](../../identifiers/classes/StreamID.md), `Uint8Array`, [`StreamID`](../../identifiers/classes/StreamID.md) \| `Uint8Array`\>\> ##### controllers @@ -32,7 +32,7 @@ Payload structure of Init events ##### model -> **model**: `Type`\<[`StreamID`](../../identifiers/classes/StreamID.md), `Uint8Array`, `Uint8Array`\> = `streamIDAsBytes` +> **model**: `Type`\<[`StreamID`](../../identifiers/classes/StreamID.md), `Uint8Array`, [`StreamID`](../../identifiers/classes/StreamID.md) \| `Uint8Array`\> = `streamIDAsBytes` ##### sep @@ -45,7 +45,3 @@ Payload structure of Init events ##### 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 index 50245c8..2e65a57 100644 --- a/docs/@ceramic-sdk/events/variables/SignedEvent.md +++ b/docs/@ceramic-sdk/events/variables/SignedEvent.md @@ -37,7 +37,3 @@ Signed event structure - equivalent to DagJWSResult in `dids` package ### 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 index e218968..49adecb 100644 --- a/docs/@ceramic-sdk/events/variables/TimeEvent.md +++ b/docs/@ceramic-sdk/events/variables/TimeEvent.md @@ -9,7 +9,3 @@ > `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/classes/CeramicClient.md b/docs/@ceramic-sdk/http-client/classes/CeramicClient.md index 42c5778..686014b 100644 --- a/docs/@ceramic-sdk/http-client/classes/CeramicClient.md +++ b/docs/@ceramic-sdk/http-client/classes/CeramicClient.md @@ -20,10 +20,6 @@ [`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 @@ -38,8 +34,6 @@ OpenAPI client used internally, provides low-level access to the HTTP APIs expos #### 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() @@ -72,10 +66,6 @@ Multibase encoding of event data. 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() @@ -92,10 +82,6 @@ Get the CAR-encoded event for the given event CID `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() @@ -112,10 +98,6 @@ Get the string-encoded event for the given event CID `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() @@ -148,10 +130,6 @@ An array of events. For now, the event data payload is empty. 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() @@ -174,10 +152,6 @@ Get the decoded event for the given decoder and event CID `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() @@ -198,10 +172,6 @@ Get information about the Ceramic One server version 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() @@ -218,10 +188,6 @@ Post a string-encoded event to the server `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() @@ -238,10 +204,6 @@ Post a CAR-encoded event to the server `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() @@ -260,10 +222,6 @@ Encode and post an event to the server `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() @@ -279,7 +237,3 @@ Register interest in streams using the given model stream ID #### 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 index 88ef815..c79aa18 100644 --- a/docs/@ceramic-sdk/http-client/type-aliases/CeramicAPI.md +++ b/docs/@ceramic-sdk/http-client/type-aliases/CeramicAPI.md @@ -7,7 +7,3 @@ # 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 index b1ca194..e7744dc 100644 --- a/docs/@ceramic-sdk/http-client/type-aliases/ClientParams.md +++ b/docs/@ceramic-sdk/http-client/type-aliases/ClientParams.md @@ -35,7 +35,3 @@ Additional HTTP headers to send with requests > **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 index 32bbd30..a47d959 100644 --- a/docs/@ceramic-sdk/http-client/type-aliases/EventsFeedParams.md +++ b/docs/@ceramic-sdk/http-client/type-aliases/EventsFeedParams.md @@ -21,7 +21,3 @@ Maximum number of events to return in response > `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 index ecd7dfd..0714ad8 100644 --- a/docs/@ceramic-sdk/http-client/type-aliases/Schema.md +++ b/docs/@ceramic-sdk/http-client/type-aliases/Schema.md @@ -11,7 +11,3 @@ ## 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 index 0d363fe..446b462 100644 --- a/docs/@ceramic-sdk/http-client/type-aliases/Schemas.md +++ b/docs/@ceramic-sdk/http-client/type-aliases/Schemas.md @@ -7,7 +7,3 @@ # 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/classes/CommitID.md b/docs/@ceramic-sdk/identifiers/classes/CommitID.md index d808c5b..6a02ee9 100644 --- a/docs/@ceramic-sdk/identifiers/classes/CommitID.md +++ b/docs/@ceramic-sdk/identifiers/classes/CommitID.md @@ -41,20 +41,12 @@ 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() @@ -81,10 +73,6 @@ error on invalid input CommitID#bytes -#### Defined in - -[commit-id.ts:85](https://github.com/ceramicstudio/ceramic-sdk/blob/a220cbca7950f690af7f3d03a0023681bb9f5426/packages/identifiers/src/commit-id.ts#L85) - *** ### fromString() @@ -108,10 +96,6 @@ string representation of CommitID, be it base36-encoded string or URL. - 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 @@ -126,8 +110,6 @@ Construct StreamID, no commit information included #### Defined in -[commit-id.ts:137](https://github.com/ceramicstudio/ceramic-sdk/blob/a220cbca7950f690af7f3d03a0023681bb9f5426/packages/identifiers/src/commit-id.ts#L137) - *** ### bytes @@ -142,8 +124,6 @@ Bytes representation #### Defined in -[commit-id.ts:175](https://github.com/ceramicstudio/ceramic-sdk/blob/a220cbca7950f690af7f3d03a0023681bb9f5426/packages/identifiers/src/commit-id.ts#L175) - *** ### cid @@ -158,8 +138,6 @@ Genesis CID #### Defined in -[commit-id.ts:159](https://github.com/ceramicstudio/ceramic-sdk/blob/a220cbca7950f690af7f3d03a0023681bb9f5426/packages/identifiers/src/commit-id.ts#L159) - *** ### commit @@ -174,8 +152,6 @@ Commit CID #### Defined in -[commit-id.ts:167](https://github.com/ceramicstudio/ceramic-sdk/blob/a220cbca7950f690af7f3d03a0023681bb9f5426/packages/identifiers/src/commit-id.ts#L167) - *** ### type @@ -190,8 +166,6 @@ Stream type code #### Defined in -[commit-id.ts:144](https://github.com/ceramicstudio/ceramic-sdk/blob/a220cbca7950f690af7f3d03a0023681bb9f5426/packages/identifiers/src/commit-id.ts#L144) - *** ### typeName @@ -206,8 +180,6 @@ Stream type name #### Defined in -[commit-id.ts:152](https://github.com/ceramicstudio/ceramic-sdk/blob/a220cbca7950f690af7f3d03a0023681bb9f5426/packages/identifiers/src/commit-id.ts#L152) - ## Methods ### equals() @@ -224,10 +196,6 @@ Compare equality with another CommitID. `boolean` -#### Defined in - -[commit-id.ts:186](https://github.com/ceramicstudio/ceramic-sdk/blob/a220cbca7950f690af7f3d03a0023681bb9f5426/packages/identifiers/src/commit-id.ts#L186) - *** ### toString() @@ -240,10 +208,6 @@ Encode the CommitID into a string. `string` -#### Defined in - -[commit-id.ts:198](https://github.com/ceramicstudio/ceramic-sdk/blob/a220cbca7950f690af7f3d03a0023681bb9f5426/packages/identifiers/src/commit-id.ts#L198) - *** ### toUrl() @@ -256,10 +220,6 @@ Encode the StreamID into a base36 url `string` -#### Defined in - -[commit-id.ts:206](https://github.com/ceramicstudio/ceramic-sdk/blob/a220cbca7950f690af7f3d03a0023681bb9f5426/packages/identifiers/src/commit-id.ts#L206) - *** ### fromStream() @@ -278,10 +238,6 @@ Construct new CommitID for a given stream and commit [`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() @@ -295,7 +251,3 @@ Construct new CommitID for a given stream and commit #### 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 index b3179a6..8ac9c40 100644 --- a/docs/@ceramic-sdk/identifiers/classes/StreamID.md +++ b/docs/@ceramic-sdk/identifiers/classes/StreamID.md @@ -42,20 +42,12 @@ 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() @@ -82,10 +74,6 @@ error on invalid input StreamID#bytes -#### Defined in - -[stream-id.ts:78](https://github.com/ceramicstudio/ceramic-sdk/blob/a220cbca7950f690af7f3d03a0023681bb9f5426/packages/identifiers/src/stream-id.ts#L78) - *** ### fromString() @@ -109,10 +97,6 @@ string representation of StreamID, be it base36-encoded string or URL. - 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 @@ -127,8 +111,6 @@ Copy of self. Exists to maintain compatibility with CommitID. #### Defined in -[stream-id.ts:170](https://github.com/ceramicstudio/ceramic-sdk/blob/a220cbca7950f690af7f3d03a0023681bb9f5426/packages/identifiers/src/stream-id.ts#L170) - *** ### bytes @@ -143,8 +125,6 @@ Bytes representation of StreamID. #### Defined in -[stream-id.ts:160](https://github.com/ceramicstudio/ceramic-sdk/blob/a220cbca7950f690af7f3d03a0023681bb9f5426/packages/identifiers/src/stream-id.ts#L160) - *** ### cid @@ -159,8 +139,6 @@ Genesis commits CID #### Defined in -[stream-id.ts:152](https://github.com/ceramicstudio/ceramic-sdk/blob/a220cbca7950f690af7f3d03a0023681bb9f5426/packages/identifiers/src/stream-id.ts#L152) - *** ### type @@ -175,8 +153,6 @@ Stream type code #### Defined in -[stream-id.ts:137](https://github.com/ceramicstudio/ceramic-sdk/blob/a220cbca7950f690af7f3d03a0023681bb9f5426/packages/identifiers/src/stream-id.ts#L137) - *** ### typeName @@ -191,8 +167,6 @@ Stream type name #### Defined in -[stream-id.ts:145](https://github.com/ceramicstudio/ceramic-sdk/blob/a220cbca7950f690af7f3d03a0023681bb9f5426/packages/identifiers/src/stream-id.ts#L145) - ## Methods ### equals() @@ -209,10 +183,6 @@ Compare equality with another StreamID. `boolean` -#### Defined in - -[stream-id.ts:177](https://github.com/ceramicstudio/ceramic-sdk/blob/a220cbca7950f690af7f3d03a0023681bb9f5426/packages/identifiers/src/stream-id.ts#L177) - *** ### toString() @@ -225,10 +195,6 @@ Encode the StreamID into a string. `string` -#### Defined in - -[stream-id.ts:187](https://github.com/ceramicstudio/ceramic-sdk/blob/a220cbca7950f690af7f3d03a0023681bb9f5426/packages/identifiers/src/stream-id.ts#L187) - *** ### toUrl() @@ -241,10 +207,6 @@ Encode the StreamID into a base36 url. `string` -#### Defined in - -[stream-id.ts:195](https://github.com/ceramicstudio/ceramic-sdk/blob/a220cbca7950f690af7f3d03a0023681bb9f5426/packages/identifiers/src/stream-id.ts#L195) - *** ### fromPayload() @@ -278,10 +240,6 @@ const streamId = StreamID.fromPayload('MID', { }); ``` -#### Defined in - -[stream-id.ts:130](https://github.com/ceramicstudio/ceramic-sdk/blob/a220cbca7950f690af7f3d03a0023681bb9f5426/packages/identifiers/src/stream-id.ts#L130) - *** ### isInstance() @@ -295,7 +253,3 @@ const streamId = StreamID.fromPayload('MID', { #### 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 index 69393e2..acaecfa 100644 --- a/docs/@ceramic-sdk/identifiers/type-aliases/StreamType.md +++ b/docs/@ceramic-sdk/identifiers/type-aliases/StreamType.md @@ -7,7 +7,3 @@ # 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 index 2efa38c..fd03306 100644 --- a/docs/@ceramic-sdk/identifiers/type-aliases/StreamTypeCode.md +++ b/docs/@ceramic-sdk/identifiers/type-aliases/StreamTypeCode.md @@ -7,7 +7,3 @@ # 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 index 9f6be14..6b66988 100644 --- a/docs/@ceramic-sdk/identifiers/type-aliases/StreamTypeName.md +++ b/docs/@ceramic-sdk/identifiers/type-aliases/StreamTypeName.md @@ -7,7 +7,3 @@ # 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 index 0279475..2635326 100644 --- a/docs/@ceramic-sdk/identifiers/variables/streamIDAsBytes.md +++ b/docs/@ceramic-sdk/identifiers/variables/streamIDAsBytes.md @@ -6,10 +6,6 @@ # Variable: streamIDAsBytes -> `const` **streamIDAsBytes**: `Type`\<[`StreamID`](../classes/StreamID.md), `Uint8Array`, `Uint8Array`\> +> `const` **streamIDAsBytes**: `Type`\<[`StreamID`](../classes/StreamID.md), `Uint8Array`, `Uint8Array` \| [`StreamID`](../classes/StreamID.md)\> 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 index 88991cb..4470f2b 100644 --- a/docs/@ceramic-sdk/identifiers/variables/streamIDAsString.md +++ b/docs/@ceramic-sdk/identifiers/variables/streamIDAsString.md @@ -9,7 +9,3 @@ > `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 index 9b3dcdd..2b12bd6 100644 --- a/docs/@ceramic-sdk/identifiers/variables/streamIDString.md +++ b/docs/@ceramic-sdk/identifiers/variables/streamIDString.md @@ -9,7 +9,3 @@ > `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 index 08b4679..f48a621 100644 --- a/docs/@ceramic-sdk/model-client/README.md +++ b/docs/@ceramic-sdk/model-client/README.md @@ -6,6 +6,10 @@ # @ceramic-sdk/model-client +## Classes + +- [ModelClient](classes/ModelClient.md) + ## Functions - [createInitEvent](functions/createInitEvent.md) diff --git a/docs/@ceramic-sdk/model-client/classes/ModelClient.md b/docs/@ceramic-sdk/model-client/classes/ModelClient.md new file mode 100644 index 0000000..97e303a --- /dev/null +++ b/docs/@ceramic-sdk/model-client/classes/ModelClient.md @@ -0,0 +1,119 @@ +[**@ceramic-sdk/model-client v0.1.0**](../README.md) • **Docs** + +*** + +[Ceramic SDK](../../../README.md) / [@ceramic-sdk/model-client](../README.md) / ModelClient + +# Class: ModelClient + +## Extends + +- [`StreamClient`](../../stream-client/classes/StreamClient.md) + +## Constructors + +### new ModelClient() + +> **new ModelClient**(`params`): [`ModelClient`](ModelClient.md) + +#### Parameters + +• **params**: [`StreamClientParams`](../../stream-client/type-aliases/StreamClientParams.md) + +#### Returns + +[`ModelClient`](ModelClient.md) + +#### Inherited from + +[`StreamClient`](../../stream-client/classes/StreamClient.md).[`constructor`](../../stream-client/classes/StreamClient.md#constructors) + +## Accessors + +### ceramic + +> `get` **ceramic**(): [`CeramicClient`](../../http-client/classes/CeramicClient.md) + +Ceramic HTTP client instance used to interact with Ceramic One server + +#### Returns + +[`CeramicClient`](../../http-client/classes/CeramicClient.md) + +#### Inherited from + +[`StreamClient`](../../stream-client/classes/StreamClient.md).[`ceramic`](../../stream-client/classes/StreamClient.md#ceramic) + +#### Defined in + +## Methods + +### getDID() + +> **getDID**(`provided`?): `DID` + +Utility method used to access the provided DID or the one attached to the instance, throws if neither is provided + +#### Parameters + +• **provided?**: `DID` + +#### Returns + +`DID` + +#### Inherited from + +[`StreamClient`](../../stream-client/classes/StreamClient.md).[`getDID`](../../stream-client/classes/StreamClient.md#getdid) + +*** + +### getInitEvent() + +> **getInitEvent**(`streamID`): `Promise`\<`MapIn`\<`RequiredProps`\<`object`\>, `$TypeOf`\> & `MapIn`\<`OptionalProps`\<`object`\>, `$TypeOf`\>\> + +Get the signed init event of a Model based on its stream ID + +#### Parameters + +• **streamID**: `string` \| [`StreamID`](../../identifiers/classes/StreamID.md) + +#### Returns + +`Promise`\<`MapIn`\<`RequiredProps`\<`object`\>, `$TypeOf`\> & `MapIn`\<`OptionalProps`\<`object`\>, `$TypeOf`\>\> + +*** + +### getPayload() + +> **getPayload**(`streamID`, `verifier`?): `Promise`\<`MapIn`\<`object`, `$TypeOf`\>\> + +Get the init event payload of a Model based on its stream ID + +#### Parameters + +• **streamID**: `string` \| [`StreamID`](../../identifiers/classes/StreamID.md) + +• **verifier?**: `DID` + +#### Returns + +`Promise`\<`MapIn`\<`object`, `$TypeOf`\>\> + +*** + +### postDefinition() + +> **postDefinition**(`definition`, `signer`?): `Promise`\<[`StreamID`](../../identifiers/classes/StreamID.md)\> + +Post a Model definition and return its stream ID + +#### Parameters + +• **definition**: `MapIn`\<`RequiredProps`\<`object`\>, `$TypeOf`\> & `MapIn`\<`OptionalProps`\<`object`\>, `$TypeOf`\> \| `MapIn`\<`RequiredProps`\<`object`\>, `$TypeOf`\> & `MapIn`\<`OptionalProps`\<`object`\>, `$TypeOf`\> + +• **signer?**: `DID` + +#### Returns + +`Promise`\<[`StreamID`](../../identifiers/classes/StreamID.md)\> diff --git a/docs/@ceramic-sdk/model-client/functions/createInitEvent.md b/docs/@ceramic-sdk/model-client/functions/createInitEvent.md index 9537392..b53cb5f 100644 --- a/docs/@ceramic-sdk/model-client/functions/createInitEvent.md +++ b/docs/@ceramic-sdk/model-client/functions/createInitEvent.md @@ -19,7 +19,3 @@ Create a signed init event for a model using the provided DID and model definiti ## 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 index 8fab865..38c9b07 100644 --- a/docs/@ceramic-sdk/model-instance-client/README.md +++ b/docs/@ceramic-sdk/model-instance-client/README.md @@ -6,10 +6,17 @@ # @ceramic-sdk/model-instance-client +## Classes + +- [DocumentClient](classes/DocumentClient.md) + ## Type Aliases - [CreateDataEventParams](type-aliases/CreateDataEventParams.md) - [CreateInitEventParams](type-aliases/CreateInitEventParams.md) +- [PostDataParams](type-aliases/PostDataParams.md) +- [PostDeterministicInitParams](type-aliases/PostDeterministicInitParams.md) +- [PostSignedInitParams](type-aliases/PostSignedInitParams.md) - [UnknownContent](type-aliases/UnknownContent.md) ## Functions diff --git a/docs/@ceramic-sdk/model-instance-client/classes/DocumentClient.md b/docs/@ceramic-sdk/model-instance-client/classes/DocumentClient.md new file mode 100644 index 0000000..467fbd1 --- /dev/null +++ b/docs/@ceramic-sdk/model-instance-client/classes/DocumentClient.md @@ -0,0 +1,139 @@ +[**@ceramic-sdk/model-instance-client v0.1.0**](../README.md) • **Docs** + +*** + +[Ceramic SDK](../../../README.md) / [@ceramic-sdk/model-instance-client](../README.md) / DocumentClient + +# Class: DocumentClient + +## Extends + +- [`StreamClient`](../../stream-client/classes/StreamClient.md) + +## Constructors + +### new DocumentClient() + +> **new DocumentClient**(`params`): [`DocumentClient`](DocumentClient.md) + +#### Parameters + +• **params**: [`StreamClientParams`](../../stream-client/type-aliases/StreamClientParams.md) + +#### Returns + +[`DocumentClient`](DocumentClient.md) + +#### Inherited from + +[`StreamClient`](../../stream-client/classes/StreamClient.md).[`constructor`](../../stream-client/classes/StreamClient.md#constructors) + +## Accessors + +### ceramic + +> `get` **ceramic**(): [`CeramicClient`](../../http-client/classes/CeramicClient.md) + +Ceramic HTTP client instance used to interact with Ceramic One server + +#### Returns + +[`CeramicClient`](../../http-client/classes/CeramicClient.md) + +#### Inherited from + +[`StreamClient`](../../stream-client/classes/StreamClient.md).[`ceramic`](../../stream-client/classes/StreamClient.md#ceramic) + +#### Defined in + +## Methods + +### getDID() + +> **getDID**(`provided`?): `DID` + +Utility method used to access the provided DID or the one attached to the instance, throws if neither is provided + +#### Parameters + +• **provided?**: `DID` + +#### Returns + +`DID` + +#### Inherited from + +[`StreamClient`](../../stream-client/classes/StreamClient.md).[`getDID`](../../stream-client/classes/StreamClient.md#getdid) + +*** + +### getEvent() + +> **getEvent**(`commitID`): `Promise`\<`MapIn`\<`RequiredProps`\<`object`\>, `$OutputOf`\> & `MapIn`\<`OptionalProps`\<`object`\>, `$OutputOf`\> \| `MapIn`\<`RequiredProps`\<`object`\>, `$OutputOf`\> & `MapIn`\<`OptionalProps`\<`object`\>, `$OutputOf`\> \| `MapIn`\<`object`, `$OutputOf`\>\> + +Get a DocumentEvent based on its commit ID + +#### Parameters + +• **commitID**: `string` \| [`CommitID`](../../identifiers/classes/CommitID.md) + +#### Returns + +`Promise`\<`MapIn`\<`RequiredProps`\<`object`\>, `$OutputOf`\> & `MapIn`\<`OptionalProps`\<`object`\>, `$OutputOf`\> \| `MapIn`\<`RequiredProps`\<`object`\>, `$OutputOf`\> & `MapIn`\<`OptionalProps`\<`object`\>, `$OutputOf`\> \| `MapIn`\<`object`, `$OutputOf`\>\> + +*** + +### postData() + +> **postData**\<`T`\>(`params`): `Promise`\<[`CommitID`](../../identifiers/classes/CommitID.md)\> + +Post a data event and return its commit ID + +#### Type Parameters + +• **T** *extends* [`UnknownContent`](../type-aliases/UnknownContent.md) = [`UnknownContent`](../type-aliases/UnknownContent.md) + +#### Parameters + +• **params**: [`PostDataParams`](../type-aliases/PostDataParams.md)\<`T`\> + +#### Returns + +`Promise`\<[`CommitID`](../../identifiers/classes/CommitID.md)\> + +*** + +### postDeterministicInit() + +> **postDeterministicInit**(`params`): `Promise`\<[`CommitID`](../../identifiers/classes/CommitID.md)\> + +Post a deterministic init event and return its commit ID + +#### Parameters + +• **params**: [`PostDeterministicInitParams`](../type-aliases/PostDeterministicInitParams.md) + +#### Returns + +`Promise`\<[`CommitID`](../../identifiers/classes/CommitID.md)\> + +*** + +### postSignedInit() + +> **postSignedInit**\<`T`\>(`params`): `Promise`\<[`CommitID`](../../identifiers/classes/CommitID.md)\> + +Post a signed (non-deterministic) init event and return its commit ID + +#### Type Parameters + +• **T** *extends* [`UnknownContent`](../type-aliases/UnknownContent.md) = [`UnknownContent`](../type-aliases/UnknownContent.md) + +#### Parameters + +• **params**: [`PostSignedInitParams`](../type-aliases/PostSignedInitParams.md)\<`T`\> + +#### Returns + +`Promise`\<[`CommitID`](../../identifiers/classes/CommitID.md)\> diff --git a/docs/@ceramic-sdk/model-instance-client/functions/createDataEvent.md b/docs/@ceramic-sdk/model-instance-client/functions/createDataEvent.md index 5dd4a67..e0bbbb7 100644 --- a/docs/@ceramic-sdk/model-instance-client/functions/createDataEvent.md +++ b/docs/@ceramic-sdk/model-instance-client/functions/createDataEvent.md @@ -21,7 +21,3 @@ Create a signed data event for a ModelInstanceDocument stream ## 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 index dd087ef..dce3409 100644 --- a/docs/@ceramic-sdk/model-instance-client/functions/createDataEventPayload.md +++ b/docs/@ceramic-sdk/model-instance-client/functions/createDataEventPayload.md @@ -21,7 +21,3 @@ Create a data event payload for a ModelInstanceDocument stream ## 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 index f4ed070..8ad0bdf 100644 --- a/docs/@ceramic-sdk/model-instance-client/functions/createInitEvent.md +++ b/docs/@ceramic-sdk/model-instance-client/functions/createInitEvent.md @@ -25,7 +25,3 @@ Create a non-deterministic init event for a ModelInstanceDocument stream. ## 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 index d44dfe9..bc5715a 100644 --- a/docs/@ceramic-sdk/model-instance-client/functions/getDeterministicInitEvent.md +++ b/docs/@ceramic-sdk/model-instance-client/functions/getDeterministicInitEvent.md @@ -21,7 +21,3 @@ Get an encoded deterministic init event for a ModelInstanceDocument stream ## 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 index 1497c2e..6388a5e 100644 --- a/docs/@ceramic-sdk/model-instance-client/functions/getDeterministicInitEventPayload.md +++ b/docs/@ceramic-sdk/model-instance-client/functions/getDeterministicInitEventPayload.md @@ -25,7 +25,3 @@ Get a deterministic init event payload for a ModelInstanceDocument stream. ## 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 index e8f57d0..dc5889b 100644 --- a/docs/@ceramic-sdk/model-instance-client/type-aliases/CreateDataEventParams.md +++ b/docs/@ceramic-sdk/model-instance-client/type-aliases/CreateDataEventParams.md @@ -43,7 +43,3 @@ New JSON object content for the ModelInstanceDocument stream, used with `current > `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 index 44fe406..449a329 100644 --- a/docs/@ceramic-sdk/model-instance-client/type-aliases/CreateInitEventParams.md +++ b/docs/@ceramic-sdk/model-instance-client/type-aliases/CreateInitEventParams.md @@ -43,7 +43,3 @@ Stream ID of the Model used by the ModelInstanceDocument stream > `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/PostDataParams.md b/docs/@ceramic-sdk/model-instance-client/type-aliases/PostDataParams.md new file mode 100644 index 0000000..ad1f70f --- /dev/null +++ b/docs/@ceramic-sdk/model-instance-client/type-aliases/PostDataParams.md @@ -0,0 +1,19 @@ +[**@ceramic-sdk/model-instance-client v0.1.0**](../README.md) • **Docs** + +*** + +[Ceramic SDK](../../../README.md) / [@ceramic-sdk/model-instance-client](../README.md) / PostDataParams + +# Type Alias: PostDataParams\ + +> **PostDataParams**\<`T`\>: `Omit`\<[`CreateDataEventParams`](CreateDataEventParams.md)\<`T`\>, `"controller"`\> & `object` + +## Type declaration + +### controller? + +> `optional` **controller**: `DID` + +## Type Parameters + +• **T** *extends* [`UnknownContent`](UnknownContent.md) = [`UnknownContent`](UnknownContent.md) diff --git a/docs/@ceramic-sdk/model-instance-client/type-aliases/PostDeterministicInitParams.md b/docs/@ceramic-sdk/model-instance-client/type-aliases/PostDeterministicInitParams.md new file mode 100644 index 0000000..9c6e261 --- /dev/null +++ b/docs/@ceramic-sdk/model-instance-client/type-aliases/PostDeterministicInitParams.md @@ -0,0 +1,23 @@ +[**@ceramic-sdk/model-instance-client v0.1.0**](../README.md) • **Docs** + +*** + +[Ceramic SDK](../../../README.md) / [@ceramic-sdk/model-instance-client](../README.md) / PostDeterministicInitParams + +# Type Alias: PostDeterministicInitParams + +> **PostDeterministicInitParams**: `object` + +## Type declaration + +### controller + +> **controller**: `DIDString` \| `string` + +### model + +> **model**: [`StreamID`](../../identifiers/classes/StreamID.md) + +### uniqueValue? + +> `optional` **uniqueValue**: `Uint8Array` diff --git a/docs/@ceramic-sdk/model-instance-client/type-aliases/PostSignedInitParams.md b/docs/@ceramic-sdk/model-instance-client/type-aliases/PostSignedInitParams.md new file mode 100644 index 0000000..0556c14 --- /dev/null +++ b/docs/@ceramic-sdk/model-instance-client/type-aliases/PostSignedInitParams.md @@ -0,0 +1,19 @@ +[**@ceramic-sdk/model-instance-client v0.1.0**](../README.md) • **Docs** + +*** + +[Ceramic SDK](../../../README.md) / [@ceramic-sdk/model-instance-client](../README.md) / PostSignedInitParams + +# Type Alias: PostSignedInitParams\ + +> **PostSignedInitParams**\<`T`\>: `Omit`\<[`CreateInitEventParams`](CreateInitEventParams.md)\<`T`\>, `"controller"`\> & `object` + +## Type declaration + +### controller? + +> `optional` **controller**: `DID` + +## Type Parameters + +• **T** *extends* [`UnknownContent`](UnknownContent.md) = [`UnknownContent`](UnknownContent.md) diff --git a/docs/@ceramic-sdk/model-instance-client/type-aliases/UnknownContent.md b/docs/@ceramic-sdk/model-instance-client/type-aliases/UnknownContent.md index 18f9f0b..23ca902 100644 --- a/docs/@ceramic-sdk/model-instance-client/type-aliases/UnknownContent.md +++ b/docs/@ceramic-sdk/model-instance-client/type-aliases/UnknownContent.md @@ -7,7 +7,3 @@ # 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/functions/getDeterministicStreamID.md b/docs/@ceramic-sdk/model-instance-protocol/functions/getDeterministicStreamID.md index de54b0b..c9db38d 100644 --- a/docs/@ceramic-sdk/model-instance-protocol/functions/getDeterministicStreamID.md +++ b/docs/@ceramic-sdk/model-instance-protocol/functions/getDeterministicStreamID.md @@ -17,7 +17,3 @@ Get the StreamID of a deterministic ModelInstanceDocument based on its init head ## 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 index 4475112..2b23e41 100644 --- a/docs/@ceramic-sdk/model-instance-protocol/functions/getStreamID.md +++ b/docs/@ceramic-sdk/model-instance-protocol/functions/getStreamID.md @@ -17,7 +17,3 @@ Get the StreamID of a ModelInstanceDocument based on its init CID ## 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 index 0de1a7f..e1ec152 100644 --- a/docs/@ceramic-sdk/model-instance-protocol/type-aliases/DataInitEventPayload.md +++ b/docs/@ceramic-sdk/model-instance-protocol/type-aliases/DataInitEventPayload.md @@ -7,7 +7,3 @@ # 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 index c81c452..5b2f57e 100644 --- a/docs/@ceramic-sdk/model-instance-protocol/type-aliases/DeterministicInitEventPayload.md +++ b/docs/@ceramic-sdk/model-instance-protocol/type-aliases/DeterministicInitEventPayload.md @@ -7,7 +7,3 @@ # 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 index 6cd5899..ca7c147 100644 --- a/docs/@ceramic-sdk/model-instance-protocol/type-aliases/DocumentDataEventHeader.md +++ b/docs/@ceramic-sdk/model-instance-protocol/type-aliases/DocumentDataEventHeader.md @@ -7,7 +7,3 @@ # 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 index 08db14f..c237179 100644 --- a/docs/@ceramic-sdk/model-instance-protocol/type-aliases/DocumentDataEventPayload.md +++ b/docs/@ceramic-sdk/model-instance-protocol/type-aliases/DocumentDataEventPayload.md @@ -7,7 +7,3 @@ # 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 index d7d12c3..dd8b36f 100644 --- a/docs/@ceramic-sdk/model-instance-protocol/type-aliases/DocumentEvent.md +++ b/docs/@ceramic-sdk/model-instance-protocol/type-aliases/DocumentEvent.md @@ -7,7 +7,3 @@ # 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 index 15d0280..89717d1 100644 --- a/docs/@ceramic-sdk/model-instance-protocol/type-aliases/DocumentInitEventHeader.md +++ b/docs/@ceramic-sdk/model-instance-protocol/type-aliases/DocumentInitEventHeader.md @@ -7,7 +7,3 @@ # 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 index bef98a1..6926c6d 100644 --- a/docs/@ceramic-sdk/model-instance-protocol/type-aliases/DocumentInitEventPayload.md +++ b/docs/@ceramic-sdk/model-instance-protocol/type-aliases/DocumentInitEventPayload.md @@ -7,7 +7,3 @@ # 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 index f0662d6..bdc3082 100644 --- a/docs/@ceramic-sdk/model-instance-protocol/type-aliases/DocumentMetadata.md +++ b/docs/@ceramic-sdk/model-instance-protocol/type-aliases/DocumentMetadata.md @@ -7,7 +7,3 @@ # 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 index 9e8e2be..9dd0451 100644 --- a/docs/@ceramic-sdk/model-instance-protocol/type-aliases/EncodedDeterministicInitEventPayload.md +++ b/docs/@ceramic-sdk/model-instance-protocol/type-aliases/EncodedDeterministicInitEventPayload.md @@ -7,7 +7,3 @@ # 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 index 7f98add..ea1f131 100644 --- a/docs/@ceramic-sdk/model-instance-protocol/type-aliases/EncodedDocumentMetadata.md +++ b/docs/@ceramic-sdk/model-instance-protocol/type-aliases/EncodedDocumentMetadata.md @@ -7,7 +7,3 @@ # 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 index 5efd6c9..877bc80 100644 --- a/docs/@ceramic-sdk/model-instance-protocol/type-aliases/JSONPatchOperation.md +++ b/docs/@ceramic-sdk/model-instance-protocol/type-aliases/JSONPatchOperation.md @@ -7,7 +7,3 @@ # 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 index 6353f0a..0264312 100644 --- a/docs/@ceramic-sdk/model-instance-protocol/variables/DataInitEventPayload.md +++ b/docs/@ceramic-sdk/model-instance-protocol/variables/DataInitEventPayload.md @@ -24,7 +24,7 @@ Init event payload for a non-deterministic ModelInstanceDocument Stream ##### context -> **context**: `OptionalCodec`\<`Type`\<[`StreamID`](../../identifiers/classes/StreamID.md), `Uint8Array`, `Uint8Array`\>\> +> **context**: `OptionalCodec`\<`Type`\<[`StreamID`](../../identifiers/classes/StreamID.md), `Uint8Array`, [`StreamID`](../../identifiers/classes/StreamID.md) \| `Uint8Array`\>\> ##### controllers @@ -32,7 +32,7 @@ Init event payload for a non-deterministic ModelInstanceDocument Stream ##### model -> **model**: `Type`\<[`StreamID`](../../identifiers/classes/StreamID.md), `Uint8Array`, `Uint8Array`\> = `streamIDAsBytes` +> **model**: `Type`\<[`StreamID`](../../identifiers/classes/StreamID.md), `Uint8Array`, [`StreamID`](../../identifiers/classes/StreamID.md) \| `Uint8Array`\> = `streamIDAsBytes` ##### sep @@ -45,7 +45,3 @@ Init event payload for a non-deterministic ModelInstanceDocument Stream ##### 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 index 80106e7..938d294 100644 --- a/docs/@ceramic-sdk/model-instance-protocol/variables/DeterministicInitEventPayload.md +++ b/docs/@ceramic-sdk/model-instance-protocol/variables/DeterministicInitEventPayload.md @@ -24,7 +24,7 @@ Init event payload for a deterministic ModelInstanceDocument Stream ##### context -> **context**: `OptionalCodec`\<`Type`\<[`StreamID`](../../identifiers/classes/StreamID.md), `Uint8Array`, `Uint8Array`\>\> +> **context**: `OptionalCodec`\<`Type`\<[`StreamID`](../../identifiers/classes/StreamID.md), `Uint8Array`, [`StreamID`](../../identifiers/classes/StreamID.md) \| `Uint8Array`\>\> ##### controllers @@ -32,7 +32,7 @@ Init event payload for a deterministic ModelInstanceDocument Stream ##### model -> **model**: `Type`\<[`StreamID`](../../identifiers/classes/StreamID.md), `Uint8Array`, `Uint8Array`\> = `streamIDAsBytes` +> **model**: `Type`\<[`StreamID`](../../identifiers/classes/StreamID.md), `Uint8Array`, [`StreamID`](../../identifiers/classes/StreamID.md) \| `Uint8Array`\> = `streamIDAsBytes` ##### sep @@ -45,7 +45,3 @@ Init event payload for a deterministic ModelInstanceDocument Stream ##### 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 index e432e44..09a84cd 100644 --- a/docs/@ceramic-sdk/model-instance-protocol/variables/DocumentDataEventHeader.md +++ b/docs/@ceramic-sdk/model-instance-protocol/variables/DocumentDataEventHeader.md @@ -15,7 +15,3 @@ Data event header for a ModelInstanceDocument Stream ### 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 index a3184e4..274ce91 100644 --- a/docs/@ceramic-sdk/model-instance-protocol/variables/DocumentDataEventPayload.md +++ b/docs/@ceramic-sdk/model-instance-protocol/variables/DocumentDataEventPayload.md @@ -27,7 +27,3 @@ Data event payload for a ModelInstanceDocument Stream ### 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 index 1bad094..57912d8 100644 --- a/docs/@ceramic-sdk/model-instance-protocol/variables/DocumentEvent.md +++ b/docs/@ceramic-sdk/model-instance-protocol/variables/DocumentEvent.md @@ -9,7 +9,3 @@ > `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 index a8bff90..da20767 100644 --- a/docs/@ceramic-sdk/model-instance-protocol/variables/DocumentInitEventHeader.md +++ b/docs/@ceramic-sdk/model-instance-protocol/variables/DocumentInitEventHeader.md @@ -14,7 +14,7 @@ Init event header for a ModelInstanceDocument Stream ### context -> **context**: `OptionalCodec`\<`Type`\<[`StreamID`](../../identifiers/classes/StreamID.md), `Uint8Array`, `Uint8Array`\>\> +> **context**: `OptionalCodec`\<`Type`\<[`StreamID`](../../identifiers/classes/StreamID.md), `Uint8Array`, [`StreamID`](../../identifiers/classes/StreamID.md) \| `Uint8Array`\>\> ### controllers @@ -22,7 +22,7 @@ Init event header for a ModelInstanceDocument Stream ### model -> **model**: `Type`\<[`StreamID`](../../identifiers/classes/StreamID.md), `Uint8Array`, `Uint8Array`\> = `streamIDAsBytes` +> **model**: `Type`\<[`StreamID`](../../identifiers/classes/StreamID.md), `Uint8Array`, [`StreamID`](../../identifiers/classes/StreamID.md) \| `Uint8Array`\> = `streamIDAsBytes` ### sep @@ -35,7 +35,3 @@ Init event header for a ModelInstanceDocument Stream ### 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 index cf054ca..ae9c435 100644 --- a/docs/@ceramic-sdk/model-instance-protocol/variables/DocumentInitEventPayload.md +++ b/docs/@ceramic-sdk/model-instance-protocol/variables/DocumentInitEventPayload.md @@ -9,7 +9,3 @@ > `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 index 679813c..b089245 100644 --- a/docs/@ceramic-sdk/model-instance-protocol/variables/DocumentMetadata.md +++ b/docs/@ceramic-sdk/model-instance-protocol/variables/DocumentMetadata.md @@ -41,7 +41,3 @@ Whether the stream should be indexed or not. > **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 index 5548d05..40bb2e7 100644 --- a/docs/@ceramic-sdk/model-instance-protocol/variables/JSONPatchAddOperation.md +++ b/docs/@ceramic-sdk/model-instance-protocol/variables/JSONPatchAddOperation.md @@ -9,7 +9,3 @@ > `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 index 3c841d9..fa5484f 100644 --- a/docs/@ceramic-sdk/model-instance-protocol/variables/JSONPatchCopyOperation.md +++ b/docs/@ceramic-sdk/model-instance-protocol/variables/JSONPatchCopyOperation.md @@ -7,7 +7,3 @@ # 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 index 28d7289..7100e38 100644 --- a/docs/@ceramic-sdk/model-instance-protocol/variables/JSONPatchMoveOperation.md +++ b/docs/@ceramic-sdk/model-instance-protocol/variables/JSONPatchMoveOperation.md @@ -7,7 +7,3 @@ # 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 index 2bc0483..a0fbf91 100644 --- a/docs/@ceramic-sdk/model-instance-protocol/variables/JSONPatchOperation.md +++ b/docs/@ceramic-sdk/model-instance-protocol/variables/JSONPatchOperation.md @@ -7,7 +7,3 @@ # 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 index dcca0d2..dff98b9 100644 --- a/docs/@ceramic-sdk/model-instance-protocol/variables/JSONPatchRemoveOperation.md +++ b/docs/@ceramic-sdk/model-instance-protocol/variables/JSONPatchRemoveOperation.md @@ -7,7 +7,3 @@ # 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 index 9d07ec8..33593d3 100644 --- a/docs/@ceramic-sdk/model-instance-protocol/variables/JSONPatchReplaceOperation.md +++ b/docs/@ceramic-sdk/model-instance-protocol/variables/JSONPatchReplaceOperation.md @@ -7,7 +7,3 @@ # 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 index b721367..2706c1a 100644 --- a/docs/@ceramic-sdk/model-instance-protocol/variables/JSONPatchTestOperation.md +++ b/docs/@ceramic-sdk/model-instance-protocol/variables/JSONPatchTestOperation.md @@ -7,7 +7,3 @@ # 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 index f356206..eedf472 100644 --- a/docs/@ceramic-sdk/model-instance-protocol/variables/MAX_DOCUMENT_SIZE.md +++ b/docs/@ceramic-sdk/model-instance-protocol/variables/MAX_DOCUMENT_SIZE.md @@ -9,7 +9,3 @@ > `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/functions/assertValidModelContent.md b/docs/@ceramic-sdk/model-protocol/functions/assertValidModelContent.md index e54a7d5..28bd320 100644 --- a/docs/@ceramic-sdk/model-protocol/functions/assertValidModelContent.md +++ b/docs/@ceramic-sdk/model-protocol/functions/assertValidModelContent.md @@ -19,7 +19,3 @@ 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 index 4077d2f..64619e8 100644 --- a/docs/@ceramic-sdk/model-protocol/functions/getModelStreamID.md +++ b/docs/@ceramic-sdk/model-protocol/functions/getModelStreamID.md @@ -19,7 +19,3 @@ 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 index e92cb40..a70954f 100644 --- a/docs/@ceramic-sdk/model-protocol/type-aliases/ModelAccountRelation.md +++ b/docs/@ceramic-sdk/model-protocol/type-aliases/ModelAccountRelation.md @@ -7,7 +7,3 @@ # 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 index 43e58f3..a5ceee8 100644 --- a/docs/@ceramic-sdk/model-protocol/type-aliases/ModelAccountRelationV2.md +++ b/docs/@ceramic-sdk/model-protocol/type-aliases/ModelAccountRelationV2.md @@ -7,7 +7,3 @@ # 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 index 98b05de..381b001 100644 --- a/docs/@ceramic-sdk/model-protocol/type-aliases/ModelDefinition.md +++ b/docs/@ceramic-sdk/model-protocol/type-aliases/ModelDefinition.md @@ -7,7 +7,3 @@ # 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 index 4c5c5f4..118bef2 100644 --- a/docs/@ceramic-sdk/model-protocol/type-aliases/ModelDefinitionV1.md +++ b/docs/@ceramic-sdk/model-protocol/type-aliases/ModelDefinitionV1.md @@ -7,7 +7,3 @@ # 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 index 0fb91fd..1cb619a 100644 --- a/docs/@ceramic-sdk/model-protocol/type-aliases/ModelDefinitionV2.md +++ b/docs/@ceramic-sdk/model-protocol/type-aliases/ModelDefinitionV2.md @@ -7,7 +7,3 @@ # 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 index d4e4ca4..5a1037a 100644 --- a/docs/@ceramic-sdk/model-protocol/type-aliases/ModelDocumentMetadataViewDefinition.md +++ b/docs/@ceramic-sdk/model-protocol/type-aliases/ModelDocumentMetadataViewDefinition.md @@ -7,7 +7,3 @@ # 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 index a62014c..f61b76e 100644 --- a/docs/@ceramic-sdk/model-protocol/type-aliases/ModelEvent.md +++ b/docs/@ceramic-sdk/model-protocol/type-aliases/ModelEvent.md @@ -7,7 +7,3 @@ # 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 index 1b1cac3..7afdea1 100644 --- a/docs/@ceramic-sdk/model-protocol/type-aliases/ModelEventHeader.md +++ b/docs/@ceramic-sdk/model-protocol/type-aliases/ModelEventHeader.md @@ -7,7 +7,3 @@ # 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 index aeea199..7fb0d7f 100644 --- a/docs/@ceramic-sdk/model-protocol/type-aliases/ModelInitEventPayload.md +++ b/docs/@ceramic-sdk/model-protocol/type-aliases/ModelInitEventPayload.md @@ -7,7 +7,3 @@ # 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 index ecd3f06..20ecef3 100644 --- a/docs/@ceramic-sdk/model-protocol/type-aliases/ModelMetadata.md +++ b/docs/@ceramic-sdk/model-protocol/type-aliases/ModelMetadata.md @@ -7,7 +7,3 @@ # 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 index a475df3..69ca062 100644 --- a/docs/@ceramic-sdk/model-protocol/type-aliases/ModelRelationDefinition.md +++ b/docs/@ceramic-sdk/model-protocol/type-aliases/ModelRelationDefinition.md @@ -7,7 +7,3 @@ # 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 index 178168f..9a6bcf9 100644 --- a/docs/@ceramic-sdk/model-protocol/type-aliases/ModelRelationDefinitionV2.md +++ b/docs/@ceramic-sdk/model-protocol/type-aliases/ModelRelationDefinitionV2.md @@ -7,7 +7,3 @@ # 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 index f6ad237..c5601d5 100644 --- a/docs/@ceramic-sdk/model-protocol/type-aliases/ModelRelationViewDefinition.md +++ b/docs/@ceramic-sdk/model-protocol/type-aliases/ModelRelationViewDefinition.md @@ -7,7 +7,3 @@ # 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 index 875e24f..3b21eb4 100644 --- a/docs/@ceramic-sdk/model-protocol/type-aliases/ModelRelationViewDefinitionV2.md +++ b/docs/@ceramic-sdk/model-protocol/type-aliases/ModelRelationViewDefinitionV2.md @@ -7,7 +7,3 @@ # 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 index a20808b..1ab938d 100644 --- a/docs/@ceramic-sdk/model-protocol/type-aliases/ModelRelationsDefinition.md +++ b/docs/@ceramic-sdk/model-protocol/type-aliases/ModelRelationsDefinition.md @@ -7,7 +7,3 @@ # 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 index e2d5824..3ad838d 100644 --- a/docs/@ceramic-sdk/model-protocol/type-aliases/ModelRelationsDefinitionV2.md +++ b/docs/@ceramic-sdk/model-protocol/type-aliases/ModelRelationsDefinitionV2.md @@ -7,7 +7,3 @@ # 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 index 5787819..a065c68 100644 --- a/docs/@ceramic-sdk/model-protocol/type-aliases/ModelViewDefinition.md +++ b/docs/@ceramic-sdk/model-protocol/type-aliases/ModelViewDefinition.md @@ -7,7 +7,3 @@ # 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 index d8b7e55..c08eac6 100644 --- a/docs/@ceramic-sdk/model-protocol/type-aliases/ModelViewDefinitionV2.md +++ b/docs/@ceramic-sdk/model-protocol/type-aliases/ModelViewDefinitionV2.md @@ -7,7 +7,3 @@ # 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 index c0270a5..6c69e9c 100644 --- a/docs/@ceramic-sdk/model-protocol/type-aliases/ModelViewsDefinition.md +++ b/docs/@ceramic-sdk/model-protocol/type-aliases/ModelViewsDefinition.md @@ -7,7 +7,3 @@ # 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 index 22097a7..8e72aaf 100644 --- a/docs/@ceramic-sdk/model-protocol/type-aliases/ModelViewsDefinitionV2.md +++ b/docs/@ceramic-sdk/model-protocol/type-aliases/ModelViewsDefinitionV2.md @@ -7,7 +7,3 @@ # 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 index f146c99..1914d84 100644 --- a/docs/@ceramic-sdk/model-protocol/type-aliases/ObjectSchema.md +++ b/docs/@ceramic-sdk/model-protocol/type-aliases/ObjectSchema.md @@ -7,7 +7,3 @@ # 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 index 47eebdd..d61afae 100644 --- a/docs/@ceramic-sdk/model-protocol/type-aliases/SchemaType.md +++ b/docs/@ceramic-sdk/model-protocol/type-aliases/SchemaType.md @@ -7,7 +7,3 @@ # 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 index 5e407f7..733d9c4 100644 --- a/docs/@ceramic-sdk/model-protocol/type-aliases/ValidVersionSatisfies.md +++ b/docs/@ceramic-sdk/model-protocol/type-aliases/ValidVersionSatisfies.md @@ -11,7 +11,3 @@ 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 index 60a4093..46e4635 100644 --- a/docs/@ceramic-sdk/model-protocol/variables/MODEL.md +++ b/docs/@ceramic-sdk/model-protocol/variables/MODEL.md @@ -7,7 +7,3 @@ # 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 index df1d612..5d77a5e 100644 --- a/docs/@ceramic-sdk/model-protocol/variables/MODEL_STREAM_ID.md +++ b/docs/@ceramic-sdk/model-protocol/variables/MODEL_STREAM_ID.md @@ -11,7 +11,3 @@ 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 index ab9b47c..34d4c7a 100644 --- a/docs/@ceramic-sdk/model-protocol/variables/ModelAccountRelation.md +++ b/docs/@ceramic-sdk/model-protocol/variables/ModelAccountRelation.md @@ -12,7 +12,3 @@ Represents the relationship between an instance of this model and the controller '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 index b96cdef..049eb41 100644 --- a/docs/@ceramic-sdk/model-protocol/variables/ModelAccountRelationV2.md +++ b/docs/@ceramic-sdk/model-protocol/variables/ModelAccountRelationV2.md @@ -14,7 +14,3 @@ Represents the relationship between an instance of this model and the controller 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 index df207f6..841bd59 100644 --- a/docs/@ceramic-sdk/model-protocol/variables/ModelDefinition.md +++ b/docs/@ceramic-sdk/model-protocol/variables/ModelDefinition.md @@ -9,7 +9,3 @@ > `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 index c36bd47..09e89e5 100644 --- a/docs/@ceramic-sdk/model-protocol/variables/ModelDefinitionV1.md +++ b/docs/@ceramic-sdk/model-protocol/variables/ModelDefinitionV1.md @@ -37,7 +37,3 @@ ### 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 index 8b60b55..4d346f7 100644 --- a/docs/@ceramic-sdk/model-protocol/variables/ModelDefinitionV2.md +++ b/docs/@ceramic-sdk/model-protocol/variables/ModelDefinitionV2.md @@ -49,7 +49,3 @@ ### 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 index bb3bff0..045245d 100644 --- a/docs/@ceramic-sdk/model-protocol/variables/ModelDocumentMetadataViewDefinition.md +++ b/docs/@ceramic-sdk/model-protocol/variables/ModelDocumentMetadataViewDefinition.md @@ -7,7 +7,3 @@ # 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 index 19bb50b..3e127cd 100644 --- a/docs/@ceramic-sdk/model-protocol/variables/ModelEvent.md +++ b/docs/@ceramic-sdk/model-protocol/variables/ModelEvent.md @@ -9,7 +9,3 @@ > `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 index a860475..734fd86 100644 --- a/docs/@ceramic-sdk/model-protocol/variables/ModelEventHeader.md +++ b/docs/@ceramic-sdk/model-protocol/variables/ModelEventHeader.md @@ -9,7 +9,3 @@ > `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 index 6d0ce0d..a0a16ca 100644 --- a/docs/@ceramic-sdk/model-protocol/variables/ModelInitEventPayload.md +++ b/docs/@ceramic-sdk/model-protocol/variables/ModelInitEventPayload.md @@ -9,7 +9,3 @@ > `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 index f312da4..5690e85 100644 --- a/docs/@ceramic-sdk/model-protocol/variables/ModelMetadata.md +++ b/docs/@ceramic-sdk/model-protocol/variables/ModelMetadata.md @@ -9,7 +9,3 @@ > `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 index 2e2061f..f24796d 100644 --- a/docs/@ceramic-sdk/model-protocol/variables/ModelRelationDefinition.md +++ b/docs/@ceramic-sdk/model-protocol/variables/ModelRelationDefinition.md @@ -13,7 +13,3 @@ Identifies types of properties that are supported as relations by the indexing s 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 index 14c431e..68b8dbe 100644 --- a/docs/@ceramic-sdk/model-protocol/variables/ModelRelationDefinitionV2.md +++ b/docs/@ceramic-sdk/model-protocol/variables/ModelRelationDefinitionV2.md @@ -13,7 +13,3 @@ Identifies types of properties that are supported as relations by the indexing s 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 index 2af6dc3..4b74c97 100644 --- a/docs/@ceramic-sdk/model-protocol/variables/ModelRelationViewDefinition.md +++ b/docs/@ceramic-sdk/model-protocol/variables/ModelRelationViewDefinition.md @@ -7,7 +7,3 @@ # 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 index ce2c088..dfc1eaf 100644 --- a/docs/@ceramic-sdk/model-protocol/variables/ModelRelationViewDefinitionV2.md +++ b/docs/@ceramic-sdk/model-protocol/variables/ModelRelationViewDefinitionV2.md @@ -7,7 +7,3 @@ # 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 index bb59203..354f5ea 100644 --- a/docs/@ceramic-sdk/model-protocol/variables/ModelRelationsDefinition.md +++ b/docs/@ceramic-sdk/model-protocol/variables/ModelRelationsDefinition.md @@ -11,7 +11,3 @@ 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 index 8af5d6e..f09b5db 100644 --- a/docs/@ceramic-sdk/model-protocol/variables/ModelRelationsDefinitionV2.md +++ b/docs/@ceramic-sdk/model-protocol/variables/ModelRelationsDefinitionV2.md @@ -7,7 +7,3 @@ # 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 index be823a8..d43a11a 100644 --- a/docs/@ceramic-sdk/model-protocol/variables/ModelViewDefinition.md +++ b/docs/@ceramic-sdk/model-protocol/variables/ModelViewDefinition.md @@ -18,7 +18,3 @@ Currently supported types of view properties: - '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 index 6595dd3..b40d93a 100644 --- a/docs/@ceramic-sdk/model-protocol/variables/ModelViewDefinitionV2.md +++ b/docs/@ceramic-sdk/model-protocol/variables/ModelViewDefinitionV2.md @@ -19,7 +19,3 @@ Currently supported types of view properties: - '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 index aa98670..845c0a6 100644 --- a/docs/@ceramic-sdk/model-protocol/variables/ModelViewsDefinition.md +++ b/docs/@ceramic-sdk/model-protocol/variables/ModelViewsDefinition.md @@ -11,7 +11,3 @@ 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 index 26cf94f..f16cd19 100644 --- a/docs/@ceramic-sdk/model-protocol/variables/ModelViewsDefinitionV2.md +++ b/docs/@ceramic-sdk/model-protocol/variables/ModelViewsDefinitionV2.md @@ -11,7 +11,3 @@ 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 index 8144b56..f637609 100644 --- a/docs/@ceramic-sdk/model-protocol/variables/ObjectSchema.md +++ b/docs/@ceramic-sdk/model-protocol/variables/ObjectSchema.md @@ -7,7 +7,3 @@ # 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 index 638258f..f3c6a82 100644 --- a/docs/@ceramic-sdk/model-protocol/variables/optionalModelString.md +++ b/docs/@ceramic-sdk/model-protocol/variables/optionalModelString.md @@ -7,7 +7,3 @@ # 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/@ceramic-sdk/stream-client/README.md b/docs/@ceramic-sdk/stream-client/README.md new file mode 100644 index 0000000..ae5999b --- /dev/null +++ b/docs/@ceramic-sdk/stream-client/README.md @@ -0,0 +1,15 @@ +**@ceramic-sdk/stream-client v0.1.0** • **Docs** + +*** + +[Ceramic SDK](../../README.md) / @ceramic-sdk/stream-client + +# @ceramic-sdk/stream-client + +## Classes + +- [StreamClient](classes/StreamClient.md) + +## Type Aliases + +- [StreamClientParams](type-aliases/StreamClientParams.md) diff --git a/docs/@ceramic-sdk/stream-client/classes/StreamClient.md b/docs/@ceramic-sdk/stream-client/classes/StreamClient.md new file mode 100644 index 0000000..abc8d66 --- /dev/null +++ b/docs/@ceramic-sdk/stream-client/classes/StreamClient.md @@ -0,0 +1,53 @@ +[**@ceramic-sdk/stream-client v0.1.0**](../README.md) • **Docs** + +*** + +[Ceramic SDK](../../../README.md) / [@ceramic-sdk/stream-client](../README.md) / StreamClient + +# Class: StreamClient + +## Extended by + +## Constructors + +### new StreamClient() + +> **new StreamClient**(`params`): [`StreamClient`](StreamClient.md) + +#### Parameters + +• **params**: [`StreamClientParams`](../type-aliases/StreamClientParams.md) + +#### Returns + +[`StreamClient`](StreamClient.md) + +## Accessors + +### ceramic + +> `get` **ceramic**(): [`CeramicClient`](../../http-client/classes/CeramicClient.md) + +Ceramic HTTP client instance used to interact with Ceramic One server + +#### Returns + +[`CeramicClient`](../../http-client/classes/CeramicClient.md) + +#### Defined in + +## Methods + +### getDID() + +> **getDID**(`provided`?): `DID` + +Utility method used to access the provided DID or the one attached to the instance, throws if neither is provided + +#### Parameters + +• **provided?**: `DID` + +#### Returns + +`DID` diff --git a/docs/@ceramic-sdk/stream-client/type-aliases/StreamClientParams.md b/docs/@ceramic-sdk/stream-client/type-aliases/StreamClientParams.md new file mode 100644 index 0000000..6532192 --- /dev/null +++ b/docs/@ceramic-sdk/stream-client/type-aliases/StreamClientParams.md @@ -0,0 +1,23 @@ +[**@ceramic-sdk/stream-client v0.1.0**](../README.md) • **Docs** + +*** + +[Ceramic SDK](../../../README.md) / [@ceramic-sdk/stream-client](../README.md) / StreamClientParams + +# Type Alias: StreamClientParams + +> **StreamClientParams**: `object` + +## Type declaration + +### ceramic + +> **ceramic**: [`CeramicClient`](../../http-client/classes/CeramicClient.md) \| `string` + +Ceramic HTTP client instance or Ceramic One server URL + +### did? + +> `optional` **did**: `DID` + +DID to use by default in method calls diff --git a/docs/README.md b/docs/README.md index 1db6576..34aca53 100644 --- a/docs/README.md +++ b/docs/README.md @@ -13,3 +13,4 @@ - [@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) +- [@ceramic-sdk/stream-client - v0.1.0](@ceramic-sdk/stream-client/README.md) diff --git a/packages/model-client/src/index.ts b/packages/model-client/src/index.ts index afe69aa..e958549 100644 --- a/packages/model-client/src/index.ts +++ b/packages/model-client/src/index.ts @@ -36,12 +36,14 @@ export async function createInitEvent( } export class ModelClient extends StreamClient { + /** Get the signed init event of a Model based on its stream ID */ async getInitEvent(streamID: StreamID | string): Promise { const id = typeof streamID === 'string' ? StreamID.fromString(streamID) : streamID return await this.ceramic.getEventType(SignedEvent, id.cid.toString()) } + /** Get the init event payload of a Model based on its stream ID */ async getPayload( streamID: StreamID | string, verifier?: DID, @@ -55,6 +57,7 @@ export class ModelClient extends StreamClient { return container.payload } + /** Post a Model definition and return its stream ID */ async postDefinition( definition: ModelDefinition, signer?: DID, diff --git a/packages/model-instance-client/src/client.ts b/packages/model-instance-client/src/client.ts index 3b8b7b9..3d2172b 100644 --- a/packages/model-instance-client/src/client.ts +++ b/packages/model-instance-client/src/client.ts @@ -36,6 +36,7 @@ export type PostDataParams = Omit< } export class DocumentClient extends StreamClient { + /** Get a DocumentEvent based on its commit ID */ async getEvent(commitID: CommitID | string): Promise { const id = typeof commitID === 'string' ? CommitID.fromString(commitID) : commitID @@ -45,6 +46,7 @@ export class DocumentClient extends StreamClient { )) as DocumentEvent } + /** Post a deterministic init event and return its commit ID */ async postDeterministicInit( params: PostDeterministicInitParams, ): Promise { @@ -57,6 +59,7 @@ export class DocumentClient extends StreamClient { return CommitID.fromStream(getStreamID(cid)) } + /** Post a signed (non-deterministic) init event and return its commit ID */ async postSignedInit( params: PostSignedInitParams, ): Promise { @@ -69,6 +72,7 @@ export class DocumentClient extends StreamClient { return CommitID.fromStream(getStreamID(cid)) } + /** Post a data event and return its commit ID */ async postData( params: PostDataParams, ): Promise { diff --git a/packages/stream-client/README.md b/packages/stream-client/README.md index cf5134d..97bf043 100644 --- a/packages/stream-client/README.md +++ b/packages/stream-client/README.md @@ -1,5 +1,15 @@ # Ceramic generic stream client +## Installation + +```sh +npm install @ceramic-sdk/stream-client +``` + +## Documentation + +[API reference](https://github.com/ceramicstudio/ceramic-sdk/tree/main/docs/@ceramic-sdk/stream-client) + ## License Dual licensed under MIT and Apache 2 diff --git a/packages/stream-client/src/index.ts b/packages/stream-client/src/index.ts index 7d46cbf..1832fac 100644 --- a/packages/stream-client/src/index.ts +++ b/packages/stream-client/src/index.ts @@ -2,7 +2,9 @@ import { type CeramicClient, getCeramicClient } from '@ceramic-sdk/http-client' import type { DID } from 'dids' export type StreamClientParams = { + /** Ceramic HTTP client instance or Ceramic One server URL */ ceramic: CeramicClient | string + /** DID to use by default in method calls */ did?: DID } @@ -15,10 +17,12 @@ export class StreamClient { this.#did = params.did } + /** Ceramic HTTP client instance used to interact with Ceramic One server */ get ceramic(): CeramicClient { return this.#ceramic } + /** Utility method used to access the provided DID or the one attached to the instance, throws if neither is provided */ getDID(provided?: DID): DID { if (provided != null) { return provided diff --git a/typedoc.json b/typedoc.json index 7e411d6..c18367c 100644 --- a/typedoc.json +++ b/typedoc.json @@ -8,10 +8,12 @@ "packages/model-client", "packages/model-instance-client", "packages/model-instance-protocol", - "packages/model-protocol" + "packages/model-protocol", + "packages/stream-client" ], "name": "Ceramic SDK", "packageOptions": { + "disableSources": true, "entryPoints": ["src/index.ts"], "excludeExternals": true, "excludeInternal": true, From 8d9d0a825454dd77aaaa3f596058bad1bf0c0bfb Mon Sep 17 00:00:00 2001 From: Paul Le Cam Date: Thu, 26 Sep 2024 12:21:26 +0100 Subject: [PATCH 6/7] Use C1 v0.37.0 --- .github/workflows/integration-test.yml | 2 +- tests/c1-integration/package.json | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/workflows/integration-test.yml b/.github/workflows/integration-test.yml index 7684e65..8de40a5 100644 --- a/.github/workflows/integration-test.yml +++ b/.github/workflows/integration-test.yml @@ -6,7 +6,7 @@ on: env: C1_REGISTRY: "public.ecr.aws/r5b3e0r5/3box/ceramic-one" - C1_VERSION: "0.35.0" + C1_VERSION: "0.37.0" CI: true jobs: diff --git a/tests/c1-integration/package.json b/tests/c1-integration/package.json index 3cd9c6c..ca06f80 100644 --- a/tests/c1-integration/package.json +++ b/tests/c1-integration/package.json @@ -13,7 +13,7 @@ "sideEffects": false, "scripts": { "lint": "eslint src --fix", - "test": "C1_VERSION=0.35.0 node --experimental-vm-modules ../../node_modules/jest/bin/jest.js" + "test": "node --experimental-vm-modules ../../node_modules/jest/bin/jest.js" }, "dependencies": { "@ceramic-sdk/events": "workspace:^", From 132097f4585090d2ce30f3745be5f3c10eac4f6c Mon Sep 17 00:00:00 2001 From: Paul Le Cam Date: Thu, 26 Sep 2024 13:11:12 +0100 Subject: [PATCH 7/7] Add stream-client package to readme --- README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/README.md b/README.md index cba8b1f..9720c5e 100644 --- a/README.md +++ b/README.md @@ -13,6 +13,7 @@ TypeScript client and utilities for [Ceramic One](https://github.com/ceramicnetw | [model-client](./packages/model-client) | Model streams client | ![npm version](https://img.shields.io/npm/v/@ceramic-sdk/model-client.svg) | | [model-instance-protocol](./packages/model-instance-protocol) | ModelInstanceDocument streams protocol | ![npm version](https://img.shields.io/npm/v/@ceramic-sdk/model-instance-protocol.svg) | | [model-instance-client](./packages/model-instance-client) | ModelInstanceDocument streams client | ![npm version](https://img.shields.io/npm/v/@ceramic-sdk/model-instance-client.svg) | +| [stream-client](./packages/stream-client) | Generic streams client | ![npm version](https://img.shields.io/npm/v/@ceramic-sdk/stream-client.svg) | Other packages present in the `packages` folder are for internal use and may not be published to the npm registry.