davy-jones-locker

davy-jones-locker (app shell)

Early release. The API may change between minor versions until 1.0, so pin exact versions (--save-exact, as below). Each release names the seamonster it needs.

DAVY JONES' LOCKER's browser shell: it turns SEAMONSTER's flowgraph editor into a working app. SQL runs in the browser on DuckDB-wasm, the open graph is kept between visits, and Python nodes and SQL over a database run on the framework's engine (davy-jones-locker on PyPI).

npm install --save-exact davy-jones-locker seamonster vue reka-ui @vue-flow/core @vue-flow/background

<script setup>
import { DavyJonesLocker } from 'davy-jones-locker'
import 'seamonster/style.css'
</script>

<template>
  <DavyJonesLocker title="MY APP" theme="LUX" engine-url="/engines/engine" storage-name="myapp" />
</template>

title, theme and anything else pass through to SEAMONSTER's FlowgraphEditor.

DuckDB's spatial extension (geometry, and DataIngest's KML, shapefiles, GeoPackage and GeoJSON) is served by the app itself, from extension-repository. The package's command fetches it for the DuckDB this version runs; with Vite, run it before dev and build:

"scripts": {
  "extensions": "davy-jones-locker-extensions public/duckdb-extensions",
  "predev": "npm run extensions",
  "prebuild": "npm run extensions"
}

and leave public/duckdb-extensions/ out of git. Serve its .gz copies if you can (it's 24 MB, 6 MB gzipped), and a missing file as a 404. Without it, everything but spatial SQL still works.

The engine's node kinds (an app's nodes.py, served by GET /nodes) need no code in the browser: once the engine is connected, the shell defines each kind it lists that the page doesn't already have, so they appear in the Library and menus, and nodes of them saved while the engine was away stop being placeholders. They run on the engine, in its node worker.

The parts are exported for an app that wires FlowgraphEditor itself: createEngineClient({ url, name }), duckdbSql (or createDuckdbSql({ extensionRepository })), createLocalGraphStorage(name) and defineServerKinds(client, { log }) (the above, given the engine client; returns a function that stops it).

More, including running the engine: the framework's README. Licensed under Apache 2.0.