Jackson Morgan 5 months ago
parent db87958cb6
commit 425f19e402
  1. 32
      packages/connected-nextgraph/README.md
  2. 34
      packages/connected-solid/README.md
  3. 1
      packages/connected-solid/typedoc.json
  4. 44
      packages/connected/README.md

@ -30,9 +30,9 @@ import ng from "nextgraph";
// Open your nextgraph wallet
const openedWallet = await ng.wallet_open_with_mnemonic_words(
wallet.wallet,
walletBinary,
mnemonic,
[1, 2, 1, 2]
[1, 2, 3, 4]
);
// Start a session
@ -118,28 +118,28 @@ await resource.update({
SolidLdoDataset
- [createSolidLdoDataset](https://ldo.js.org/latest/api/solid/functions/createSolidLdoDataset/)
- [SolidLdoDataset](https://ldo.js.org/latest/api/solid/classes/SolidLdoDataset/)
- [createSolidLdoDataset](https://ldo.js.org/latest/api/connected/functions/createSolidLdoDataset/)
- [SolidLdoDataset](https://ldo.js.org/latest/api/connected/classes/SolidLdoDataset/)
Resources (Manage batching requests)
- [LeafUri](https://ldo.js.org/latest/api/solid/types/LeafUri/)
- [ContainerUri](https://ldo.js.org/latest/api/solid/types/ContainerUri/)
- [Leaf](https://ldo.js.org/latest/api/solid/classes/Leaf/)
- [Container](https://ldo.js.org/latest/api/solid/classes/Container/)
- [LeafUri](https://ldo.js.org/latest/api/connected/types/LeafUri/)
- [ContainerUri](https://ldo.js.org/latest/api/connected/types/ContainerUri/)
- [Leaf](https://ldo.js.org/latest/api/connected/classes/Leaf/)
- [Container](https://ldo.js.org/latest/api/connected/classes/Container/)
Standalone Functions
- [checkRootContainter](https://ldo.js.org/latest/api/solid/functions/checkRootContainer/)
- [createDataResource](https://ldo.js.org/latest/api/solid/functions/createDataResource/)
- [deleteResource](https://ldo.js.org/latest/api/solid/functions/deleteResource/)
- [readResource](https://ldo.js.org/latest/api/solid/functions/readResource/)
- [updateResource](https://ldo.js.org/latest/api/solid/functions/updateResource/)
- [uploadResource](https://ldo.js.org/latest/api/solid/functions/uploadResource/)
- [checkRootContainter](https://ldo.js.org/latest/api/connected/functions/checkRootContainer/)
- [createDataResource](https://ldo.js.org/latest/api/connected/functions/createDataResource/)
- [deleteResource](https://ldo.js.org/latest/api/connected/functions/deleteResource/)
- [readResource](https://ldo.js.org/latest/api/connected/functions/readResource/)
- [updateResource](https://ldo.js.org/latest/api/connected/functions/updateResource/)
- [uploadResource](https://ldo.js.org/latest/api/connected/functions/uploadResource/)
Data Functions
- [changeData](https://ldo.js.org/latest/api/solid/functions/changeData/)
- [commitData](https://ldo.js.org/latest/api/solid/functions/commitData/)
- [changeData](https://ldo.js.org/latest/api/connected/functions/changeData/)
- [commitData](https://ldo.js.org/latest/api/connected/functions/commitData/)
## Sponsorship
This project was made possible by a grant from NGI Zero Entrust via nlnet. Learn more on the [NLnet project page](https://nlnet.nl/project/SolidUsableApps/).

@ -1,4 +1,4 @@
# @ldo/solid
# @ldo/connected-solid
@ldo/solid is a client that implements the Solid specification with the use of Linked Data Objects.
@ -10,10 +10,10 @@ cd my_project/
npx run @ldo/cli init
```
Now install the @ldo/solid library
Now install the @ldo/connected-solid library
```
npm i @ldo/solid
npm i @ldo/connected-solid
```
<details>
@ -33,7 +33,8 @@ npm i @ldo/ldo @ldo/solid
Below is a simple example of @ldo/solid. Assume that a ShapeType was previously generated and placed at `./.ldo/foafProfile.shapeTypes`. Also assume we have a shape type for social media at `./.ldo/socialMediaPost.shapeTypes`
```typescript
import { changeData, commitData, createSolidLdoDataset } from "@ldo/solid";
import { changeData, commitData } from "@ldo/connected";
import { createSolidLdoDataset } from "@ldo/solid";
import { fetch, getDefaultSession } from "@inrupt/solid-client-authn-browser";
import { FoafProfileShapeType } from "./.ldo/foafProfile.shapeTypes";
import { SocialMediaPostShapeType } from "./.ldo/socialMediaPost.shapeTypes";
@ -53,7 +54,8 @@ async function main() {
// SolidLdoDataset. You can think of this dataset as a local store for all the
// information in the Solidverse. Don't forget to pass the authenticated fetch
// function to do your queries!
const solidLdoDataset = createSolidLdoDataset({ fetch });
const solidLdoDataset = createSolidLdoDataset();
solidLdoDataset.setContext({ fetch });
// We'll start with getting a representation of our WebId's resource
const webIdResource = solidLdoDataset.getResource(webIdUri);
@ -206,27 +208,15 @@ main();
SolidLdoDataset
- [createSolidLdoDataset](https://ldo.js.org/latest/api/solid/functions/createSolidLdoDataset/)
- [SolidLdoDataset](https://ldo.js.org/latest/api/solid/classes/SolidLdoDataset/)
Resources (Manage batching requests)
- [LeafUri](https://ldo.js.org/latest/api/solid/types/LeafUri/)
- [ContainerUri](https://ldo.js.org/latest/api/solid/types/ContainerUri/)
- [Leaf](https://ldo.js.org/latest/api/solid/classes/Leaf/)
- [Container](https://ldo.js.org/latest/api/solid/classes/Container/)
- [SolidResource](https://ldo.js.org/latest/api/classes/SolidResource/)
- [SolidLeafUri](https://ldo.js.org/latest/api/solid/types/SolidLeafUri/)
- [SolidContainerUri](https://ldo.js.org/latest/api/solid/types/SolidContainerUri/)
- [SolidLeaf](https://ldo.js.org/latest/api/solid/classes/SolidLeaf/)
- [SolidContainer](https://ldo.js.org/latest/api/solid/classes/SolidContainer/)
Standalone Functions
- [checkRootContainter](https://ldo.js.org/latest/api/solid/functions/checkRootContainer/)
- [createDataResource](https://ldo.js.org/latest/api/solid/functions/createDataResource/)
- [deleteResource](https://ldo.js.org/latest/api/solid/functions/deleteResource/)
- [readResource](https://ldo.js.org/latest/api/solid/functions/readResource/)
- [updateResource](https://ldo.js.org/latest/api/solid/functions/updateResource/)
- [uploadResource](https://ldo.js.org/latest/api/solid/functions/uploadResource/)
Data Functions
- [changeData](https://ldo.js.org/latest/api/solid/functions/changeData/)
- [commitData](https://ldo.js.org/latest/api/solid/functions/commitData/)
## Sponsorship
This project was made possible by a grant from NGI Zero Entrust via nlnet. Learn more on the [NLnet project page](https://nlnet.nl/project/SolidUsableApps/).

@ -1,6 +1,7 @@
{
"entryPoints": ["src/index.ts"],
"out": "docs",
"tsconfig": "tsconfig.build.json",
"allReflectionsHaveOwnDocument": true,
"hideInPageTOC": true,
"hideBreadcrumbs": true,

@ -231,18 +231,18 @@ main();
ConnectedLdoDataset
- [createConnectedLdoDataset](https://ldo.js.org/latest/api/connected/functions/createConnectedLdoDataset.md)
- [ConnectedLdoDataset](https://ldo.js.org/latest/api/connected/classes/ConnectedLdoDataset.md)
- [ConnectedLdoTransactionDataset](https://ldo.js.org/latest/api/connected/classes/ConnectedLdoTransactionDataset.md)
- [IConnectedLdoDataset](https://ldo.js.org/latest/api/connected/interfaces/IConnectedLdoDataset.md)
- [createConnectedLdoDataset](https://ldo.js.org/latest/api/connected/functions/createConnectedLdoDataset/)
- [ConnectedLdoDataset](https://ldo.js.org/latest/api/connected/classes/ConnectedLdoDataset/)
- [ConnectedLdoTransactionDataset](https://ldo.js.org/latest/api/connected/classes/ConnectedLdoTransactionDataset/)
- [IConnectedLdoDataset](https://ldo.js.org/latest/api/connected/interfaces/IConnectedLdoDataset/)
ConnectedPlugins
- [ConnectedPlugin](https://ldo.js.org/latest/api/connected/interfaces/ConnectedPlugin.md)
- [ConnectedPlugin](https://ldo.js.org/latest/api/connected/interfaces/ConnectedPlugin/)
Resources (Manage batching requests)
- [Resource](https://ldo.js.org/latest/api/connected/interfaces/Resource.md)
- [Resource](https://ldo.js.org/latest/api/connected/interfaces/Resource/)
Data Functions
@ -251,25 +251,25 @@ Data Functions
SuccessResult
- [SuccessResult](https://ldo.js.org/latest/api/connected/classes/SuccessResult.md)
- [AbsentReadSuccess](https://ldo.js.org/latest/api/connected/classes/AbsentReadSuccess.md)
- [AggregateSuccess](https://ldo.js.org/latest/api/connected/classes/AggregateSuccess.md)
- [IgnoredInvalidUpdateSuccess](https://ldo.js.org/latest/api/connected/classes/IgnoredInvalidUpdateSuccess.md)
- [ReadSuccess](https://ldo.js.org/latest/api/connected/classes/ReadSuccess.md)
- [ResourceSuccess](https://ldo.js.org/latest/api/connected/classes/ResourceSuccess.md)
- [Unfetched](https://ldo.js.org/latest/api/connected/classes/Unfetched.md)
- [UpdateDefaultGraphSuccess](https://ldo.js.org/latest/api/connected/classes/UpdateDefaultGraphSuccess.md)
- [UpdateSuccess](https://ldo.js.org/latest/api/connected/classes/UpdateSuccess.md
- [SuccessResult](https://ldo.js.org/latest/api/connected/classes/SuccessResult/)
- [AbsentReadSuccess](https://ldo.js.org/latest/api/connected/classes/AbsentReadSuccess/)
- [AggregateSuccess](https://ldo.js.org/latest/api/connected/classes/AggregateSuccess/)
- [IgnoredInvalidUpdateSuccess](https://ldo.js.org/latest/api/connected/classes/IgnoredInvalidUpdateSuccess/)
- [ReadSuccess](https://ldo.js.org/latest/api/connected/classes/ReadSuccess/)
- [ResourceSuccess](https://ldo.js.org/latest/api/connected/classes/ResourceSuccess/)
- [Unfetched](https://ldo.js.org/latest/api/connected/classes/Unfetched/)
- [UpdateDefaultGraphSuccess](https://ldo.js.org/latest/api/connected/classes/UpdateDefaultGraphSuccess/)
- [UpdateSuccess](https://ldo.js.org/latest/api/connected/classes/UpdateSuccess/
ErrorResult
- [ErrorResult](https://ldo.js.org/latest/api/connected/classes/ErrorResult.md)
- [AggregateError](https://ldo.js.org/latest/api/connected/classes/AggregateError.md)
- [DisconnectedAttemptingReconnectError](https://ldo.js.org/latest/api/connected/classes/DisconnectedAttemptingReconnectError.md)
- [InvalidUriError](https://ldo.js.org/latest/api/connected/classes/InvalidUriError.md)
- [ResourceError](https://ldo.js.org/latest/api/connected/classes/ResourceError.md)
- [UnexpectedResourceError](https://ldo.js.org/latest/api/connected/classes/UnexpectedResourceError.md)
- [UnsupportedNotificationError](https://ldo.js.org/latest/api/connected/classes/UnsupportedNotificationError.md)
- [ErrorResult](https://ldo.js.org/latest/api/connected/classes/ErrorResult/)
- [AggregateError](https://ldo.js.org/latest/api/connected/classes/AggregateError/)
- [DisconnectedAttemptingReconnectError](https://ldo.js.org/latest/api/connected/classes/DisconnectedAttemptingReconnectError/)
- [InvalidUriError](https://ldo.js.org/latest/api/connected/classes/InvalidUriError/)
- [ResourceError](https://ldo.js.org/latest/api/connected/classes/ResourceError/)
- [UnexpectedResourceError](https://ldo.js.org/latest/api/connected/classes/UnexpectedResourceError/)
- [UnsupportedNotificationError](https://ldo.js.org/latest/api/connected/classes/UnsupportedNotificationError/)
## Sponsorship
This project was made possible by a grant from NGI Zero Entrust via nlnet. Learn more on the [NLnet project page](https://nlnet.nl/project/SolidUsableApps/).

Loading…
Cancel
Save