docs: record the 1.1.0 release and add the infrastructure map
Some checks failed
deploy-site / deploy (push) Failing after 40s
Some checks failed
deploy-site / deploy (push) Failing after 40s
Release notes for 1.1.0 were split between an Unreleased section and the version section, so the published notes would have omitted the update-feed and desktop changes. Everything shipping in this version now sits under one `## [1.1.0]` heading. `docs/map/` becomes the entry point for what infrastructure exists per platform and how far each feature is developed, with a documented update protocol so feature work and this map do not drift apart again. The release guide now states that installer binaries live in the update feed rather than the repository.
This commit is contained in:
parent
c2db1b2176
commit
c3ddd36c6f
29 changed files with 3207 additions and 23 deletions
108
docs/map/03-shared-packages.md
Normal file
108
docs/map/03-shared-packages.md
Normal file
|
|
@ -0,0 +1,108 @@
|
|||
# 03 — Shared Packages Map
|
||||
|
||||
> Surface: `packages/*` (npm workspaces)
|
||||
> Source of truth for: shared domain logic, design systems, i18n, API client
|
||||
|
||||
All packages are private, version `1.1.0`, source-only (`main`/`types` point at `src`).
|
||||
|
||||
---
|
||||
|
||||
## 1. `@d3ro/core` — business logic SSOT (`packages/core`)
|
||||
|
||||
The canonical place for types and cross-surface logic. Both desktop and web/mobile depend on it.
|
||||
|
||||
| Area | Exports | Notes |
|
||||
|---|---|---|
|
||||
| Types | `./types` | Domain types shared across surfaces |
|
||||
| Errors | `./errors` | `D3ROError`, `ErrorCode` |
|
||||
| IPC channels | `./ipc-channels` | `IPC_CHANNELS` object + `IPCChannel` union. **SSOT** for every desktop IPC channel (VOICE, AUDIO, STT, TTS, LLM, HOTKEY, CONFIG, HISTORY, DICTIONARY, WINDOW, SYSTEM, STATS, MEMO, VOICE_COMMAND, CONTEXT, CHAIN, CAPTION, FILE_TRANSCRIPTION, MEETING_SUMMARY, DICTATION_TEMPLATE, VOICE_CONVERSATION, RAG, VOICE_ACTION, MEETING_MODE, MEETING_DOC_TEMPLATE, MEETING_CHAT, LICENSE, CLOUD_SYNC, INSTRUCTION, SYSTEM_AUDIO, POPUP_RESULT, POPUP_HISTORY, POPUP_COMMAND, POPUP_CAPTION, VOICE_PARTIAL, CLIPBOARD, APP, ONLINE_AUTH, ADS, SUPPORT, PAYMENT) |
|
||||
| Constants | `./constants` | Shared constants |
|
||||
| Crypto license | `./utils/crypto-license` | Ed25519 license sign/verify (used by admin issuer + desktop verifier) |
|
||||
| PII | `pii-redactor`, `secure-memory` | Redaction + secure memory helpers |
|
||||
| Supabase config | `supabase-config` | Shared Supabase config shape |
|
||||
| Entitlement | `./entitlement` | `EntitlementTier`, `AdminRole`, `EntitlementSnapshot`, `resolveEntitlement`, `normalizeEntitlementTier`/`normalizeAdminRole` — canonical tier/role contract across Supabase, desktop license, and .NET |
|
||||
| Doc utils | `./utils/meeting-markdown`, `./utils/markdown-to-docx` | Meeting Markdown export + DOCX generation (dep: `docx`) |
|
||||
|
||||
**When to change:** new cross-surface type, new error code, new IPC channel, license format. Add here first, then consume.
|
||||
|
||||
---
|
||||
|
||||
## 2. `@d3ro/ui` — web/desktop design system (`packages/ui`)
|
||||
|
||||
| Export | Contents |
|
||||
|---|---|
|
||||
| `.` | Barrel |
|
||||
| `./theme` | `theme.ts` — `d3roPalette`, `d3roTypo` (13 steps), `d3roShadow` (10), `d3roRadius` (7); 6 themes (dark/Midnight, light, nord, solarized, catppuccin, dracula) + build helpers |
|
||||
| `./theme-vars` | CSS variable map for popups/vanilla surfaces |
|
||||
| `./components/ds` | MUI/Emotion DS components: CrtDisplay, InstrumentPanel, Led, PhysicalButton, MetalCard, PhosphorText (13 variants), MetalDial, ScreenPanel, ButtonGroup, TiltCard, GradientWave, StatRing |
|
||||
|
||||
Peers: React 19, MUI 7, Emotion 11. Depends on `@d3ro/core`.
|
||||
|
||||
**Theme SSOT rule:** never hardcode hex outside `theme.ts`; use `d3roPalette`/`d3roShadow` tokens. `accent.amber` was removed in Wave 2; use `accent.main`.
|
||||
|
||||
---
|
||||
|
||||
## 3. `@d3ro/ui-native` — React Native design system (`packages/ui-native`)
|
||||
|
||||
| Provides |
|
||||
|---|
|
||||
| `NativeThemeProvider` / `useNativePalette`, native palette/typo/radius/fonts |
|
||||
| Components: `MetalCard`, `PhosphorText`, `Led`, `PhysicalButton`, `ScreenPanel`, `WaveBars`, `AppStatusBar`, `Header`, `FilterChip` |
|
||||
|
||||
Peers: `react`, `react-native`. Consumed by `apps/mobile-rn` via file: workspace dependencies.
|
||||
|
||||
---
|
||||
|
||||
## 4. `@d3ro/i18n` — internationalization (`packages/i18n`)
|
||||
|
||||
| Provides | Notes |
|
||||
|---|---|
|
||||
| 12 locales | `ko` (master), `en`, `ja`, `zh`, `zh-TW`, `es`, `fr`, `de`, `pt`, `ru`, `vi`, `th` in `src/locales/` |
|
||||
| Type-safe keys | `TranslationKey` derived from `ko.json` |
|
||||
| React context | `I18nProvider`, `useI18n`, `TFunction` |
|
||||
| Fallback chain | locale → `en` → `ko` → key |
|
||||
| Formatters | `formatDate`, `formatNumber`, `formatRelativeDate`, `formatTime` via `Intl` |
|
||||
| Storage injection | `I18nStorage` adapter (localStorage on web, AsyncStorage on mobile) |
|
||||
|
||||
Electron-independent. Rule: no hardcoded Korean/English strings in UI; use `t()`.
|
||||
|
||||
---
|
||||
|
||||
## 5. `@d3ro/api-client` — Supabase wrapper (`packages/api-client`)
|
||||
|
||||
| Export | Purpose |
|
||||
|---|---|
|
||||
| `client` | Base Supabase client factory |
|
||||
| `auth` | Auth helpers |
|
||||
| `meetings` | Meeting queries |
|
||||
| `history` | History queries |
|
||||
| `usage` | Usage queries |
|
||||
| `transcribe` | STT calls |
|
||||
| `supabase-browser` | Browser client (`getSupabaseBrowserClient`, `isSupabaseConfigured`) |
|
||||
| `supabase-server` | Server client (`createSupabaseServerClient`) |
|
||||
| `types` | Shared DB/domain types — **canonical; do not redefine table types per app** |
|
||||
|
||||
Deps: `@d3ro/core`, `@supabase/supabase-js`; optional peer `@supabase/ssr`. Tests: `__tests__/` (client, transcribe, types) via vitest.
|
||||
|
||||
Consumed by `apps/web`, `apps/admin` (via re-exports), `apps/mobile-rn`, and desktop cloud paths.
|
||||
|
||||
---
|
||||
|
||||
## 6. Dependency direction
|
||||
|
||||
```
|
||||
@d3ro/i18n (standalone)
|
||||
@d3ro/ui → @d3ro/core
|
||||
@d3ro/ui-native(standalone, peers react-native)
|
||||
@d3ro/api-client → @d3ro/core
|
||||
@d3ro/core (standalone)
|
||||
```
|
||||
|
||||
Apps depend on packages, never the reverse. Shared package changes ripple to all consumers (see `docs/REFACTOR_POLICY.md`).
|
||||
|
||||
---
|
||||
|
||||
## 7. Package-level gaps
|
||||
|
||||
- `apps/mobile-rn` is not an npm workspace member, so root `typecheck`/`test` skip it; use `typecheck:mobile`/`lint:mobile`/`test:mobile` from the repo root.
|
||||
- No versioned publishing of packages (private, source-only); all consumers are in-repo.
|
||||
Loading…
Add table
Add a link
Reference in a new issue