@muze-nl/simplystore 0.1.2 → 0.1.5

package/README.md

@@ -4,54 +4,112 @@ SimplyStore is an attempt to create a radically simpler backend storage server.
 
 [JSONTag](https://github.com/poef/jsontag) is an enhancement over JSON that allows you to tag JSON data with metadata using HTML-like tags.
 Javascript queries are run in a [VM2](https://www.npmjs.com/package/vm2) sandbox.
+You can query data using the [array-where-select](https://www.npmjs.com/package/array-where-select) extension.
 
+## Table of Contents
 
-## Installation
+- [Background](#background)
+- [Install](#install)
+- [Usage](#usage)
+- [Example Query](#examples)
+- [Goals](#goals)
+- [Roadmap](#roadmap)
+- [License](#license)
 
-SimplyStore is a Node application. Start it by downloading this git repository:
+<a name="background"></a>
+## Background
+
+<a name="install"></a>
+## Install
+
+SimplyStore is a Node library. You can install it in your application like this:
 
 ```shell
-git clone git@github.com:simplyedit/simplystore
+npm install @muze-nl/simplystore
 ```
 
-Then install its dependencies:
+<a name="usage"></a>
+## Usage
 
-```shell
-cd simplystore
-npm install
+Import the server in your main file like this:
+
+```javascript
+import simplystore from '@muze-nl/simplystore'
 ```
 
-And start it up:
+Then configure and start the server, like this:
+
+```javascript
+simplystore.run({
+    datafile: process.cwd().'data.json'
+})
+````
+
+Other options are:
+
+- port: The port number to use, defaults to 3000
+- dataspace: an object or array with all the data that SimplyStore will serve. Optional, replaces the datafile.
+
+If you start your server:
 
 ```shell
-npm start 
+node myApp.js
 ```
 
-The server comes with a small demo dataset, which you can take a look at here `http://localhost:3000/`:
+You should be able to go http://localhost:3000/query/ and see something like this:
 
-This page will show this:
+![image](https://github.com/SimplyEdit/SimplyStore/assets/1006453/3bec6b97-ffa1-4114-9ed4-51a68f73476e)
+
+<a name="examples"></a>
+## Example query
+
+Given a dataset like this (jsontag):
 
 ```
 {
-    "persons":<link>"persons/"
+    "persons": [
+        <object id="john" class="Person">{
+            "name": "John",
+            "lastName": "Doe",
+            "dob": <date>"1972-09-20",
+            "foaf": [
+                <link>"jane"
+            ]
+        },
+        <object id="jane" class="Person">{
+            "name": "Jane",
+            "lastName": "Doe",
+            "dob": <date>"1986-01-01",
+            "foaf": [
+                <link>"john"
+            ]
+        }
+    ]
 }
 ```
 
-By following the link to `http://localhost:3000/persons/` you get:
+You can post to the /query/ endpoint with javascript queries like these:
 
 ```
-[
-    <object class="Person">{
-        "name":"John",
-        "dob":<date>"1972-09-20"
-    },
-    <object class="Person">{
-        "name":"Jane",
-        "dob":<date>"1986-01-01"
+data.persons
+.where({
+    name: 'John'
+})
+.select({
+    name: _,
+    foaf: {
+        name: _
     }
-]
+})
 ```
 
+See the [array-where-select](https://www.npmjs.com/package/array-where-select) package for more information about the query possibilities.
+
+Remember: it is just javascript, so you can also use filter(), map() and reduce() on arrays. You can use all the default javascript API's, like Math, Array, Object, etc. You can not use any webbrowser API's, and you can't access any NodeJS API's. You do not have network access in your query.
+
+Most important: queries cannot change the dataset, it is immutable.
+
+<a name="goals"></a>
 ## Goals of this project
 
 SimplyStore is an attemp to see if we can create a more defined and usable REST like service, out of the box. One where all you need to do is change the data and add some access rights and get a self-describing, browseable, working API.
@@ -64,7 +122,7 @@ The SimplyStore design is predicated on the following realisations:
   4. There is no clear onramp from JSON to Linked Data.
   5. Linked Data is very good for data / information exchange, but very costly for data manipulation and querying.
 
-So the scope for jsontag-rest-server is:
+So the scope for SimplyStore is:
 
 - datasets that will fit comfortably in memory, for now I've set a test goal of about 1GB of data.
 - usecases that are mostly-read, with sparse updates.
@@ -73,9 +131,9 @@ So the scope for jsontag-rest-server is:
 
 In addition, SimplyStore is meant to be a real-world testcase for JSONTag.
 
+<a name="roadmap"></a>
 ## Roadmap
 
-- [v] immutable dataset
 - allow changes to dataset by creating a new root
 - command handling with crud commands and command log
 - backup current dataset to JSONTag file
@@ -83,17 +141,11 @@ In addition, SimplyStore is meant to be a real-world testcase for JSONTag.
 
 - improved web client with type-specific views and form elements
 
-- Datalog query support
-  - [v] compile triple store from jsontag data
-  - [v] add query method
-  - [v] extend datalog query to allow for custom match functions
-  - [v] run /query post body in VM2 sandbox
-  - [v] immutable dataset in query vm
-  - add indexing and other optimizations
-  - add standard library of matching functions
-  - allow vanilla javascript array map/reduce/filter approach
-
 - add support for metadata on each JSON pointer path (or better: each object)
 - allow custom templates, instead of the default index.html
 - add support for access control, based on webid / openid connect
 
+<a name="license"></a>
+## License
+
+[MIT](LICENSE) © Muze.nl

package/curriculum-contexts.txt

@@ -0,0 +1,11 @@
+curriculum-basis
+curriculum-doelgroepteksten
+curriculum-erk
+curriculum-examenprogramma
+curriculum-examenprogramma-bg
+curriculum-inhoudslijnen
+curriculum-kerndoelen
+curriculum-leerdoelenkaarten
+curriculum-syllabus
+curriculum-referentiekader
+curriculum-niveauhierarchie