@auraone/aura-ide-kit 0.2.0

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,148 @@
1
+ # Aura IDE Kit
2
+
3
+ `@auraone/aura-ide-kit` is the IDE-class React component layer shared by the
4
+ AuraOne Open Studios. It extends Proofline OSS with project trees, split panes,
5
+ Monaco, timelines, inspectors, command surfaces, evidence logs, settings, and
6
+ desktop-oriented state handling.
7
+
8
+ **For:** Studio maintainers who need a consistent desktop/browser IDE shell
9
+ without rebuilding complex interaction and accessibility behavior per product.
10
+
11
+ **Differentiator:** every export has an explicit SSR posture, and components
12
+ graduate into Proofline only after multi-product use proves a stable,
13
+ product-neutral public contract.
14
+
15
+ ## Install From Source
16
+
17
+ Status verified on **July 13, 2026**: version `0.2.0` passes its package gates
18
+ but is not yet published on the public npm registry. Use `workspace:*` from the
19
+ canonical source checkout until registry authorization is restored.
20
+
21
+ From the `open-studio-platform` root:
22
+
23
+ ```bash
24
+ corepack enable
25
+ pnpm install --frozen-lockfile
26
+ pnpm --dir packages/aura-ide-kit build
27
+ ```
28
+
29
+ The package allowlist contains `dist/`, `examples/`, and this README.
30
+
31
+ ## SSR Posture
32
+
33
+ Every exported component is declared in `src/ssr-posture.ts` as `ssr-safe`,
34
+ `client-only`, or `client-only-with-suspense`.
35
+
36
+ - `AuraMonaco` is `client-only-with-suspense`.
37
+ - Static display primitives are `ssr-safe`.
38
+ - Shell, palette, resize, modal, toast, settings, and tab-selection surfaces
39
+ are `client-only`.
40
+
41
+ Consumers should use the posture map rather than inferring SSR safety from a
42
+ component name.
43
+
44
+ ## Source Of Truth
45
+
46
+ - Canonical public tokens and primitives:
47
+ `packages/proofline-oss/`
48
+ - IDE component incubation:
49
+ `packages/aura-ide-kit/`
50
+ - Compatibility boundary: legacy `--ag-*` aliases may support existing
51
+ flagships, but new code uses Proofline semantic tokens.
52
+
53
+ Components graduate into Proofline OSS only after they are stable in at least
54
+ two flagships, have an accessible public contract, and can be supported without
55
+ product-specific assumptions.
56
+
57
+ ## Components
58
+
59
+ - `AuraIdeAppFrame`
60
+ - `AuraSplitPane`
61
+ - `AuraProjectTree`
62
+ - `AuraMonaco`
63
+ - `AuraTimeline`
64
+ - `AuraInspector`
65
+ - `AuraCommandPalette`
66
+ - `AuraStatusBar`
67
+ - `AuraProblemsPanel`
68
+ - `AuraSettingsPanel`
69
+ - `AuraWelcomePrivacyWizard`
70
+ - `AuraUpdatePrompt`
71
+ - `AuraIntakeIdentityFields`
72
+ - `AuraKeychainFallbackWarning`
73
+ - `AuraToastProvider`
74
+ - `AuraModal`
75
+ - `AuraEmptyState`, `AuraLoadingState`, `AuraErrorState`
76
+ - `AuraTelemetryEventLog`
77
+ - `AuraIntakePacketPreview`
78
+ - `AuraFileWatcherStatus`
79
+ - `AuraWelcomeWindow`
80
+ - `AuraTabbedShell`
81
+
82
+ ## Usage
83
+
84
+ ```tsx
85
+ import {
86
+ AuraIdeAppFrame,
87
+ AuraCommandPalette,
88
+ createCommandRegistry,
89
+ } from "@auraone/aura-ide-kit";
90
+ import "@auraone/aura-ide-kit/styles.css";
91
+
92
+ const registry = createCommandRegistry();
93
+ registry.register({
94
+ id: "project.open-folder",
95
+ title: "Open Folder",
96
+ group: "Project",
97
+ keybinding: "Mod+O",
98
+ handler: () => openFolder(),
99
+ });
100
+ ```
101
+
102
+ ## Runtime, Data, And Network Boundary
103
+
104
+ - The supported peer runtime is React and React DOM `18.3.1`.
105
+ - Monaco and shell interactions require a browser-like client runtime;
106
+ consumers remain responsible for suspense and client boundaries.
107
+ - The package renders UI and invokes consumer callbacks. It does not own
108
+ product persistence, provider calls, file uploads, telemetry delivery,
109
+ updater transport, or keychain storage.
110
+ - Product links and intake/privacy surfaces are declarations and user actions,
111
+ not an ambient backend connection.
112
+
113
+ ## Font And Asset Boundary
114
+
115
+ Aura IDE Kit inherits Proofline's public-asset contract. It ships no private
116
+ licensed font binary and requires no remote font request. Public packages use
117
+ system fallbacks. An authorized branded deployment may provide licensed
118
+ typography only through a host-owned stylesheet on an approved same-origin
119
+ path; failure to load it must fall back cleanly to the public system stacks.
120
+ Temporary loopback font delivery is permitted only for isolated capture
121
+ verification and never for package contents.
122
+
123
+ ## Proof
124
+
125
+ ```bash
126
+ pnpm --dir packages/aura-ide-kit typecheck
127
+ pnpm --dir packages/aura-ide-kit test
128
+ pnpm --dir packages/aura-ide-kit build
129
+ ```
130
+
131
+ Tests cover component contracts, command registration, focus and keyboard
132
+ behavior, accessible semantics, and the SSR posture inventory. The built
133
+ tarball surface is limited by the package `files` allowlist.
134
+
135
+ ## Release Truth
136
+
137
+ The `0.2.0` source candidate passes typecheck, component tests, accessibility
138
+ checks, SSR-posture verification, and packed-file inspection. Do not document
139
+ an npm install command until the registry exposes the exact version and
140
+ integrity record.
141
+
142
+ ## Next Action
143
+
144
+ Use the pinned workspace package for current source development. The first npm
145
+ release must publish the exact tested `0.2.0` tarball with valid registry write
146
+ authorization, then verify its exports, React peer contract, SSR posture,
147
+ accessibility checks, README, and integrity record before adding a public
148
+ install command.