SDK Overview
@atomm-developer/generator-sdk is the platform capability layer for generators.
It gives a generator access to platform services, but it does not define the shell UI and it does not replace the runtime contract.
What The SDK Owns
- authentication
- cloud save and restore
- history
- credits
- billing
- export download and open-in-Studio
- template helpers
What The SDK Does Not Own
- generator business state
- runtime mounting protocol
- canvas rendering
- parameter panel layout
- top bar and shell UI
If you need the official shell, read Generator Workbench.
If you need host/runtime protocol details, read Runtime Contract.
Module Map
| Module | Object | Responsibility | Requires Login |
|---|---|---|---|
| Auth | sdk.auth | Login, logout, status query, status listener | No |
| Cloud | sdk.cloud | Save, restore, delete cloud records | Yes |
| History | sdk.history | List, detail, delete history records | Yes |
| Credits | sdk.credits | Credits balance and credits deduction | Yes |
| Billing | sdk.billing | Unified consumption flow | Yes |
| Export | sdk.export | Download and open in Studio | No |
| Template | sdk.template | Template build, parse, import, and runtime snapshot conversion | No |
| Helper | withBilling | Wrap an action with billing checks and consumption | Yes |
Recommended Integration Order
- Install the packages
- Initialize
GeneratorSDK - Add the capability modules your generator actually needs
- Decide whether to use Generator Workbench
- If the generator supports multiple hosts, implement Runtime Contract
Common Mistakes
- Treating
generator-sdkas if it were the shell - Importing modules before clarifying the actual generator capabilities needed
- Claiming standardization is complete after SDK integration alone