ACL
Putting the record-level ACL on a table, writing rules and verifying them. The blong-access README
Adapter
Blong includes the following commonly used adapters:
The agent engine
An agent is a process that works a task in a workspace and talks to a person when it cannot decide
Blob Store
Overview
Modular UI
How to wire blong-browser into a suite and write UI pages for a realm.
blong-dev: the development CLI
blong-dev is the command line the repository is worked with — by people at a terminal and by
Schema based UI
How to define model specs in a realm.
Realm CLI
How to give a realm a command-line entry point: a process that binds no port, watches nothing,
Codec
Use codecs to implement protocols on top of lower-level ones.
Commander: one explorer for every backend
Data stores are boring in the same way and different in the same ways: each has a hierarchy, a list
Configuration
Blong comes with a flexible configuration mechanism, which allows the configuration to be specified
Cucumber / Gherkin Testing
Overview
Deletion modes
How to declare what deleting a record does, per model.
Continuous deployment to a local k3d cluster
The repository deploys a suite the same way a released product would: an operator converges a
EIP patterns
Enterprise Integration Patterns (EIP) are a
Error
The patterns below can be used to define and throw typed errors within the
Feedback mode
A portal can let people annotate the running application and hand the result to a reviewer, who
Foreign key columns and their labels
A table cell holds what the record holds. For a foreign key that is a key — a base64 resource id
Formatting values
One function turns a stored value into the text a reader sees: a date column, a date input and a
Handler
Handlers are functions that are called by adapters and orchestrators to implement certain
Internationalisation
blong-browser has a lightweight translation system built on appStore, and the convention that
Folder mode and scaffolding
There is no project to generate before you can run something. A folder with a couple of handler
Kukum
How to call the kukum API, and how to extend it when the framework or its primitives change.
Kustomize deployment
How to generate and apply a suite's manifests.
Layer
Layers are named groups of handlers that organise code by functional concern within a realm. For the
Real-Time Log
The Blong framework ships with a real-time log viewer. When the framework is running locally, a log
The flows a run observes
Two transfer topologies live in core/lukaot/flow/: real HTTP between real processes, every
lukaot
How to declare a vocabulary and call it. This page is organised by the four kinds — the call
Memory files
How to add, correct, find and verify the repository's frictions, todos, decisions and questions. For
Meta
To implement various kinds of functionality the framework uses a metadata object, which is passed to
Server-side testing with mocks
When writing integration tests for handlers that call external systems (databases, downstream
Mojaloop Payment Flow
This is included as reference for the the flows a run observes
Orchestrator
Blong includes the following commonly used orchestrators:
Plan tracking
How a plan is written, approved, executed and reported. A plan is three things at once: a local
Playwright Testing
This page covers the practical patterns for writing full-stack Playwright tests in a Blong suite.
RBAC
Seeding, granting and verifying role-based access control. The blong-access README documents the
Realm
A realm is a business domain boundary. Realms are scaffolded with the
A realm's filesystem over REST
The framework can serve a folder over HTTP, and a VS Code extension implements a filesystem on top
REST
Server
RPC
The RPC mechanism is based on JSON-RPC 2.0 specification,
DB Schema Management
This page provides implementation details for the declarative schema management feature of
Suite
To define a suite follow the patterns below.
Templates
@feasibleone/blong-template renders JavaScript template literals — $ inside a string
Test API Entry Point
Before test handlers run, the suite needs an index.ts that loads the platform(s), starts them, and
Integration tests with real back ends
An adapter should be tested against the system it will meet. When that system cannot run in a
Test runs console
A realm contributes a Test runs page with four small pieces: a page handler, a catalog, the page
Test
Test handlers
Themes and visual variants
A theme decides how the application looks without deciding what it does. The same pages, the same
Validation
Validations are used to describe the internal API.
Webhook
The webhook adapter is the one place a Blong process is reached rather than reaching: a platform