@muze-nl/od-jsontag 0.1.4 → 0.1.5

package/README.md

@@ -1,6 +1,6 @@
 # od-jsontag: On Demand JSONTag
 
-This library implements a parser and stringifier for a variant of jsontag which is optimized so that you only need to parse objects that you use and skip parsing any other objects.
+This library implements a parser and stringifier for a variant of [JSONTag](https://github.com/muze-nl/jsontag/) which is optimized so that you only need to parse objects that you use and skip parsing any other objects.
 This is especially useful to share data between threads or other workers using sharedArrayBuffers, the only shared memory option in javascript currently.
 
 The parse function creates in memory Proxy objects that trigger parsing only when accessed. You can use the data as normal objects for most use-cases. The format supports non-enumerable 
@@ -9,3 +9,25 @@ properties, which aren't part of the normal JSONTag format. The parse function e
 The stringify function creates a sharedArrayBuffer, which represents a file with one object per line. Each line is prefixed with a byte counter that indicates the length of the line. References to other objects are encoded as ~n, where n is the line number (starting at 0).
 
 The parse function doesn't build an id index, because that requires parsing all objects. Instead the stringify function builds or updates the id index. It isn't included in the string result.
+
+In addition to the normal meta options, as defined in the [JSONTag library](https://github.com/muze-nl/jsontag/), od-jsontag adds the `meta.access` option. This must be a function like:
+
+```
+meta.access = (object, property, method) => true | false
+```
+
+If meta.access returns true, access to that property is allowed. Otherwise access is disallowed and the property value returned is `undefined`.
+
+The `method` parameter is one of `set`,`get`,`has`,`deleteProperty`,`defineProperty`.
+
+Add the access function in the meta parameter of the `parse` method:
+
+```
+import parse from 'od-jsontag'
+meta = {
+	access: (object, property, method) => {
+		return property=='name'
+	}
+}
+const root = parse(string, meta)
+```

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@muze-nl/od-jsontag",
-	"version": "0.1.4",
+	"version": "0.1.5",
 	"description": "On Demand JSONTag: parse/serialize large datastructures on demand, useful for sharing data between threads",
 	"type": "module",
 	"author": "Auke van Slooten <auke@muze.nl>",

package/src/parse.mjs

@@ -25,7 +25,9 @@ export default function parse(input, meta, immutable=true)
     if (!meta.baseURL) {
         meta.baseURL = 'http://localhost/'
     }
-
+    if (!meta.access) {
+        meta.access = () => true
+    }
     let at, ch, value, result;
     let escapee = {
         '"': '"',
@@ -688,6 +690,9 @@ export default function parse(input, meta, immutable=true)
                 } else if (prop===isChanged) {
                     return true
                 } else {
+                    if (!meta.access(target, prop)) {
+                        return undefined
+                    }
                     if (Array.isArray(target[prop])) {
                         return new Proxy(target[prop], handlers.newArrayHandler)
                     }
@@ -695,6 +700,9 @@ export default function parse(input, meta, immutable=true)
                 }
             },
             set(target, prop, value) {
+                if (!meta.access(target, prop)) {
+                    return undefined
+                }
                 if (JSONTag.getType(value)==='object' && !value[isProxy]) {
                     value = getNewValueProxy(value)
                 } 
@@ -727,6 +735,9 @@ export default function parse(input, meta, immutable=true)
                         return true
                     break
                     default:
+                        if (!meta.access(target, prop, 'get')) {
+                            return undefined
+                        }
                         if (Array.isArray(target[prop])) {
                             return new Proxy(target[prop], handlers.newArrayHandler)
                         }
@@ -735,6 +746,9 @@ export default function parse(input, meta, immutable=true)
                 } 
             },
             set(target, prop, value) {
+                if (!meta.access(target, prop, 'set')) {
+                    return undefined
+                }
                 if (JSONTag.getType(value)==='object' && !value[isProxy]) {
                     value = getNewValueProxy(value)
                 }
@@ -764,6 +778,9 @@ export default function parse(input, meta, immutable=true)
                 } else if (prop===isChanged) {
                     return target[parent][isChanged]
                 } else {
+                    if (!meta.access(target, prop, 'get')) {
+                        return undefined
+                    }
                     if (Array.isArray(target[prop])) {
                         target[prop][parent] = target[parent]
                         return new Proxy(target[prop], handlers.arrayHandler)
@@ -775,6 +792,9 @@ export default function parse(input, meta, immutable=true)
                 if (immutable) {
                     throw new Error('dataspace is immutable')
                 }
+                if (!meta.access(target, prop, 'set')) {
+                    return undefined
+                }
                 if (JSONTag.getType(value)==='object' && !value[isProxy]) {
                     value = getNewValueProxy(value)
                 } 
@@ -786,6 +806,9 @@ export default function parse(input, meta, immutable=true)
                 if (immutable) {
                     throw new Error('dataspace is immutable')
                 }
+                if (!meta.access(target, prop, 'deleteProperty')) {
+                    return undefined
+                }
                 //FIXME: if target[prop] was the last reference to an object
                 //that object should be deleted so that its line will become empty
                 //when stringifying resultArray again
@@ -799,6 +822,9 @@ export default function parse(input, meta, immutable=true)
                 firstParse(target)
                 switch(prop) {
                     case source:
+                        if (!meta.access(target, prop, 'get')) {
+                            return undefined
+                        }
                         return target
                     break
                     case isProxy:
@@ -823,6 +849,9 @@ export default function parse(input, meta, immutable=true)
                         return target[isChanged]
                     break
                     default:
+                        if (!meta.access(target, prop, 'get')) {
+                            return undefined
+                        }
                         if (Array.isArray(target[prop])) {
                             target[prop][parent] = target
                             return new Proxy(target[prop], handlers.arrayHandler)
@@ -837,6 +866,9 @@ export default function parse(input, meta, immutable=true)
                 }
                 firstParse(target)
                 if (prop!==isChanged) {
+                    if (prop!=resultSet && !meta.access(target, prop, 'set')) {
+                        return undefined
+                    }
                     if (JSONTag.getType(value)==='object' && !value[isProxy]) {
                         value = getNewValueProxy(value)
                     }
@@ -849,6 +881,9 @@ export default function parse(input, meta, immutable=true)
                 if (immutable) {
                     throw new Error('dataspace is immutable')
                 }
+                if (!meta.access(target, prop, 'deleteProperty')) {
+                    return undefined
+                }
                 firstParse(target)
                 delete target[prop]
                 target[isChanged] = true
@@ -866,10 +901,16 @@ export default function parse(input, meta, immutable=true)
                 if (immutable) {
                     throw new Error('dataspace is immutable')
                 }
+                if (!meta.access(target, prop, 'defineProperty')) {
+                    return undefined
+                }
                 firstParse(target)
                 Object.defineProperty(target, prop, descriptor)
             },
             has(target, prop) {
+                if (!meta.access(target, prop, 'has')) {
+                    return false
+                }
                 firstParse()
                 return prop in target
             },

package/src/jsontag.mjs.bak

@@ -1,65 +0,0 @@
-import JSONTag from '@muze-nl/jsontag'
-import {source} from './symbols.mjs'
-
-function getSource(obj) {
-    if (obj && Object.hasOwn(obj, source)) {
-        obj = obj[source]
-    }
-    return obj
-}
-
-export function getType(obj) {
-    obj = getSource(obj)
-    return JSONTag.getType(obj)
-}
-
-export function getAttribute(obj, attr) {
-    obj = getSource(obj)
-    return JSONTag.getAttribute(obj, attr)
-}
-
-export function getAttributes(obj) {
-    obj = getSource(obj)
-    return JSONTag.getAttributes(obj)
-}
-
-export function getAttributeString(obj) {
-    obj = getSource(obj)
-    return JSONTag.getAttributesString(obj)
-}
-
-export function getTypeString(obj) {
-    obj = getSource(obj)
-    return JSONTag.getTypeString(obj)
-}
-
-export function isNull(obj) {
-    obj = getSource(obj)
-    return JSONTag.isNull(obj)
-}
-
-export function setAttribute(obj, attr, value) {
-    obj = getSource(obj)
-    return JSONTag.setAttribute(obj, attr, value)
-}
-
-export function setAttributes(obj, attr) {
-    obj = getSource(obj)
-    return JSONTag.setAttribute(obj, attr)
-}
-
-export function setType(obj, type) {
-    obj = getSource(obj)
-    return JSONTag.setType(obj, type)
-}
-
-export function addAttribute(obj, attr, value) {
-    obj = getSource(obj)
-    return JSONTag.addAttribute(obj, attr, value)
-}
-
-export function removeAttribute(obj, attr) {
-    obj = getSource(obj)
-    return JSONTag.removeAttribute(obj, attr)
-}
-

package/src/jsontag.mjs~

@@ -1,65 +0,0 @@
-import JSONTag from '@muze-nl/jsontag'
-import {source} from './symbols.mjs'
-
-function getSource(obj) {
-    if (obj.hasOwnProperty(source)) {
-        obj = obj[source]
-    }
-    return obj
-}
-
-export function getType(obj) {
-    obj = getSource(obj)
-    return JSONTag.getType(obj)
-}
-
-export function getAttribute(obj, attr) {
-    obj = getSource(obj)
-    return JSONTag.getAttribute(obj, attr)
-}
-
-export function getAttributes(obj) {
-    obj = getSource(obj)
-    return JSONTag.getAttributes(obj)
-}
-
-export function getAttributeString(obj) {
-    obj = getSource(obj)
-    return JSONTag.getAttributesString(obj)
-}
-
-export function getTypeString(obj) {
-    obj = getSource(obj)
-    return JSONTag.getTypeString(obj)
-}
-
-export function isNull(obj) {
-    obj = getSource(obj)
-    return JSONTag.isNull(obj)
-}
-
-export function setAttribute(obj, attr, value) {
-    obj = getSource(obj)
-    return JSONTag.setAttribute(obj, attr, value)
-}
-
-export function setAttributes(obj, attr) {
-    obj = getSource(obj)
-    return JSONTag.setAttribute(obj, attr)
-}
-
-export function setType(obj, type) {
-    obj = getSource(obj)
-    return JSONTag.setType(obj, type)
-}
-
-export function addAttribute(obj, attr, value) {
-    obj = getSource(obj)
-    return JSONTag.addAttribute(obj, attr, value)
-}
-
-export function removeAttribute(obj, attr) {
-    obj = getSource(obj)
-    return JSONTag.removeAttribute(obj, attr)
-}
-