@muze-nl/simplystore 0.4.4 → 0.4.6

package/README.md

@@ -3,9 +3,11 @@
 SimplyStore is a radically simpler backend storage server. It does not have a database, certainly no SQL or GraphQL, it is not REST. In return it has a well defined API that is automatically derived from your dataset. It supports JSONTag to allow for semantically meaningful data, without having to do the full switch to Linked Data and triple stores. The query format is javascript, you can post javascript queries that will run on the server. All data is read into memory and is available to these javascript queries without needing (or allowing) disk access or indexes.
 
 [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.
+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.
 
+Note: _There are known security issues in VM2, so the project will switch to V8-isolate. For now don't use SimplyStore in production_
+
 ## Table of Contents
 
 - [Background](#background)
@@ -103,12 +105,28 @@ from(data.persons)
 })
 ```
 
-See the [array-where-select](https://www.npmjs.com/package/array-where-select) package for more information about the query possibilities.
+See the [query documentation](docs/queries.md) 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.
 
+## Example SimplyStore server
+
+The example directory contains a server that uses SimplyStore to serve a
+Star Wars API. 
+
+To start it:
+
+```shell
+cd example/
+npm install
+npm start
+```
+
+Now go to http://localhost:3000/query/ and you can run all the example
+queries from the [query documentation](docs/queries.md)
+
 <a name="goals"></a>
 ## Goals of this project
 
@@ -144,6 +162,8 @@ In addition, SimplyStore is meant to be a real-world testcase for JSONTag.
 - 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
+- switch from VM2 to V8-isolate, which is more secure
+- switch the server runtime to Rust, so SimplyStore can share immutable data between threads
 
 <a name="license"></a>
 ## License

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@muze-nl/simplystore",
-	"version": "0.4.4",
+	"version": "0.4.6",
 	"main": "src/server.mjs",
 	"type": "module",
 	"scripts": {
@@ -17,7 +17,7 @@
 	"homepage": "https://github.com/simplyedit/simplystore#readme",
 	"dependencies": {
 		"@muze-nl/jsontag": "^0.8.6",
-		"array-where-select": "^0.4.2",
+		"array-where-select": "^0.4.4",
 		"codemirror": "^6.0.1",
 		"express": "^4.18.1",
 		"json-pointer": "^0.6.2",

package/src/worker-query.mjs

@@ -1,6 +1,6 @@
 import JSONTag from "@muze-nl/jsontag"
 import pointer from 'json-pointer'
-import {_,from,not,anyOf,allOf,asc,desc} from 'array-where-select'
+import {_,from,not,anyOf,allOf,asc,desc,sum,count,avg,max,min} from 'array-where-select'
 import {deepFreeze} from './util.mjs'
 import {VM} from 'vm2'
 
@@ -115,6 +115,11 @@ export function runQuery({pointer, request, query}) {
                 allOf,
                 asc,
                 desc,
+                sum,
+                count,
+                avg,
+                max,
+                min,
 //                    console: connectConsole(res),
                 JSONTag,
                 request