Skip to content

docs: rules for running a module inside a thin client - #11

Draft
gdarko wants to merge 1 commit into
masterfrom
docs/client-compatibility
Draft

gdarko wants to merge 1 commit into
masterfrom
docs/client-compatibility

Conversation

@gdarko

@gdarko gdarko commented Sep 22, 2026

Copy link
Copy Markdown
Contributor

The InvoiceShelf mobile clients run the same frontend as a static app package pointed at the user's server, and they load modules from that server at boot. A module that follows the SDK already works there. This writes down the four rules that make that true, in the typings where authors read them and in the README: call the API only through extensions.client, never hardcode root-relative /api or /storage URLs, ship self-contained CSS, and register local asset paths rather than remote URLs.

Comments and prose only; no type changes. Both official modules were audited against the rules and pass.

The mobile clients load modules from the connected server at boot. Four rules keep a module working there, documented on the extension API typings and in the README: API calls through extensions.client only, no root-relative /api or /storage URLs, self-contained CSS, local asset paths rather than remote URLs.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant