pico-engine-browser

pico-engine-browser

An implementation of the pico-engine targeting web browsers

How it works

This project bundles pico-engine into a single .js file that can be run inside a web browser.

src/index.js is the main entry point.

To build it

npm run build

The output is dist/pico-engine.js and dist/pico-engine.min.js

How to use it

<script src="pico-engine.min.js"></script>
<script>
async function main(){
  // start it up
  var pe = await PicoEngine();
  window.pe = pe;// make it global so we can use it in the devtools console

  console.log('started');

  // now you can use pe (instance of pico-engine-core)
  // i.e.
  var res = await pe.registerRulesetURL('https://raw.githubusercontent.com/Picolab/pico-engine/master/test-rulesets/hello-world.krl');
  console.log(res);


  var rootECI = await pe.getRootECI()

  var myself = await pe.runQuery({
    eci: rootECI,
    rid: 'io.picolabs.wrangler',
    name: 'myself'
  })

  console.log('myself:', myself);
}
main().catch(console.error)
</script>

Multiple engine instances

If you want to run more than one instance of pico-engine inside the same browser, you need to provide a browser-unique name.

For example:

var pe1 = await PicoEngine('engine1');
var pe2 = await PicoEngine('engine2');

License

MIT

Changelog

1.0.1 - January 5, 2021

• functions can be queried requesting either HTML or plain text results (per docs)
• event:send which allows ruleset evaulation to continue even if the ECI is not found
• new Subscriptions tab in the developer UI and dashed magenta lines between subscription pico pairs
• new built-in meta library to match the one in 0.52.4, with docs
• new built-in property ctx:picoId
• fixes for issues 488, 490, 473, 489, 486, 501, 480, 491, 500, 502, 487, 513, 512, 503, and 518
• the io.picolabs.subscription ruleset installed in all picos
• command line --version option for pico-engine command
• new and simplified io.picolabs.wrangler ruleset in all picos
• show line/col numbers for parse and compile errors
• allow access to event attributes within functions (when called from an event context)
• ursa module for cryptographic needs of DIDs, and its dependencies