Sanbox feature

[TEMMA-CATS]

Hi,

Could you please give me a complete example in order to know how to use sandbox option.

{
  "firstName": "John",
  "lastName" : "doe",
  "mainPhoneType": "home",
  "age"      : 26,
  "address"  : {
    "streetAddress": "naist street",
    "city"         : "Nara",
    "postalCode"   : "630-0192"
  },
  "phoneNumbers": [
    {
      "type"  : "iPhone",
      "number": "0123-4567-8888"
    },
    {
      "type"  : "home",
      "number": "0123-4567-8910"
    }
  ]
}

This JsonPath expression:

$.phoneNumbers[?(@.type == "home")].number

return

[
  "0123-4567-8910"
]

I try to use sandbox with map:

{
  "${mainPhoneType}": "home"
}

and

JSONPath({
      path: "$.phoneNumbers[?(@.type == '${mainPhoneType}')].number", wrap: true, json: json, flatten: true, sandbox: sandbox,
    });

but it returns empty array [ ]

Normally from doc it could replace ${mainPhoneType} by home in expression, no?

[80avin]

Assuming you have

const json = {
  "firstName": "John",
  "lastName" : "doe",
  "mainPhoneType": "home",
  "age"      : 26,
  "address"  : {
    "streetAddress": "naist street",
    "city"         : "Nara",
    "postalCode"   : "630-0192"
  },
  "phoneNumbers": [
    {
      "type"  : "iPhone",
      "number": "0123-4567-8888"
    },
    {
      "type"  : "home",
      "number": "0123-4567-8910"
    }
  ]
}

This is wrong ❌

const sandbox = {
  "${mainPhoneType}": "home"
}
JSONPath({
      path: "$.phoneNumbers[?(@.type == '${mainPhoneType}')].number", wrap: true, json: json, flatten: true, sandbox: sandbox,
    });
// []

This is right ✅

const sandbox = {
  "mainPhoneType": "home"
}
JSONPath({
      path: "$.phoneNumbers[?(@.type == mainPhoneType)].number", wrap: true, json: json, flatten: true, sandbox: sandbox,
    });
// [ "0123-4567-8910" ]

You can find more examples by searching sandbox
Example here:

JSONPath/test/test.eval.js

Lines 71 to 72 in 9ffc9bd

	sandbox: {category: 'reference'},
	path: "$..[?(@.category === category)]", wrap: false,

[TEMMA-CATS]

Thanks for your answer @80avin

If I understand what you say, sandbox offers the possibility to replace variable. But I can't use character $,{, } . alphanumeric characters only?
You know which characters I can use?

[80avin]

@TEMMA-CATS The sandbox injected values are treated as normal global variables.
They should be named as any other identifier in javascript.