Docs restructure update (#172)

* docs restructure update * Update the links in README.md * link updates
ceramicnetwork · Nov 22, 2023 · 9ce83ef · 9ce83ef
1 parent 4d57ee8
commit 9ce83ef
Show file tree

Hide file tree

Showing 24 changed files with 765 additions and 585 deletions.
diff --git a/README.md b/README.md
@@ -19,8 +19,8 @@ This monorepo uses [pnpm](https://pnpm.io/), make sure to install it first if yo
 
 | Name                                            | Description                                                                                               | Version                                                                      |
 | ----------------------------------------------- | --------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------- |
-| [`dids`](./packages/dids)                       | [Interact with DIDs](https://developers.ceramic.network/reference/core-clients/did-jsonrpc/)                         | ![npm version](https://img.shields.io/npm/v/dids.svg)             |
-| [`did-session`](./packages/did-session)         | [Manages user DID in web based environments](https://developers.ceramic.network/reference/accounts/did-session/)   | ![npm version](https://img.shields.io/npm/v/did-session.svg)        |
+| [`dids`](./packages/dids)                       | [Interact with DIDs](https://developers.ceramic.network/docs/dids/guides/using-with-composedb-client)                         | ![npm version](https://img.shields.io/npm/v/dids.svg)             |
+| [`did-session`](./packages/did-session)         | [Manages user DID in web based environments](https://did.js.org/docs/api/modules/did_session)   | ![npm version](https://img.shields.io/npm/v/did-session.svg)        |
 | [`@didtools/cacao`](./packages/cacao)           | Chain-Agnostic Object Capabilities                     | ![npm version](https://img.shields.io/npm/v/@didtools/cacao.svg)         |
 | [`@didtools/pkh-ethereum`](./packages/pkh-ethereum) | DID PKH Ethereum                                   | ![npm version](https://img.shields.io/npm/v/@didtools/pkh-ethereum.svg)  |
 | [`@didtools/pkh-solana`](./packages/pkh-solana)     | DID PKH Solana                                     | ![npm version](https://img.shields.io/npm/v/@didtools/pkh-solana.svg)    |
@@ -39,4 +39,4 @@ Check out the [Development](./DEVELOPMENT.md) section to learn more and for the
 
 ## License
 
-Dual licensed under [MIT](LICENSE-MIT) and [Apache 2](LICENSE-APACHE)
+Dual licensed under [MIT](LICENSE-MIT) and [Apache 2](LICENSE-APACHE)
diff --git a/website/docs/api/classes/did_session.DIDSession.md b/website/docs/api/classes/did_session.DIDSession.md
@@ -175,6 +175,45 @@ Initialize a session from a serialized session string
 
 ___
 
+### get
+
+▸ `Static` **get**(`account`, `authMethod`, `authOpts?`): `Promise`<[`DIDSession`](did_session.DIDSession.md)\>
+
+Get a session for the given accountId, if one exists, otherwise creates a new one.
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `account` | `AccountId` |
+| `authMethod` | `AuthMethod` |
+| `authOpts` | `AuthOpts` |
+
+#### Returns
+
+`Promise`<[`DIDSession`](did_session.DIDSession.md)\>
+
+___
+
+### hasSessionFor
+
+▸ `Static` **hasSessionFor**(`account`, `resources`): `Promise`<`boolean`\>
+
+Check if there is an active session for a given account.
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `account` | `AccountId` |
+| `resources` | `string`[] |
+
+#### Returns
+
+`Promise`<`boolean`\>
+
+___
+
 ### initDID
 
 ▸ `Static` **initDID**(`didKey`, `cacao`): `Promise`<`DID`\>

diff --git a/website/docs/api/classes/didtools_key_webcrypto.WebcryptoProvider.md b/website/docs/api/classes/didtools_key_webcrypto.WebcryptoProvider.md
@@ -0,0 +1,65 @@
+---
+id: "didtools_key_webcrypto.WebcryptoProvider"
+title: "Class: WebcryptoProvider"
+custom_edit_url: null
+---
+
+[@didtools/key-webcrypto](../modules/didtools_key_webcrypto.md).WebcryptoProvider
+
+## Implements
+
+- `DIDProvider`
+
+## Constructors
+
+### constructor
+
+• **new WebcryptoProvider**(`keyPair`)
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `keyPair` | `CryptoKeyPair` |
+
+## Properties
+
+### \_handle
+
+• **\_handle**: `SendRequestFunc`<`DIDProviderMethods`\>
+
+## Accessors
+
+### isDidProvider
+
+• `get` **isDidProvider**(): `boolean`
+
+#### Returns
+
+`boolean`
+
+## Methods
+
+### send
+
+▸ **send**<`Name`\>(`msg`): `Promise`<``null`` \| `RPCResponse`<`DIDProviderMethods`, `Name`\>\>
+
+#### Type parameters
+
+| Name | Type |
+| :------ | :------ |
+| `Name` | extends keyof `DIDProviderMethods` |
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `msg` | `RPCRequest`<`DIDProviderMethods`, `Name`\> |
+
+#### Returns
+
+`Promise`<``null`` \| `RPCResponse`<`DIDProviderMethods`, `Name`\>\>
+
+#### Implementation of
+
+DIDProvider.send
diff --git a/website/docs/api/classes/siwx_src.SignedSiwxMessage.md b/website/docs/api/classes/siwx_src.SignedSiwxMessage.md
@@ -0,0 +1,44 @@
+---
+id: "siwx_src.SignedSiwxMessage"
+title: "Class: SignedSiwxMessage"
+custom_edit_url: null
+---
+
+[siwx/src](../modules/siwx_src.md).SignedSiwxMessage
+
+## Implements
+
+- [`ISignedSiwxMessage`](../interfaces/siwx_src.ISignedSiwxMessage.md)
+
+## Constructors
+
+### constructor
+
+• **new SignedSiwxMessage**(`message`, `signature`)
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `message` | [`SiwxMessage`](siwx_src.SiwxMessage.md) |
+| `signature` | [`Signature`](../modules/siwx_src.md#signature) |
+
+## Properties
+
+### message
+
+• `Readonly` **message**: [`SiwxMessage`](siwx_src.SiwxMessage.md)
+
+#### Implementation of
+
+[ISignedSiwxMessage](../interfaces/siwx_src.ISignedSiwxMessage.md).[message](../interfaces/siwx_src.ISignedSiwxMessage.md#message)
+
+___
+
+### signature
+
+• `Readonly` **signature**: [`Signature`](../modules/siwx_src.md#signature)
+
+#### Implementation of
+
+[ISignedSiwxMessage](../interfaces/siwx_src.ISignedSiwxMessage.md).[signature](../interfaces/siwx_src.ISignedSiwxMessage.md#signature)
diff --git a/website/docs/api/classes/siwx_src.SiwxMessage.md b/website/docs/api/classes/siwx_src.SiwxMessage.md
@@ -0,0 +1,213 @@
+---
+id: "siwx_src.SiwxMessage"
+title: "Class: SiwxMessage"
+custom_edit_url: null
+---
+
+[siwx/src](../modules/siwx_src.md).SiwxMessage
+
+Parameters for SiwxMessage constructor.
+
+## Implements
+
+- [`SiwxMessageFields`](../interfaces/siwx_src.SiwxMessageFields.md)
+
+## Constructors
+
+### constructor
+
+• **new SiwxMessage**(`fields`)
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `fields` | [`SiwxMessageFields`](../interfaces/siwx_src.SiwxMessageFields.md) |
+
+## Properties
+
+### address
+
+• `Readonly` **address**: `string` & `WithOpaque`<``"address"``\>
+
+#### Implementation of
+
+[SiwxMessageFields](../interfaces/siwx_src.SiwxMessageFields.md).[address](../interfaces/siwx_src.SiwxMessageFields.md#address)
+
+___
+
+### chainId
+
+• `Readonly` **chainId**: `string` & `WithOpaque`<``"chain-id"``\>
+
+#### Implementation of
+
+[SiwxMessageFields](../interfaces/siwx_src.SiwxMessageFields.md).[chainId](../interfaces/siwx_src.SiwxMessageFields.md#chainid)
+
+___
+
+### domain
+
+• `Readonly` **domain**: `string` & `WithOpaque`<``"domain"``\>
+
+#### Implementation of
+
+[SiwxMessageFields](../interfaces/siwx_src.SiwxMessageFields.md).[domain](../interfaces/siwx_src.SiwxMessageFields.md#domain)
+
+___
+
+### expirationTime
+
+• `Optional` `Readonly` **expirationTime**: `string` & `WithOpaque`<``"date-time"``\>
+
+#### Implementation of
+
+[SiwxMessageFields](../interfaces/siwx_src.SiwxMessageFields.md).[expirationTime](../interfaces/siwx_src.SiwxMessageFields.md#expirationtime)
+
+___
+
+### issuedAt
+
+• `Readonly` **issuedAt**: `string` & `WithOpaque`<``"date-time"``\>
+
+#### Implementation of
+
+[SiwxMessageFields](../interfaces/siwx_src.SiwxMessageFields.md).[issuedAt](../interfaces/siwx_src.SiwxMessageFields.md#issuedat)
+
+___
+
+### network
+
+• `Readonly` **network**: `string` & `WithOpaque`<``"network"``\>
+
+#### Implementation of
+
+[SiwxMessageFields](../interfaces/siwx_src.SiwxMessageFields.md).[network](../interfaces/siwx_src.SiwxMessageFields.md#network)
+
+___
+
+### nonce
+
+• `Readonly` **nonce**: `string` & `WithOpaque`<``"nonce"``\>
+
+#### Implementation of
+
+[SiwxMessageFields](../interfaces/siwx_src.SiwxMessageFields.md).[nonce](../interfaces/siwx_src.SiwxMessageFields.md#nonce)
+
+___
+
+### notBefore
+
+• `Optional` `Readonly` **notBefore**: `string` & `WithOpaque`<``"date-time"``\>
+
+#### Implementation of
+
+[SiwxMessageFields](../interfaces/siwx_src.SiwxMessageFields.md).[notBefore](../interfaces/siwx_src.SiwxMessageFields.md#notbefore)
+
+___
+
+### requestId
+
+• `Optional` `Readonly` **requestId**: `string` & `WithOpaque`<``"non-empty"``\>
+
+#### Implementation of
+
+[SiwxMessageFields](../interfaces/siwx_src.SiwxMessageFields.md).[requestId](../interfaces/siwx_src.SiwxMessageFields.md#requestid)
+
+___
+
+### resources
+
+• `Optional` `Readonly` **resources**: `string` & `WithOpaque`<``"URI"``\>[]
+
+#### Implementation of
+
+[SiwxMessageFields](../interfaces/siwx_src.SiwxMessageFields.md).[resources](../interfaces/siwx_src.SiwxMessageFields.md#resources)
+
+___
+
+### statement
+
+• `Optional` `Readonly` **statement**: `string` & `WithOpaque`<``"non-empty"``\>
+
+#### Implementation of
+
+[SiwxMessageFields](../interfaces/siwx_src.SiwxMessageFields.md).[statement](../interfaces/siwx_src.SiwxMessageFields.md#statement)
+
+___
+
+### uri
+
+• `Readonly` **uri**: `string` & `WithOpaque`<``"URI"``\>
+
+#### Implementation of
+
+[SiwxMessageFields](../interfaces/siwx_src.SiwxMessageFields.md).[uri](../interfaces/siwx_src.SiwxMessageFields.md#uri)
+
+___
+
+### version
+
+• `Readonly` **version**: ``"1"`` & `WithOpaque`<``"version"``\>
+
+#### Implementation of
+
+[SiwxMessageFields](../interfaces/siwx_src.SiwxMessageFields.md).[version](../interfaces/siwx_src.SiwxMessageFields.md#version)
+
+___
+
+### fromString
+
+▪ `Static` **fromString**: (`input`: `string`) => [`SiwxMessage`](siwx_src.SiwxMessage.md) = `fromString`
+
+#### Type declaration
+
+▸ (`input`): [`SiwxMessage`](siwx_src.SiwxMessage.md)
+
+Parse SIWx message string.
+
+**`Throws`**
+
+If invalid string passed.
+
+##### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `input` | `string` |
+
+##### Returns
+
+[`SiwxMessage`](siwx_src.SiwxMessage.md)
+
+___
+
+### fromStringSafe
+
+▪ `Static` **fromStringSafe**: (`input`: `string`) => `Maybe`<[`SiwxMessage`](siwx_src.SiwxMessage.md)\> = `fromStringSafe`
+
+#### Type declaration
+
+▸ (`input`): `Maybe`<[`SiwxMessage`](siwx_src.SiwxMessage.md)\>
+
+Parse SIWx message string. Return `Maybe`, thus do not throw.
+
+##### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `input` | `string` |
+
+##### Returns
+
+`Maybe`<[`SiwxMessage`](siwx_src.SiwxMessage.md)\>
+
+## Methods
+
+### toString
+
+▸ **toString**(): `string`
+
+#### Returns
+
+`string`