Clients on back(d)

JavaScript client

Mon, 01 Jan 0001 00:00:00 +0000

backd-js is a small JavaScript library for backd. It is plain ES modules with no dependencies and no build step, and it runs wherever fetch does: browsers, Node 20+, Deno, Bun and edge runtimes. It ships TypeScript declarations, so editors autocomplete it in JavaScript and TypeScript projects alike.

Install

npm install backd-js

It has no dependencies, needs no build step and works with any bundler. Without one, import it in a browser with an import map pointing at the package’s src/index.js (from a CDN such as https://cdn.jsdelivr.net/npm/backd-js/src/index.js, or from your own server), as the example app does.

Dart client

Mon, 01 Jan 0001 00:00:00 +0000

backd is a hand-written Dart client for backd, published on pub.dev as package:backd. It is pure Dart — dart:io does the transport — so it runs in Flutter apps and in standalone Dart programs (CLIs, daemons, server-side Dart), exactly like backd-js runs in browsers and Node alike.

No admin API, by design

The Dart client has no admin API. Administration is for the operator’s own tooling — the CLI, the admin UI and functions — all JavaScript, all server-side or operator-run. A client application holding admin capability is a footgun: the key that unlocks it (a bdk_… API key with the admin role, full realm access) must never ship in an app. A Dart program that truly needs the admin API calls the REST endpoints directly, knowingly.

Install

dart pub add backd # or: flutter pub add backd

The package’s only dependencies are Dart-team packages (crypto for file checksums); SSE and multipart are parsed by hand. It needs a dart:io platform — Flutter mobile and desktop, and standalone Dart. Flutter web is not supported yet (streaming responses need a package:web transport, which is a planned follow-up).

Generated types

Mon, 01 Jan 0001 00:00:00 +0000

A realm’s config already describes its API: collections and their schemas, functions and their inputs, app configuration, templates and roles. backd types turns it into one TypeScript file — or one Dart file, with --lang dart — so editors and compilers know what the API holds. Nothing is checked at runtime from the generated types; the server validates every request regardless.

CONFIG_DIR=./config backd types --realm shop --out src/backd
# wrote src/backd/types.d.ts and src/backd/realm.json (types 3f9a0c61d2b7e485)

CONFIG_DIR=./config backd types --realm shop --lang dart --out lib/backd
# wrote lib/backd/types.dart and lib/backd/realm.json (types 3f9a0c61d2b7e485)

The fingerprint is the same for both languages: they describe the same realm.

Clients on back(d)

JavaScript client

Install#

Dart client

Install#

Generated types

Install

Install