+
## Simple Example
Below is a simple example of LDO in a real use-case (changing the name on a Solid Pod). Assume that a ShapeType was previously generated and placed at `./.ldo/foafProfile.shapeTypes`.
```typescript
-import { parseRdf, startTransaction, toSparqlUpdate, toTurtle } from "@ldo/ldo";
+import {
+ parseRdf,
+ startTransaction,
+ toSparqlUpdate,
+ toTurtle,
+ set,
+} from "@ldo/ldo";
import { FoafProfileShapeType } from "./.ldo/foafProfile.shapeTypes";
async function run() {
@@ -60,26 +70,26 @@ async function run() {
// Logs "Person"
console.log(janeProfile.type);
// Logs 0
- console.log(janeProfile.knows?.length);
+ console.log(janeProfile.knows?.size);
// Begins a transaction that tracks your changes
startTransaction(janeProfile);
janeProfile.name = "Jane Smith";
- janeProfile.knows?.push({
+ janeProfile.knows?.add({
"@id": "https://solidweb.me/john_smith/profile/card#me",
type: {
"@id": "Person",
},
name: "John Smith",
- knows: [janeProfile],
+ knows: set(janeProfile),
});
// Logs "Jane Smith"
console.log(janeProfile.name);
// Logs "John Smith"
- console.log(janeProfile.knows?.[0].name);
+ console.log(janeProfile.knows?.toArray()[0].name);
// Logs "Jane Smith"
- console.log(janeProfile.knows?.[0].knows?.[0].name);
+ console.log(janeProfile.knows?.toArray()[0].knows?.toArray()[0].name);
/**
* Step 3: Convert it back to RDF
diff --git a/packages/schema-converter-shex/README.md b/packages/schema-converter-shex/README.md
index c732a6a..b4db894 100644
--- a/packages/schema-converter-shex/README.md
+++ b/packages/schema-converter-shex/README.md
@@ -7,9 +7,6 @@ Turn ShexJ into typescript typings and JSON-LD context.
npm i @ldo/schema-converter-shex
```
-## API
-See the [full API docs](docs/modules.md).
-
## Usage
```typescript
@@ -83,14 +80,15 @@ async function run() {
/*
Logs:
- declare namespace {
- interface EmployeeShape {
- givenName: string[];
- familyName: string;
- phone?: string[];
- mbox: string;
- }
+ import { LdoJsonldContext, LdSet } from "@ldo/ldo";
+ interface EmployeeShape {
+ "@id"?: string;
+ "@context"?: LdoJsonldContext;
+ givenName: LdSet+Manual Installation +
If you already have generated ShapeTypes, you may install the `@ldo/ldo` library independently. ``` npm i @ldo/ldo ``` +
+
+
+## Simple Example
+
+Below is a simple example of @ldo/solid-react in a real use-case. Assume that a ShapeType was previously generated and placed at `./.ldo/solidProfile.shapeTypess`.
+
+
+```typescript
+import type { FunctionComponent } from "react";
+import React, { useCallback } from "react";
+import {
+ BrowserSolidLdoProvider,
+ useResource,
+ useSolidAuth,
+ useSubject,
+} from "@ldo/solid-react";
+import { SolidProfileShapeShapeType } from "./.ldo/solidProfile.shapeTypes";
+import { changeData, commitData } from "@ldo/solid";
+
+// The base component for the app
+const App: FunctionComponent = () => {
+ return (
+ /* The application should be surrounded with the BrowserSolidLdoProvider
+ this will set up all the underlying infrastructure for the application */
+ +Manual Installation +
+ +If you already have generated ShapeTypes, you may install the `@ldo/ldo` and `@ldo/solid` libraries independently. + +``` +npm i @ldo/ldo @ldo/solid @ldo/solid-react +``` +
+ {/* Get the user's webId from session.webId */}
+
+ );
+ }
+ return ;
+};
+
+// Renders the name on the profile
+const Profile: FunctionComponent = () => {
+ const { session } = useSolidAuth();
+ // With useResource, you can automatically fetch a resource
+ const resource = useResource(session.webId);
+ // With useSubject, you can extract data from that resource
+ const profile = useSubject(SolidProfileShapeShapeType, session.webId);
+
+ const onNameChange = useCallback(async (e) => {
+ // Ensure that the
+ if (!profile || !resource) return;
+ // Change data lets you create a new object to make changes to
+ const cProfile = changeData(profile, resource);
+ // Change the name
+ cProfile.name = e.target.value;
+ // Commit the data back to the Pod
+ await commitData(cProfile);
+ }, []);
+
+ return ;
+};
+
+export default App;
+```
+
+## API Details
+
+Providers
+
+ - [BrowserSolidLdoProvider](https://ldo.js.org/api/solid-react/BrowserSolidLdoProvider/)
+ - [SolidLdoProvider](https://ldo.js.org/api/solid-react/SolidLdoProvider/)
+
+Hooks
+ - [useLdo](https://ldo.js.org/api/solid-react/useLdo/)
+ - [useResource](https://ldo.js.org/api/solid-react/useResource/)
+ - [useRootContainer](https://ldo.js.org/api/solid-react/useRootContainer/)
+ - [useSolidAuth](https://ldo.js.org/api/solid-react/useSolidAuth/)
+ - [useSubject](https://ldo.js.org/api/solid-react/useSubject/)
+ - [useMatchSubject](https://ldo.js.org/api/solid-react/useMatchSubject/)
+ - [useMatchObject](https://ldo.js.org/api/solid-react/useMatchSubject/)
+ - [useSubscribeToResource](https://ldo.js.org/api/solid-react/useMatchSubject/)
## 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/).
@@ -11,4 +135,4 @@ This project was made possible by a grant from NGI Zero Entrust via nlnet. Learn
[Logged in as {session.webId}
+ {/* Use the logout function to log out */} + +
](https://nlnet.nl/)
## Liscense
-MIT
+MIT
\ No newline at end of file
diff --git a/packages/solid/README.md b/packages/solid/README.md
index ecdeab6..8216254 100644
--- a/packages/solid/README.md
+++ b/packages/solid/README.md
@@ -16,13 +16,17 @@ Now install the @ldo/solid library
npm i @ldo/solid
```
-### Manual Installation
+
+
## Simple Examples