@franzzemen/brokenstock-shell 0.0.2 → 0.0.4
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md
ADDED
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
# @franzzemen/brokenstock-shell
|
|
2
|
+
|
|
3
|
+
Shared Angular shell library for Brokenstock web applications. Provides the foundational layout (resizable command terminal, side menu, status bar), authentication infrastructure, command dispatch pipeline, and theming — all configured via injection tokens so consuming apps supply only their domain-specific commands, menu items, and status content.
|
|
4
|
+
|
|
5
|
+
## Documentation
|
|
6
|
+
|
|
7
|
+
| Document | Audience | Description |
|
|
8
|
+
|----------|----------|-------------|
|
|
9
|
+
| [brokenstock-shell.intent.md](doc/intent/brokenstock-shell.intent.md) | AI agents | Purpose, design invariants, boundaries, guidance |
|
|
10
|
+
| [brokenstock-shell.guide.md](doc/guide/brokenstock-shell.guide.md) | Engineers (maintainers) | Architecture, service internals, component structure, build/publish |
|
|
11
|
+
| [brokenstock-shell.usage.md](doc/usage/brokenstock-shell.usage.md) | Engineers (consumers) | Installation, setup examples, API reference, type quick reference |
|
|
12
|
+
|
|
13
|
+
## Core Concepts
|
|
14
|
+
|
|
15
|
+
- **Injection token configuration:** `SHELL_APP_NAME`, `SHELL_AUTH_URLS`, `SHELL_MENU_ITEMS`, `SHELL_COMMANDS`
|
|
16
|
+
- **Content projection:** App-specific status bar items projected through `<shell-root>` into the status bar
|
|
17
|
+
- **Command pattern:** `@Injectable` classes implementing `CommandDefinition`, registered via `SHELL_COMMANDS` token
|
|
18
|
+
- **Signal-based state:** All services use Angular signals; no RxJS in public APIs
|
|
19
|
+
- **Peer dependencies:** Angular 21, Material, CDK, @franzzemen/identity, @franzzemen/utility, zod, rxjs
|