Record-level ACL
Role-based access control decides which methods a caller may invoke. The record-level ACL
Adapter
Adapters are components within the framework that take care of integration with external systems.
API
The framework works with several API concepts, which are used in different contexts and have
Architecture
The framework offers flexibility during deployment, in what may be called "bring your own
Blob
A blob is a piece of content the framework stores for you and names for you: a photograph on a
Model System
The model system is the primary way that application realms contribute user interface pages to a
Browser UI
The browser platform extends the Blong framework to deliver rich, metadata-driven user interfaces
Chain
A chain is what a test handler returns: an ordered list of steps, written in the order a person
Checkpoint
A checkpoint is a framework-provided function that records progress through multi-step operations.
Code Coverage
Code coverage measures which lines, branches, and functions of the source code are exercised during
Configuration
Blong's configuration is one object, built by merging several sources in a fixed order and handed to
Definitions
We will use the following definitions:
Deletion
A model says how deleting one of its records resolves, and the generated browse page obeys it. There
Dependencies
Blong is built on top of other great open source packages:
Editor Features
The Editor component is the most important and complex feature of the blong-browser framework. It
Typed Errors
The framework expects all errors generated within it to have some additional properties, on top of
Expected Errors
When writing automated tests it is common to assert that a call should fail with a specific
Feedback mode
Feedback mode turns a running application into something a person can annotate where they see the
Gateway
The gateway, also known as the "API Gateway", is the public facing interface of the server. It
Glossary
Short definitions of the vocabulary this repository uses with a meaning of its own. Each entry names
Intents
Intents are named signals passed as positional CLI arguments to the blong command. They tell
Interactions
The framework provides concepts for varying interactions. The interactions define specific paths
Kukum
kukum = to cook in Bislama
Kustomize
Deploying a suite means turning its graph — realms, layers, orchestrator namespaces — into cluster
Layer
Layers are named groups of handlers. The names of layers can be arbitrary (though must be valid
lukaot
lukaot is one declared vocabulary for everything a process reports: the lines it logs, the
Memory files
The repository keeps four kinds of working note — frictions, todos, decisions and
Modules
Blong is entirely based on TypeScript and ECMAScript modules, because more and more open source
Naming
In Blong a handler has exactly one name, and that name appears unchanged at every level: the file it
Open API
The official OpenAPI standard is a central part of the framework. Implementing or calling APIs is
Orchestrator
The role of the orchestrator is to provide an intermediate point in the architecture where the
Full-Stack Testing with Playwright
Full-stack testing verifies the entire application stack — from the browser UI through the React
RBAC (Role-Based Access Control)
Blong answers "may this caller invoke this method?" from a graph of resources — a user holds roles,
Realm
To achieve a modular approach, the business logic is separated into different realms. This enables
The Resource Graph
Blong stores entities in tables and the relationships between them in one graph. A person, an
Declarative Schema Management (knex adapter)
The built-in adapter.knex includes a declarative schema management feature that lets a realm
Sessions, Refresh Tokens & Audit
Authentication in Blong issues access tokens (short-lived JWTs) that the gateway verifies
Suite
Suites are the top-level organizational unit in the framework. They are used to group related realms
Test runs
A Test runs page is a portal page that starts an automated test scenario and shows the run while
Watch
Watch mode, or server-side hot reload, is a central part of the framework. "Watch" mode has become a