jaxoncreed
2 years ago
parent
c89bdbca85
commit
586dfe4675
@ -0,0 +1,21 @@ |
||||
MIT License |
||||
|
||||
Copyright (c) 2023 Jackson Morgan |
||||
|
||||
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. |
||||
File diff suppressed because it is too large
Load Diff
@ -0,0 +1,21 @@ |
||||
MIT License |
||||
|
||||
Copyright (c) 2023 Jackson Morgan |
||||
|
||||
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. |
||||
@ -0,0 +1,21 @@ |
||||
MIT License |
||||
|
||||
Copyright (c) 2023 Jackson Morgan |
||||
|
||||
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. |
||||
@ -0,0 +1,106 @@ |
||||
# Dataset |
||||
|
||||
An implementation of the full [RDF/JS Dataset API](https://rdf.js.org/dataset-spec/) |
||||
|
||||
## Installation |
||||
|
||||
``` |
||||
npm i @ldo/dataset |
||||
``` |
||||
|
||||
## Simple Example |
||||
|
||||
```typescript |
||||
import { createDataset } from "o-dataset-pack"; |
||||
import { quad, namedNode } from "@rdfjs/data-model"; |
||||
const dataset = createDataset(); |
||||
dataset.add( |
||||
quad( |
||||
namedNode("http://example.org/cartoons#Zuko"), |
||||
namedNode("http://www.w3.org/1999/02/22-rdf-syntax-ns#type"), |
||||
namedNode("http://example.org/cartoons#Firebender") |
||||
) |
||||
); |
||||
/* |
||||
Prints: |
||||
<http://example.org/cartoons#Zuko> <http://www.w3.org/1999/02/22-rdf-syntax-ns#type> <http://example.org/cartoons#Firebender> . |
||||
*/ |
||||
console.log(dataset.toString()); |
||||
``` |
||||
|
||||
## Advanced Example |
||||
|
||||
The extended dataset implements all the [additional methods](https://rdf.js.org/dataset-spec/#dataset-interface) of the RDFJS dataset spec. |
||||
|
||||
Usage: |
||||
```typescript |
||||
import { createDataset } from "@ldo/dataset"; |
||||
import { quad, namedNode, literal } from "@rdfjs/data-model"; |
||||
// Required for advanced features: |
||||
import { dataset as initializeDatasetCore } from "@rdfjs/dataset"; |
||||
import { ExtendedDatasetFactory } from "o-dataset-pack"; |
||||
import { Dataset, Quad, DatasetCoreFactory, DatasetCore } from "rdf-js"; |
||||
|
||||
/** |
||||
* Create a dataset with default settings |
||||
*/ |
||||
const defaultDataset = createDataset(); |
||||
|
||||
/** |
||||
* Create a dataset with default settings and initialized values |
||||
*/ |
||||
const initializedQuads = [ |
||||
quad( |
||||
namedNode("http://example.org/cartoons#Tom"), |
||||
namedNode("http://www.w3.org/1999/02/22-rdf-syntax-ns#type"), |
||||
namedNode("http://example.org/cartoons#Cat") |
||||
), |
||||
quad( |
||||
namedNode("http://example.org/cartoons#Tom"), |
||||
namedNode("http://example.org/cartoons#name"), |
||||
literal("Tom") |
||||
), |
||||
]; |
||||
const defaultDataset2 = createDataset(initializedQuads); |
||||
|
||||
/** |
||||
* (Advanced Feature) Create a dataset by injecting a chosen datasetCore and datasetCoreFactory |
||||
*/ |
||||
const datasetFactory: DatasetCoreFactory = { |
||||
dataset: (quads?: Dataset<Quad> | Quad[]): DatasetCore => { |
||||
return initializeDatasetCore( |
||||
Array.isArray(quads) ? quads : quads?.toArray() |
||||
); |
||||
}, |
||||
}; |
||||
const extendedDatasetFactory = new ExtendedDatasetFactory(datasetFactory); |
||||
const customDataset = extendedDatasetFactory.dataset(initializedQuads); |
||||
|
||||
/** |
||||
* Do all the methods of the RDFJS Dataset interface. For a full list of methods, go to |
||||
* https://rdf.js.org/dataset-spec/#data-interfaces |
||||
*/ |
||||
defaultDataset.add( |
||||
quad( |
||||
namedNode("http://example.org/cartoons#Miuki"), |
||||
namedNode("http://www.w3.org/1999/02/22-rdf-syntax-ns#type"), |
||||
namedNode("http://example.org/cartoons#Cat") |
||||
) |
||||
); |
||||
const combinedDataset = defaultDataset.union(defaultDataset2); |
||||
const differenceDataset = combinedDataset.difference(customDataset); |
||||
// Prints true because "defaultDataset2" and "customDataset" have equal values |
||||
// combinedDataset = defaultDataset ∪ defaultDataset2 |
||||
// differenceDatasset = defaultDataset \ customDataset |
||||
// Therefore differenceDataset == defaultDataset |
||||
console.log(differenceDataset.equals(defaultDataset)); |
||||
``` |
||||
|
||||
## 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/). |
||||
|
||||
[<img src="https://nlnet.nl/logo/banner.png" alt="nlnet foundation logo" width="300" />](https://nlnet.nl/) |
||||
[<img src="https://nlnet.nl/image/logos/NGI0Entrust_tag.svg" alt="NGI Zero Entrust Logo" width="300" />](https://nlnet.nl/) |
||||
|
||||
## Liscense |
||||
MIT |
||||
@ -0,0 +1,21 @@ |
||||
MIT License |
||||
|
||||
Copyright (c) 2023 Jackson Morgan |
||||
|
||||
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. |
||||
@ -1,70 +1,12 @@ |
||||
# Getting Started with Create React App |
||||
# LDO Demo-React |
||||
|
||||
This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app). |
||||
A demo app to show off the use of LDO. |
||||
|
||||
## Available Scripts |
||||
## 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/). |
||||
|
||||
In the project directory, you can run: |
||||
[<img src="https://nlnet.nl/logo/banner.png" alt="nlnet foundation logo" width="300" />](https://nlnet.nl/) |
||||
[<img src="https://nlnet.nl/image/logos/NGI0Entrust_tag.svg" alt="NGI Zero Entrust Logo" width="300" />](https://nlnet.nl/) |
||||
|
||||
### `npm start` |
||||
|
||||
Runs the app in the development mode.\ |
||||
Open [http://localhost:3000](http://localhost:3000) to view it in your browser. |
||||
|
||||
The page will reload when you make changes.\ |
||||
You may also see any lint errors in the console. |
||||
|
||||
### `npm test` |
||||
|
||||
Launches the test runner in the interactive watch mode.\ |
||||
See the section about [running tests](https://facebook.github.io/create-react-app/docs/running-tests) for more information. |
||||
|
||||
### `npm run build` |
||||
|
||||
Builds the app for production to the `build` folder.\ |
||||
It correctly bundles React in production mode and optimizes the build for the best performance. |
||||
|
||||
The build is minified and the filenames include the hashes.\ |
||||
Your app is ready to be deployed! |
||||
|
||||
See the section about [deployment](https://facebook.github.io/create-react-app/docs/deployment) for more information. |
||||
|
||||
### `npm run eject` |
||||
|
||||
**Note: this is a one-way operation. Once you `eject`, you can't go back!** |
||||
|
||||
If you aren't satisfied with the build tool and configuration choices, you can `eject` at any time. This command will remove the single build dependency from your project. |
||||
|
||||
Instead, it will copy all the configuration files and the transitive dependencies (webpack, Babel, ESLint, etc) right into your project so you have full control over them. All of the commands except `eject` will still work, but they will point to the copied scripts so you can tweak them. At this point you're on your own. |
||||
|
||||
You don't have to ever use `eject`. The curated feature set is suitable for small and middle deployments, and you shouldn't feel obligated to use this feature. However we understand that this tool wouldn't be useful if you couldn't customize it when you are ready for it. |
||||
|
||||
## Learn More |
||||
|
||||
You can learn more in the [Create React App documentation](https://facebook.github.io/create-react-app/docs/getting-started). |
||||
|
||||
To learn React, check out the [React documentation](https://reactjs.org/). |
||||
|
||||
### Code Splitting |
||||
|
||||
This section has moved here: [https://facebook.github.io/create-react-app/docs/code-splitting](https://facebook.github.io/create-react-app/docs/code-splitting) |
||||
|
||||
### Analyzing the Bundle Size |
||||
|
||||
This section has moved here: [https://facebook.github.io/create-react-app/docs/analyzing-the-bundle-size](https://facebook.github.io/create-react-app/docs/analyzing-the-bundle-size) |
||||
|
||||
### Making a Progressive Web App |
||||
|
||||
This section has moved here: [https://facebook.github.io/create-react-app/docs/making-a-progressive-web-app](https://facebook.github.io/create-react-app/docs/making-a-progressive-web-app) |
||||
|
||||
### Advanced Configuration |
||||
|
||||
This section has moved here: [https://facebook.github.io/create-react-app/docs/advanced-configuration](https://facebook.github.io/create-react-app/docs/advanced-configuration) |
||||
|
||||
### Deployment |
||||
|
||||
This section has moved here: [https://facebook.github.io/create-react-app/docs/deployment](https://facebook.github.io/create-react-app/docs/deployment) |
||||
|
||||
### `npm run build` fails to minify |
||||
|
||||
This section has moved here: [https://facebook.github.io/create-react-app/docs/troubleshooting#npm-run-build-fails-to-minify](https://facebook.github.io/create-react-app/docs/troubleshooting#npm-run-build-fails-to-minify) |
||||
## Liscense |
||||
MIT |
||||
@ -0,0 +1,21 @@ |
||||
MIT License |
||||
|
||||
Copyright (c) 2023 Jackson Morgan |
||||
|
||||
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. |
||||
@ -0,0 +1,21 @@ |
||||
MIT License |
||||
|
||||
Copyright (c) 2023 Jackson Morgan |
||||
|
||||
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. |
||||
@ -0,0 +1,21 @@ |
||||
MIT License |
||||
|
||||
Copyright (c) 2023 Jackson Morgan |
||||
|
||||
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. |
||||
@ -0,0 +1,12 @@ |
||||
# @ldo/rdf-utils |
||||
|
||||
Utilities for common use in LDO libraries. |
||||
|
||||
## 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/). |
||||
|
||||
[<img src="https://nlnet.nl/logo/banner.png" alt="nlnet foundation logo" width="300" />](https://nlnet.nl/) |
||||
[<img src="https://nlnet.nl/image/logos/NGI0Entrust_tag.svg" alt="NGI Zero Entrust Logo" width="300" />](https://nlnet.nl/) |
||||
|
||||
## Liscense |
||||
MIT |
||||
@ -0,0 +1,21 @@ |
||||
MIT License |
||||
|
||||
Copyright (c) 2023 Jackson Morgan |
||||
|
||||
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. |
||||
@ -0,0 +1,21 @@ |
||||
MIT License |
||||
|
||||
Copyright (c) 2023 Jackson Morgan |
||||
|
||||
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. |
||||
@ -1,13 +1,14 @@ |
||||
# Solid-Dataset |
||||
# @ldo/solid-react |
||||
|
||||
Pre-alpha |
||||
Alpha |
||||
|
||||
## Notes: |
||||
- Any quads in the default graph will not be synced to Solid Pods, but will be added to the dataset without any syncing |
||||
// TODO: Write readme |
||||
|
||||
## 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/). |
||||
|
||||
## TODO: |
||||
- Create an event for each thing that happens. Like "Loaded" |
||||
- You should be able to initialize classes with loading = true so that there isn't a flash on initial load |
||||
- Access rule stuff just doesn't work. I might need to program a custom implementation for that |
||||
- There should probably be separate libraries for React native and Web React |
||||
[<img src="https://nlnet.nl/logo/banner.png" alt="nlnet foundation logo" width="300" />](https://nlnet.nl/) |
||||
[<img src="https://nlnet.nl/image/logos/NGI0Entrust_tag.svg" alt="NGI Zero Entrust Logo" width="300" />](https://nlnet.nl/) |
||||
|
||||
## Liscense |
||||
MIT |
||||
|
||||
@ -0,0 +1,21 @@ |
||||
MIT License |
||||
|
||||
Copyright (c) 2023 Jackson Morgan |
||||
|
||||
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. |
||||
@ -1,13 +1,19 @@ |
||||
# Solid-Dataset |
||||
# @ldo/solid |
||||
|
||||
Pre-alpha |
||||
Alpha |
||||
|
||||
## Notes: |
||||
- Any quads in the default graph will not be synced to Solid Pods, but will be added to the dataset without any syncing |
||||
|
||||
|
||||
## TODO: |
||||
- Create an event for each thing that happens. Like "Loaded" |
||||
- You should be able to initialize classes with loading = true so that there isn't a flash on initial load |
||||
- Add Documentation |
||||
- Access rule stuff just doesn't work. I might need to program a custom implementation for that |
||||
- There should probably be separate libraries for React native and Web React |
||||
|
||||
## 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/). |
||||
|
||||
[<img src="https://nlnet.nl/logo/banner.png" alt="nlnet foundation logo" width="300" />](https://nlnet.nl/) |
||||
[<img src="https://nlnet.nl/image/logos/NGI0Entrust_tag.svg" alt="NGI Zero Entrust Logo" width="300" />](https://nlnet.nl/) |
||||
|
||||
## Liscense |
||||
MIT |
||||
|
||||
@ -1,7 +1,6 @@ |
||||
{ |
||||
"extends": "../../tsconfig.base.json", |
||||
"compilerOptions": { |
||||
"strict": false, |
||||
"outDir": "./dist", |
||||
}, |
||||
"include": ["./src"] |
||||
|
||||
@ -0,0 +1,21 @@ |
||||
MIT License |
||||
|
||||
Copyright (c) 2023 Jackson Morgan |
||||
|
||||
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. |
||||
@ -0,0 +1,298 @@ |
||||
A library of RDFJS Datasets that have many uses including subscribing to node changes and making transactions on a dataset. |
||||
|
||||
This library follows the [RDFJS spec for a Dataset](https://rdf.js.org/dataset-spec/). |
||||
|
||||
## Installation |
||||
```bash |
||||
npm i @ldo/subscribable-dataset |
||||
``` |
||||
|
||||
## Simple Example |
||||
|
||||
```typescript |
||||
import { createSubscribableDataset, DatasetChanges } from "@ldo/subscribable-dataset"; |
||||
import { Dataset } from "@rdfjs/types"; |
||||
import { quad, namedNode, literal } from "@rdfjs/data-model"; |
||||
|
||||
const subscribableDataset = createSubscribableDataset([ |
||||
quad( |
||||
namedNode("http://example.org/cartoons#Zuko"), |
||||
namedNode("http://www.w3.org/1999/02/22-rdf-syntax-ns#type"), |
||||
namedNode("http://example.org/cartoons#Firebender") |
||||
), |
||||
]); |
||||
subscribableDataset.on( |
||||
namedNode("http://example.org/cartoons#Zuko"), |
||||
(currentQuads: Dataset, changes: DatasetChanges) => { |
||||
console.log(currentQuads.toString()); |
||||
console.log("--------"); |
||||
console.log(changes.added?.toString()); |
||||
} |
||||
); |
||||
/* |
||||
Prints: |
||||
<http://example.org/cartoons#Zuko> <http://www.w3.org/1999/02/22-rdf-syntax-ns#type> <http://example.org/cartoons#Firebender> . |
||||
<http://example.org/cartoons#Zuko> <http://example.org/cartoons#name> "Zuko" . |
||||
-------- |
||||
<http://example.org/cartoons#Zuko> <http://example.org/cartoons#name> "Zuko" . |
||||
*/ |
||||
subscribableDataset.add( |
||||
quad( |
||||
namedNode("http://example.org/cartoons#Zuko"), |
||||
namedNode("http://example.org/cartoons#name"), |
||||
literal("Zuko") |
||||
) |
||||
); |
||||
``` |
||||
|
||||
## Loading from Serialized Data |
||||
|
||||
```typescript |
||||
import { serializedToDataset, serializedToSubscribableDataset } from "@ldo/subscribable-dataset"; |
||||
|
||||
async function run(): Promise<void> { |
||||
// Create an ExtendedDataset using Turtle |
||||
const turtleData = ` |
||||
@prefix : <#>. |
||||
@prefix elem: <http://purl.org/dc/elements/1.1/>. |
||||
@prefix card: </profile/card#>. |
||||
|
||||
:this |
||||
elem:author card:me. |
||||
`; |
||||
const turtleDataset = await serializedToDataset(turtleData, { |
||||
baseIRI: |
||||
"https://jackson.solidcommunity.net/IndividualChats/jackson.solidcommunity.net/index.ttl#", |
||||
// NOTE: the "format" field isn't required because Turtle is the default parser |
||||
}); |
||||
|
||||
// Create a SubcribableDataset using JSON-LD |
||||
const jsonLdData = [ |
||||
{ |
||||
"@id": |
||||
"https://jackson.solidcommunity.net/IndividualChats/jackson.solidcommunity.net/index.ttl#this", |
||||
"http://purl.org/dc/elements/1.1/author": [ |
||||
{ |
||||
"@id": "https://jackson.solidcommunity.net/profile/card#me", |
||||
}, |
||||
], |
||||
}, |
||||
{ |
||||
"@id": "https://jackson.solidcommunity.net/profile/card#me", |
||||
}, |
||||
]; |
||||
const jsonLdDataset = await serializedToSubscribableDataset( |
||||
JSON.stringify(jsonLdData), |
||||
{ |
||||
baseIRI: |
||||
"https://jackson.solidcommunity.net/IndividualChats/jackson.solidcommunity.net/index.ttl#", |
||||
format: "application/json-ld", |
||||
} |
||||
); |
||||
// Returns true because the input data describes the same triple. |
||||
console.log(turtleDataset.equals(jsonLdDataset)); |
||||
} |
||||
run(); |
||||
``` |
||||
|
||||
## Advanced Example |
||||
|
||||
```typescript |
||||
import { createSubscribableDataset, DatasetChanges } from "@ldo/subscribable-dataset"; |
||||
import { quad, namedNode, literal } from "@rdfjs/data-model"; |
||||
import { Dataset } from "@rdfjs/types"; |
||||
|
||||
// Create an empty subscribable dataset |
||||
const subscribableDataset = createSubscribableDataset(); |
||||
// Add some initial quads |
||||
subscribableDataset.addAll([ |
||||
quad( |
||||
namedNode("http://example.org/cartoons#Zuko"), |
||||
namedNode("http://www.w3.org/1999/02/22-rdf-syntax-ns#type"), |
||||
namedNode("http://example.org/cartoons#Firebender"), |
||||
namedNode("http://example.org/cartoons") |
||||
), |
||||
quad( |
||||
namedNode("http://example.org/cartoons#Zuko"), |
||||
namedNode("http://example.org/cartoons#name"), |
||||
literal("Zuko"), |
||||
namedNode("http://example.org/cartoons") |
||||
), |
||||
]); |
||||
// Set up listeners |
||||
// Listener that will trigger whenever a quad containing the named |
||||
// node "http://example.org/cartoons#Zuko" is added or removed. |
||||
subscribableDataset.on( |
||||
namedNode("http://example.org/cartoons#Zuko"), |
||||
(zukoQuads: Dataset, changes: DatasetChanges) => { |
||||
console.log("ZUKO NODE CHANGED ============"); |
||||
console.log(zukoQuads.toString()); |
||||
console.log("Added Quads:"); |
||||
console.log(changes.added?.toString()); |
||||
console.log("Removed Quads:"); |
||||
console.log(changes.removed?.toString()); |
||||
console.log("\n\n"); |
||||
} |
||||
); |
||||
// Listener that will trigger whenever a quad containing the named |
||||
// node "http://example.org/cartoons" is added or removed. This is |
||||
// useful for keeping track of the cartoons graph. |
||||
subscribableDataset.on( |
||||
namedNode("http://example.org/cartoons"), |
||||
(cartoonGraphQuads: Dataset, changes: DatasetChanges) => { |
||||
console.log("CARTOON GRAPH CHANGED ============"); |
||||
console.log(cartoonGraphQuads.toString()); |
||||
console.log("Added Quads:"); |
||||
console.log(changes.added?.toString()); |
||||
console.log("Removed Quads:"); |
||||
console.log(changes.removed?.toString()); |
||||
console.log("\n\n"); |
||||
} |
||||
); |
||||
|
||||
// Modify the dataset |
||||
/* |
||||
Prints: |
||||
CARTOON GRAPH CHANGED ============ |
||||
<http://example.org/cartoons#Zuko> <http://www.w3.org/1999/02/22-rdf-syntax-ns#type> <http://example.org/cartoons#Firebender> <http://example.org/cartoons> . |
||||
<http://example.org/cartoons#Zuko> <http://example.org/cartoons#name> "Zuko" <http://example.org/cartoons> . |
||||
<http://example.org/cartoons#Katara> <http://www.w3.org/1999/02/22-rdf-syntax-ns#type> <http://example.org/cartoons#Waterbender> <http://example.org/cartoons> . |
||||
<http://example.org/cartoons#Katara> <http://example.org/cartoons#name> "Katara" <http://example.org/cartoons> . |
||||
|
||||
Added Quads: |
||||
<http://example.org/cartoons#Katara> <http://www.w3.org/1999/02/22-rdf-syntax-ns#type> <http://example.org/cartoons#Waterbender> <http://example.org/cartoons> . |
||||
<http://example.org/cartoons#Katara> <http://example.org/cartoons#name> "Katara" <http://example.org/cartoons> . |
||||
|
||||
Removed Quads: |
||||
undefined |
||||
*/ |
||||
subscribableDataset.addAll([ |
||||
quad( |
||||
namedNode("http://example.org/cartoons#Katara"), |
||||
namedNode("http://www.w3.org/1999/02/22-rdf-syntax-ns#type"), |
||||
namedNode("http://example.org/cartoons#Waterbender"), |
||||
namedNode("http://example.org/cartoons") |
||||
), |
||||
quad( |
||||
namedNode("http://example.org/cartoons#Katara"), |
||||
namedNode("http://example.org/cartoons#name"), |
||||
literal("Katara"), |
||||
namedNode("http://example.org/cartoons") |
||||
), |
||||
]); |
||||
|
||||
/* |
||||
Prints: |
||||
ZUKO NODE CHANGED ============ |
||||
<http://example.org/cartoons#Zuko> <http://www.w3.org/1999/02/22-rdf-syntax-ns#type> <http://example.org/cartoons#Firebender> <http://example.org/cartoons> . |
||||
<http://example.org/cartoons#Zuko> <http://example.org/cartoons#name> "Zuko" <http://example.org/cartoons> . |
||||
<http://example.org/cartoons#Zuko> <http://example.org/cartoons#hasEnemy> <http://example.org/cartoons#Katara> <http://example.org/cartoons> . |
||||
<http://example.org/cartoons#Katara> <http://example.org/cartoons#hasEnemy> <http://example.org/cartoons#Zuko> <http://example.org/cartoons> . |
||||
|
||||
Added Quads: |
||||
<http://example.org/cartoons#Katara> <http://example.org/cartoons#hasEnemy> <http://example.org/cartoons#Zuko> <http://example.org/cartoons> . |
||||
<http://example.org/cartoons#Zuko> <http://example.org/cartoons#hasEnemy> <http://example.org/cartoons#Katara> <http://example.org/cartoons> . |
||||
|
||||
Removed Quads: |
||||
undefined |
||||
|
||||
|
||||
CARTOON GRAPH CHANGED ============ |
||||
<http://example.org/cartoons#Zuko> <http://www.w3.org/1999/02/22-rdf-syntax-ns#type> <http://example.org/cartoons#Firebender> <http://example.org/cartoons> . |
||||
<http://example.org/cartoons#Zuko> <http://example.org/cartoons#name> "Zuko" <http://example.org/cartoons> . |
||||
<http://example.org/cartoons#Zuko> <http://example.org/cartoons#hasEnemy> <http://example.org/cartoons#Katara> <http://example.org/cartoons> . |
||||
<http://example.org/cartoons#Katara> <http://www.w3.org/1999/02/22-rdf-syntax-ns#type> <http://example.org/cartoons#Waterbender> <http://example.org/cartoons> . |
||||
<http://example.org/cartoons#Katara> <http://example.org/cartoons#name> "Katara" <http://example.org/cartoons> . |
||||
<http://example.org/cartoons#Katara> <http://example.org/cartoons#hasEnemy> <http://example.org/cartoons#Zuko> <http://example.org/cartoons> . |
||||
|
||||
Added Quads: |
||||
<http://example.org/cartoons#Katara> <http://example.org/cartoons#hasEnemy> <http://example.org/cartoons#Zuko> <http://example.org/cartoons> . |
||||
<http://example.org/cartoons#Zuko> <http://example.org/cartoons#hasEnemy> <http://example.org/cartoons#Katara> <http://example.org/cartoons> . |
||||
|
||||
Removed Quads: |
||||
undefined |
||||
*/ |
||||
subscribableDataset.addAll([ |
||||
quad( |
||||
namedNode("http://example.org/cartoons#Katara"), |
||||
namedNode("http://example.org/cartoons#hasEnemy"), |
||||
namedNode("http://example.org/cartoons#Zuko"), |
||||
namedNode("http://example.org/cartoons") |
||||
), |
||||
quad( |
||||
namedNode("http://example.org/cartoons#Zuko"), |
||||
namedNode("http://example.org/cartoons#hasEnemy"), |
||||
namedNode("http://example.org/cartoons#Katara"), |
||||
namedNode("http://example.org/cartoons") |
||||
), |
||||
]); |
||||
|
||||
// If there are many operation you want to do at once, use transactions. |
||||
// An update will not be triggered until the transaction is committed. |
||||
const transactionalDataset = subscribableDataset.startTransaction(); |
||||
// Delete all triples with a "hasEnemy" predicate |
||||
transactionalDataset.deleteMatches( |
||||
undefined, |
||||
namedNode("http://example.org/cartoons#hasEnemy"), |
||||
undefined, |
||||
undefined |
||||
); |
||||
// Add "hasFrient" predicate |
||||
transactionalDataset.addAll([ |
||||
quad( |
||||
namedNode("http://example.org/cartoons#Katara"), |
||||
namedNode("http://example.org/cartoons#hasFriend"), |
||||
namedNode("http://example.org/cartoons#Zuko"), |
||||
namedNode("http://example.org/cartoons") |
||||
), |
||||
quad( |
||||
namedNode("http://example.org/cartoons#Zuko"), |
||||
namedNode("http://example.org/cartoons#hasFriend"), |
||||
namedNode("http://example.org/cartoons#Katara"), |
||||
namedNode("http://example.org/cartoons") |
||||
), |
||||
]); |
||||
/* |
||||
Prints: |
||||
ZUKO NODE CHANGED ============ |
||||
<http://example.org/cartoons#Zuko> <http://www.w3.org/1999/02/22-rdf-syntax-ns#type> <http://example.org/cartoons#Firebender> <http://example.org/cartoons> . |
||||
<http://example.org/cartoons#Zuko> <http://example.org/cartoons#name> "Zuko" <http://example.org/cartoons> . |
||||
<http://example.org/cartoons#Zuko> <http://example.org/cartoons#hasFriend> <http://example.org/cartoons#Katara> <http://example.org/cartoons> . |
||||
<http://example.org/cartoons#Katara> <http://example.org/cartoons#hasFriend> <http://example.org/cartoons#Zuko> <http://example.org/cartoons> . |
||||
|
||||
Added Quads: |
||||
<http://example.org/cartoons#Katara> <http://example.org/cartoons#hasFriend> <http://example.org/cartoons#Zuko> <http://example.org/cartoons> . |
||||
<http://example.org/cartoons#Zuko> <http://example.org/cartoons#hasFriend> <http://example.org/cartoons#Katara> <http://example.org/cartoons> . |
||||
|
||||
Removed Quads: |
||||
<http://example.org/cartoons#Katara> <http://example.org/cartoons#hasEnemy> <http://example.org/cartoons#Zuko> <http://example.org/cartoons> . |
||||
<http://example.org/cartoons#Zuko> <http://example.org/cartoons#hasEnemy> <http://example.org/cartoons#Katara> <http://example.org/cartoons> . |
||||
|
||||
|
||||
CARTOON GRAPH CHANGED ============ |
||||
<http://example.org/cartoons#Zuko> <http://www.w3.org/1999/02/22-rdf-syntax-ns#type> <http://example.org/cartoons#Firebender> <http://example.org/cartoons> . |
||||
<http://example.org/cartoons#Zuko> <http://example.org/cartoons#name> "Zuko" <http://example.org/cartoons> . |
||||
<http://example.org/cartoons#Zuko> <http://example.org/cartoons#hasFriend> <http://example.org/cartoons#Katara> <http://example.org/cartoons> . |
||||
<http://example.org/cartoons#Katara> <http://www.w3.org/1999/02/22-rdf-syntax-ns#type> <http://example.org/cartoons#Waterbender> <http://example.org/cartoons> . |
||||
<http://example.org/cartoons#Katara> <http://example.org/cartoons#name> "Katara" <http://example.org/cartoons> . |
||||
<http://example.org/cartoons#Katara> <http://example.org/cartoons#hasFriend> <http://example.org/cartoons#Zuko> <http://example.org/cartoons> . |
||||
|
||||
Added Quads: |
||||
<http://example.org/cartoons#Katara> <http://example.org/cartoons#hasFriend> <http://example.org/cartoons#Zuko> <http://example.org/cartoons> . |
||||
<http://example.org/cartoons#Zuko> <http://example.org/cartoons#hasFriend> <http://example.org/cartoons#Katara> <http://example.org/cartoons> . |
||||
|
||||
Removed Quads: |
||||
<http://example.org/cartoons#Katara> <http://example.org/cartoons#hasEnemy> <http://example.org/cartoons#Zuko> <http://example.org/cartoons> . |
||||
<http://example.org/cartoons#Zuko> <http://example.org/cartoons#hasEnemy> <http://example.org/cartoons#Katara> <http://example.org/cartoons> . |
||||
*/ |
||||
transactionalDataset.commit(); |
||||
``` |
||||
|
||||
## 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/). |
||||
|
||||
[<img src="https://nlnet.nl/logo/banner.png" alt="nlnet foundation logo" width="300" />](https://nlnet.nl/) |
||||
[<img src="https://nlnet.nl/image/logos/NGI0Entrust_tag.svg" alt="NGI Zero Entrust Logo" width="300" />](https://nlnet.nl/) |
||||
|
||||
## Liscense |
||||
MIT |
||||
@ -0,0 +1,21 @@ |
||||
MIT License |
||||
|
||||
Copyright (c) 2023 Jackson Morgan |
||||
|
||||
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. |
||||
@ -0,0 +1,21 @@ |
||||
MIT License |
||||
|
||||
Copyright (c) 2023 Jackson Morgan |
||||
|
||||
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. |
||||
Loading…
Reference in new issue