@fasl-work/caos-app-shell 0.1.2 → 0.3.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/LICENSE +201 -0
- package/README.md +68 -59
- package/dist/index.d.ts +157 -1
- package/dist/index.js +312 -21
- package/package.json +56 -54
- package/styles.css +242 -221
package/LICENSE
ADDED
|
@@ -0,0 +1,201 @@
|
|
|
1
|
+
Apache License
|
|
2
|
+
Version 2.0, January 2004
|
|
3
|
+
http://www.apache.org/licenses/
|
|
4
|
+
|
|
5
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
|
6
|
+
|
|
7
|
+
1. Definitions.
|
|
8
|
+
|
|
9
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
|
10
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
|
11
|
+
|
|
12
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
|
13
|
+
the copyright owner that is granting the License.
|
|
14
|
+
|
|
15
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
|
16
|
+
other entities that control, are controlled by, or are under common
|
|
17
|
+
control with that entity. For the purposes of this definition,
|
|
18
|
+
"control" means (i) the power, direct or indirect, to cause the
|
|
19
|
+
direction or management of such entity, whether by contract or
|
|
20
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
|
21
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
|
22
|
+
|
|
23
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
|
24
|
+
exercising permissions granted by this License.
|
|
25
|
+
|
|
26
|
+
"Source" form shall mean the preferred form for making modifications,
|
|
27
|
+
including but not limited to software source code, documentation
|
|
28
|
+
source, and configuration files.
|
|
29
|
+
|
|
30
|
+
"Object" form shall mean any form resulting from mechanical
|
|
31
|
+
transformation or translation of a Source form, including but
|
|
32
|
+
not limited to compiled object code, generated documentation,
|
|
33
|
+
and conversions to other media types.
|
|
34
|
+
|
|
35
|
+
"Work" shall mean the work of authorship, whether in Source or
|
|
36
|
+
Object form, made available under the License, as indicated by a
|
|
37
|
+
copyright notice that is included in or attached to the work
|
|
38
|
+
(an example is provided in the Appendix below).
|
|
39
|
+
|
|
40
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
|
41
|
+
form, that is based on (or derived from) the Work and for which the
|
|
42
|
+
editorial revisions, annotations, elaborations, or other modifications
|
|
43
|
+
represent, as a whole, an original work of authorship. For the purposes
|
|
44
|
+
of this License, Derivative Works shall not include works that remain
|
|
45
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
|
46
|
+
the Work and Derivative Works thereof.
|
|
47
|
+
|
|
48
|
+
"Contribution" shall mean any work of authorship, including
|
|
49
|
+
the original version of the Work and any modifications or additions
|
|
50
|
+
to that Work or Derivative Works thereof, that is intentionally
|
|
51
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
|
52
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
|
53
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
|
54
|
+
means any form of electronic, verbal, or written communication sent
|
|
55
|
+
to the Licensor or its representatives, including but not limited to
|
|
56
|
+
communication on electronic mailing lists, source code control systems,
|
|
57
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
|
58
|
+
Licensor for the purpose of discussing and improving the Work, but
|
|
59
|
+
excluding communication that is conspicuously marked or otherwise
|
|
60
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
|
61
|
+
|
|
62
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
|
63
|
+
on behalf of whom a Contribution has been received by Licensor and
|
|
64
|
+
subsequently incorporated within the Work.
|
|
65
|
+
|
|
66
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
|
67
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
68
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
69
|
+
copyright license to reproduce, prepare Derivative Works of,
|
|
70
|
+
publicly display, publicly perform, sublicense, and distribute the
|
|
71
|
+
Work and such Derivative Works in Source or Object form.
|
|
72
|
+
|
|
73
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
|
74
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
75
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
76
|
+
(except as stated in this section) patent license to make, have made,
|
|
77
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
|
78
|
+
where such license applies only to those patent claims licensable
|
|
79
|
+
by such Contributor that are necessarily infringed by their
|
|
80
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
|
81
|
+
with the Work to which such Contribution(s) was submitted. If You
|
|
82
|
+
institute patent litigation against any entity (including a
|
|
83
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
|
84
|
+
or a Contribution incorporated within the Work constitutes direct
|
|
85
|
+
or contributory patent infringement, then any patent licenses
|
|
86
|
+
granted to You under this License for that Work shall terminate
|
|
87
|
+
as of the date such litigation is filed.
|
|
88
|
+
|
|
89
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
|
90
|
+
Work or Derivative Works thereof in any medium, with or without
|
|
91
|
+
modifications, and in Source or Object form, provided that You
|
|
92
|
+
meet the following conditions:
|
|
93
|
+
|
|
94
|
+
(a) You must give any other recipients of the Work or Derivative
|
|
95
|
+
Works a copy of this License; and
|
|
96
|
+
|
|
97
|
+
(b) You must cause any modified files to carry prominent notices
|
|
98
|
+
stating that You changed the files; and
|
|
99
|
+
|
|
100
|
+
(c) You must retain, in the Source form of any Derivative Works
|
|
101
|
+
that You distribute, all copyright, patent, trademark, and
|
|
102
|
+
attribution notices from the Source form of the Work,
|
|
103
|
+
excluding those notices that do not pertain to any part of
|
|
104
|
+
the Derivative Works; and
|
|
105
|
+
|
|
106
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
|
107
|
+
distribution, then any Derivative Works that You distribute must
|
|
108
|
+
include a readable copy of the attribution notices contained
|
|
109
|
+
within such NOTICE file, excluding those notices that do not
|
|
110
|
+
pertain to any part of the Derivative Works, in at least one
|
|
111
|
+
of the following places: within a NOTICE text file distributed
|
|
112
|
+
as part of the Derivative Works; within the Source form or
|
|
113
|
+
documentation, if provided along with the Derivative Works; or,
|
|
114
|
+
within a display generated by the Derivative Works, if and
|
|
115
|
+
wherever such third-party notices normally appear. The contents
|
|
116
|
+
of the NOTICE file are for informational purposes only and
|
|
117
|
+
do not modify the License. You may add Your own attribution
|
|
118
|
+
notices within Derivative Works that You distribute, alongside
|
|
119
|
+
or as an addendum to the NOTICE text from the Work, provided
|
|
120
|
+
that such additional attribution notices cannot be construed
|
|
121
|
+
as modifying the License.
|
|
122
|
+
|
|
123
|
+
You may add Your own copyright statement to Your modifications and
|
|
124
|
+
may provide additional or different license terms and conditions
|
|
125
|
+
for use, reproduction, or distribution of Your modifications, or
|
|
126
|
+
for any such Derivative Works as a whole, provided Your use,
|
|
127
|
+
reproduction, and distribution of the Work otherwise complies with
|
|
128
|
+
the conditions stated in this License.
|
|
129
|
+
|
|
130
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
|
131
|
+
any Contribution intentionally submitted for inclusion in the Work
|
|
132
|
+
by You to the Licensor shall be under the terms and conditions of
|
|
133
|
+
this License, without any additional terms or conditions.
|
|
134
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
|
135
|
+
the terms of any separate license agreement you may have executed
|
|
136
|
+
with Licensor regarding such Contributions.
|
|
137
|
+
|
|
138
|
+
6. Trademarks. This License does not grant permission to use the trade
|
|
139
|
+
names, trademarks, service marks, or product names of the Licensor,
|
|
140
|
+
except as required for reasonable and customary use in describing the
|
|
141
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
|
142
|
+
|
|
143
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
|
144
|
+
agreed to in writing, Licensor provides the Work (and each
|
|
145
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
|
146
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
|
147
|
+
implied, including, without limitation, any warranties or conditions
|
|
148
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
|
149
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
|
150
|
+
appropriateness of using or redistributing the Work and assume any
|
|
151
|
+
risks associated with Your exercise of permissions under this License.
|
|
152
|
+
|
|
153
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
|
154
|
+
whether in tort (including negligence), contract, or otherwise,
|
|
155
|
+
unless required by applicable law (such as deliberate and grossly
|
|
156
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
|
157
|
+
liable to You for damages, including any direct, indirect, special,
|
|
158
|
+
incidental, or consequential damages of any character arising as a
|
|
159
|
+
result of this License or out of the use or inability to use the
|
|
160
|
+
Work (including but not limited to damages for loss of goodwill,
|
|
161
|
+
work stoppage, computer failure or malfunction, or any and all
|
|
162
|
+
other commercial damages or losses), even if such Contributor
|
|
163
|
+
has been advised of the possibility of such damages.
|
|
164
|
+
|
|
165
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
|
166
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
|
167
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
|
168
|
+
or other liability obligations and/or rights consistent with this
|
|
169
|
+
License. However, in accepting such obligations, You may act only
|
|
170
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
|
171
|
+
of any other Contributor, and only if You agree to indemnify,
|
|
172
|
+
defend, and hold each Contributor harmless for any liability
|
|
173
|
+
incurred by, or claims asserted against, such Contributor by reason
|
|
174
|
+
of your accepting any such warranty or additional liability.
|
|
175
|
+
|
|
176
|
+
END OF TERMS AND CONDITIONS
|
|
177
|
+
|
|
178
|
+
APPENDIX: How to apply the Apache License to your work.
|
|
179
|
+
|
|
180
|
+
To apply the Apache License to your work, attach the following
|
|
181
|
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
|
182
|
+
replaced with your own identifying information. (Don't include
|
|
183
|
+
the brackets!) The text should be enclosed in the appropriate
|
|
184
|
+
comment syntax for the file format. We also recommend that a
|
|
185
|
+
file or class name and description of purpose be included on the
|
|
186
|
+
same "printed page" as the copyright notice for easier
|
|
187
|
+
identification within third-party archives.
|
|
188
|
+
|
|
189
|
+
Copyright 2026 Felipe Santibáñez-Leal
|
|
190
|
+
|
|
191
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
|
192
|
+
you may not use this file except in compliance with the License.
|
|
193
|
+
You may obtain a copy of the License at
|
|
194
|
+
|
|
195
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
|
196
|
+
|
|
197
|
+
Unless required by applicable law or agreed to in writing, software
|
|
198
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
|
199
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
200
|
+
See the License for the specific language governing permissions and
|
|
201
|
+
limitations under the License.
|
package/README.md
CHANGED
|
@@ -1,59 +1,68 @@
|
|
|
1
|
-
# @fasl-work/caos-app-shell
|
|
2
|
-
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
{ path: "/
|
|
35
|
-
{ path: "/
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
|
|
54
|
-
|
|
55
|
-
|
|
56
|
-
|
|
57
|
-
|
|
58
|
-
|
|
59
|
-
|
|
1
|
+
# @fasl-work/caos-app-shell
|
|
2
|
+
|
|
3
|
+
[](LICENSE)
|
|
4
|
+
[](https://github.com/fsantibanezleal/CAOS_APP_SHELL/tags)
|
|
5
|
+
|
|
6
|
+
The shared **web-app shell + content primitives + design system** for the CAOS / Faena public apps
|
|
7
|
+
(implements [ADR-0016](https://github.com/fsantibanezleal)). Define the header, footer, theme, language
|
|
8
|
+
toggle and content primitives **once** here; every app consumes them so the chrome is identical and a
|
|
9
|
+
fix lands in one place.
|
|
10
|
+
|
|
11
|
+
## Install
|
|
12
|
+
|
|
13
|
+
```bash
|
|
14
|
+
npm i @fasl-work/caos-app-shell
|
|
15
|
+
# peer deps (the app provides them):
|
|
16
|
+
npm i react react-dom react-router-dom lucide-react katex zustand
|
|
17
|
+
```
|
|
18
|
+
|
|
19
|
+
## Use
|
|
20
|
+
|
|
21
|
+
```tsx
|
|
22
|
+
// main.tsx
|
|
23
|
+
import { applyTheme, readTheme } from "@fasl-work/caos-app-shell";
|
|
24
|
+
import "@fasl-work/caos-app-shell/styles.css";
|
|
25
|
+
applyTheme(readTheme()); // (an inline script in index.html should also set data-theme pre-paint)
|
|
26
|
+
|
|
27
|
+
// router / app
|
|
28
|
+
import { BrowserRouter, Routes, Route } from "react-router-dom";
|
|
29
|
+
import { AppShell, type ShellConfig } from "@fasl-work/caos-app-shell";
|
|
30
|
+
|
|
31
|
+
const config: ShellConfig = {
|
|
32
|
+
product: { name: "RotorVitals" },
|
|
33
|
+
routes: [
|
|
34
|
+
{ path: "/", en: "App", es: "App" },
|
|
35
|
+
{ path: "/introduction", en: "Introduction", es: "Introducción" },
|
|
36
|
+
{ path: "/methodology", en: "Methodology", es: "Metodología" },
|
|
37
|
+
{ path: "/implementation", en: "Implementation", es: "Implementación" },
|
|
38
|
+
{ path: "/experiments", en: "Experiments", es: "Experimentos" },
|
|
39
|
+
],
|
|
40
|
+
links: { github: "https://github.com/fsantibanezleal/CAOS_RotorVitals" }, // personal/portfolio default in
|
|
41
|
+
version: "0.01.000",
|
|
42
|
+
};
|
|
43
|
+
|
|
44
|
+
<BrowserRouter>
|
|
45
|
+
<AppShell config={config}>
|
|
46
|
+
<Routes>{/* / = the tool (landing); the rest are deep pages */}</Routes>
|
|
47
|
+
</AppShell>
|
|
48
|
+
</BrowserRouter>
|
|
49
|
+
```
|
|
50
|
+
|
|
51
|
+
- **Land on the tool:** make `/` your interactive tool; Introduction/Methodology/etc. are separate routes.
|
|
52
|
+
- **Hub case (Faena):** pass `routes: []` (or one) → the nav is hidden, header/footer identical.
|
|
53
|
+
- **Deep pages:** compose with `Tabs`, `SubTabs`, `Equation`/`InlineMath`, `Callout`, `Figure`, and
|
|
54
|
+
`CitationsProvider` + `Cite`/`Refs`/`ReferenceList`. Read the current language with `useShellLang()`.
|
|
55
|
+
- **Case + source picking:** use `CaseSelector` for the interactive tool's source/case selection
|
|
56
|
+
(labelled groups, `Synthetic | Real | Uploaded` source control, locked-knobs explanation, divergence
|
|
57
|
+
badge, `?case=` deep-linking).
|
|
58
|
+
- **Animated views:** drive every canvas/3D loop through `usePausedViz` (default paused, run-once,
|
|
59
|
+
halt on a hidden tab) — never call `requestAnimationFrame` directly.
|
|
60
|
+
|
|
61
|
+
## Exports
|
|
62
|
+
|
|
63
|
+
`AppShell`, `ThemeToggle`, `LanguageToggle`, `useThemeStore`, `applyTheme`, `readTheme`, `useLangStore`,
|
|
64
|
+
`useShellLang`, `usePausedViz`, `createVizLoop`, `CaseSelector` (+ `caseModel` helpers), `Tabs`, `SubTabs`,
|
|
65
|
+
`Callout`, `Equation`, `InlineMath`, `Figure`, `CitationsProvider`, `Cite`, `Refs`, `ReferenceList`, plus
|
|
66
|
+
the `@fasl-work/caos-app-shell/styles.css` design system.
|
|
67
|
+
|
|
68
|
+
MIT · part of the Faena mining-analytics hub.
|
package/dist/index.d.ts
CHANGED
|
@@ -47,6 +47,19 @@ interface ShellConfig {
|
|
|
47
47
|
version: string;
|
|
48
48
|
/** In-app Architecture / "How it works" modal (ADR-0058). When present, an ⓘ button appears in the header. */
|
|
49
49
|
architecture?: ArchitectureConfig;
|
|
50
|
+
/** Footer provenance + honesty (ADR-0016 §2): the real data/engine source with citation +
|
|
51
|
+
* license (e.g. "Engine: lingbot-map (arXiv:2604.14141, Apache-2.0)") and the one-line honest
|
|
52
|
+
* disclaimer of how the app runs. Both optional, both bilingual. */
|
|
53
|
+
footer?: {
|
|
54
|
+
provenance?: {
|
|
55
|
+
en: string;
|
|
56
|
+
es: string;
|
|
57
|
+
};
|
|
58
|
+
disclaimer?: {
|
|
59
|
+
en: string;
|
|
60
|
+
es: string;
|
|
61
|
+
};
|
|
62
|
+
};
|
|
50
63
|
}
|
|
51
64
|
/** The shared CAOS/Faena app shell: sticky header (brand + nav + icon-links + lang/theme) + footer.
|
|
52
65
|
* Wrap your <Routes> (or single landing) in it, inside a Router. */
|
|
@@ -81,6 +94,149 @@ declare const useLangStore: zustand.UseBoundStore<zustand.StoreApi<LangState>>;
|
|
|
81
94
|
/** Current language, for app pages that render language-branched long-form content. */
|
|
82
95
|
declare const useShellLang: () => Lang;
|
|
83
96
|
|
|
97
|
+
/** Return `false` from a frame to end the current pass (the animation is complete); return `true`
|
|
98
|
+
* or nothing to keep going. `dt` = ms since the previous frame, `elapsed` = ms since this pass
|
|
99
|
+
* began (never counts time while the tab was hidden). */
|
|
100
|
+
type VizFrame = (dt: number, elapsed: number) => boolean | void;
|
|
101
|
+
interface VizLoopOptions {
|
|
102
|
+
/** Repeat after each completed pass instead of stopping. Default false (run once, then stop). */
|
|
103
|
+
loop?: boolean;
|
|
104
|
+
/** Auto-complete the pass once `elapsed` reaches this many ms (a hard cap so a frame that never
|
|
105
|
+
* returns false still stops). The final frame is drawn clamped to exactly this value. */
|
|
106
|
+
durationMs?: number;
|
|
107
|
+
/** Fired once each time the loop stops on its own (a completed pass with loop=false) — not on a
|
|
108
|
+
* manual pause and not on a visibility halt. */
|
|
109
|
+
onComplete?: () => void;
|
|
110
|
+
/** Notified whenever the running state changes, so a React wrapper can mirror it into state. */
|
|
111
|
+
onPlayingChange?: (playing: boolean) => void;
|
|
112
|
+
}
|
|
113
|
+
/** Injected side effects — real ones in the hook, fakes in tests. The frame timestamp comes from
|
|
114
|
+
* the rAF callback argument, so no separate clock is needed. */
|
|
115
|
+
interface VizLoopDeps {
|
|
116
|
+
raf: (cb: (now: number) => void) => number;
|
|
117
|
+
caf: (handle: number) => void;
|
|
118
|
+
}
|
|
119
|
+
interface VizLoop {
|
|
120
|
+
/** Is the loop actively requesting frames right now? (false while paused OR halted by hidden tab). */
|
|
121
|
+
isPlaying: () => boolean;
|
|
122
|
+
/** Does the user WANT motion? (stays true across a visibility halt; false once paused/completed). */
|
|
123
|
+
isRunning: () => boolean;
|
|
124
|
+
play: () => void;
|
|
125
|
+
pause: () => void;
|
|
126
|
+
toggle: () => void;
|
|
127
|
+
/** Reset elapsed to 0 and play from the start. */
|
|
128
|
+
restart: () => void;
|
|
129
|
+
/** Feed a document-visibility change: hidden halts the rAF (keeping intent), visible resumes it. */
|
|
130
|
+
setHidden: (hidden: boolean) => void;
|
|
131
|
+
/** Cancel any pending frame and detach (idempotent). */
|
|
132
|
+
dispose: () => void;
|
|
133
|
+
}
|
|
134
|
+
declare function createVizLoop(frame: VizFrame, options: VizLoopOptions, deps: VizLoopDeps): VizLoop;
|
|
135
|
+
|
|
136
|
+
interface PausedVizController {
|
|
137
|
+
/** Is the rAF loop actively drawing right now (false while paused or halted by a hidden tab)? */
|
|
138
|
+
playing: boolean;
|
|
139
|
+
play: () => void;
|
|
140
|
+
pause: () => void;
|
|
141
|
+
toggle: () => void;
|
|
142
|
+
/** Reset elapsed to 0 and play from the start. */
|
|
143
|
+
restart: () => void;
|
|
144
|
+
}
|
|
145
|
+
interface UsePausedVizOptions extends VizLoopOptions {
|
|
146
|
+
/** Begin playing on mount. Default false — the mandatory no-autoplay default: a page must never
|
|
147
|
+
* burn CPU unattended. Opt in only for a view the user explicitly expects to move on arrival. */
|
|
148
|
+
autoStart?: boolean;
|
|
149
|
+
}
|
|
150
|
+
/**
|
|
151
|
+
* Drive a requestAnimationFrame loop under the no-compute-bomb rule: default paused,
|
|
152
|
+
* run-once-then-stop (looping opt-in), and auto-halt whenever the tab is hidden. Every animated
|
|
153
|
+
* canvas / 3D view in a Faena app should mount through this instead of calling rAF directly.
|
|
154
|
+
*
|
|
155
|
+
* `frame(dt, elapsed)` runs each frame (dt = ms since the previous frame, elapsed = ms since the
|
|
156
|
+
* current pass began, excluding hidden time). Return `false` to end the pass; return `true` or
|
|
157
|
+
* nothing to continue. With `loop`, a completed pass restarts; otherwise the loop pauses and
|
|
158
|
+
* `onComplete` fires. Set `durationMs` for a finite animation with a guaranteed stop.
|
|
159
|
+
*/
|
|
160
|
+
declare function usePausedViz(frame: VizFrame, options?: UsePausedVizOptions): PausedVizController;
|
|
161
|
+
|
|
162
|
+
type CaseKind = 'synthetic' | 'real' | 'uploaded';
|
|
163
|
+
interface CaseDef {
|
|
164
|
+
/** stable slug — the value used in the ?case= deep link and reported to onSelect. */
|
|
165
|
+
id: string;
|
|
166
|
+
/** short human name shown ON the chip next to the id (never demoted to a tooltip-only string). */
|
|
167
|
+
name: string;
|
|
168
|
+
/** group label; cases with the same category render under one labelled group. */
|
|
169
|
+
category?: string;
|
|
170
|
+
/** which source lane this case belongs to. Defaults to 'synthetic'. */
|
|
171
|
+
kind?: CaseKind;
|
|
172
|
+
/** validation anchor (e.g. "published optimum 26,086,899") — surfaced in the chip tooltip. */
|
|
173
|
+
anchor?: string;
|
|
174
|
+
/** expected-range hint — surfaced in the chip tooltip. */
|
|
175
|
+
expectedBand?: string;
|
|
176
|
+
disabled?: boolean;
|
|
177
|
+
}
|
|
178
|
+
declare const caseKind: (c: CaseDef) => CaseKind;
|
|
179
|
+
/** The source lanes that actually appear in the deck, in canonical Synthetic → Real → Uploaded order. */
|
|
180
|
+
declare function sourcesPresent(cases: CaseDef[]): CaseKind[];
|
|
181
|
+
interface CaseGroup {
|
|
182
|
+
category: string;
|
|
183
|
+
cases: CaseDef[];
|
|
184
|
+
}
|
|
185
|
+
/** Group by category, preserving first-seen category order and case order within each group. */
|
|
186
|
+
declare function groupByCategory(cases: CaseDef[]): CaseGroup[];
|
|
187
|
+
/** Cases in a given source lane (or all cases when no source filter is active). */
|
|
188
|
+
declare function casesInSource(cases: CaseDef[], source: CaseKind | undefined): CaseDef[];
|
|
189
|
+
/** The chip tooltip: anchor and/or expected band, joined; empty string when neither is set. */
|
|
190
|
+
declare function caseTooltip(c: CaseDef): string;
|
|
191
|
+
/** Read the case id from a query string, or null when absent. */
|
|
192
|
+
declare function readCaseParam(search: string, param?: string): string | null;
|
|
193
|
+
/** A new query string (leading '?') with the case param set to id. */
|
|
194
|
+
declare function withCaseParam(search: string, id: string, param?: string): string;
|
|
195
|
+
|
|
196
|
+
interface CaseSelectorText {
|
|
197
|
+
source: string;
|
|
198
|
+
synthetic: string;
|
|
199
|
+
real: string;
|
|
200
|
+
uploaded: string;
|
|
201
|
+
/** shown under the source control when a non-synthetic lane is active and knobs are locked. */
|
|
202
|
+
lockedNote: string;
|
|
203
|
+
/** prefix for the divergence badge, e.g. "modified from". */
|
|
204
|
+
modifiedPrefix: string;
|
|
205
|
+
reset: string;
|
|
206
|
+
}
|
|
207
|
+
interface CaseSelectorProps {
|
|
208
|
+
cases: CaseDef[];
|
|
209
|
+
selectedId: string;
|
|
210
|
+
onSelect: (id: string) => void;
|
|
211
|
+
/** When provided, renders the first-level source control and filters cases to the active lane.
|
|
212
|
+
* Controlled — pair with onSourceChange. Omit for a single-lane deck (no source control). */
|
|
213
|
+
source?: CaseKind;
|
|
214
|
+
onSourceChange?: (k: CaseKind) => void;
|
|
215
|
+
/** Overrides the default locked-knobs explanation shown for a non-synthetic source. */
|
|
216
|
+
lockedNote?: string;
|
|
217
|
+
/** Set to the case id the current knob state diverged from to show a "modified from X" badge.
|
|
218
|
+
* The consumer owns the knobs and computes this; null/undefined hides the badge. */
|
|
219
|
+
modifiedFromId?: string | null;
|
|
220
|
+
onResetToCanonical?: () => void;
|
|
221
|
+
lang?: Lang;
|
|
222
|
+
text?: Partial<CaseSelectorText>;
|
|
223
|
+
/** Sync selectedId with the URL query. true → ?case=, a string → that param name. */
|
|
224
|
+
deepLink?: boolean | string;
|
|
225
|
+
ariaLabel?: string;
|
|
226
|
+
className?: string;
|
|
227
|
+
}
|
|
228
|
+
/**
|
|
229
|
+
* CaseSelector v2 — the shared source + case picker. Renders (1) an optional first-level source
|
|
230
|
+
* segmented control (Synthetic | Real | Uploaded, only the lanes present), (2) a labelled group per
|
|
231
|
+
* case category, each case a chip showing "ID · name" with its validation anchor as the tooltip and
|
|
232
|
+
* a source tag, (3) a locked-knobs explanation when a non-synthetic source is active, and (4) a
|
|
233
|
+
* "modified from CASE" divergence badge with a reset action. Optional ?case= deep-linking.
|
|
234
|
+
*
|
|
235
|
+
* Controlled: the consumer owns selectedId, source, and the scenario knobs (which it disables when
|
|
236
|
+
* source !== 'synthetic'); this component signals and reports, it does not own knob state.
|
|
237
|
+
*/
|
|
238
|
+
declare function CaseSelector(props: CaseSelectorProps): react.JSX.Element;
|
|
239
|
+
|
|
84
240
|
interface TabDef {
|
|
85
241
|
id: string;
|
|
86
242
|
label: ReactNode;
|
|
@@ -160,4 +316,4 @@ declare function ReferenceList({ ids, heading }: {
|
|
|
160
316
|
heading?: string;
|
|
161
317
|
}): react.JSX.Element;
|
|
162
318
|
|
|
163
|
-
export { AppShell, type ArchTab, type ArchitectureConfig, ArchitectureModal, Callout, type Citation, CitationsProvider, Cite, Equation, Figure, InlineMath, type Lang, LanguageToggle, ReferenceList, Refs, type ShellConfig, type ShellRoute, type SubTabDef, SubTabs, type TabDef, Tabs, type Theme, ThemeToggle, applyTheme, readTheme, useLangStore, useShellLang, useThemeStore };
|
|
319
|
+
export { AppShell, type ArchTab, type ArchitectureConfig, ArchitectureModal, Callout, type CaseDef, type CaseGroup, type CaseKind, CaseSelector, type CaseSelectorProps, type CaseSelectorText, type Citation, CitationsProvider, Cite, Equation, Figure, InlineMath, type Lang, LanguageToggle, type PausedVizController, ReferenceList, Refs, type ShellConfig, type ShellRoute, type SubTabDef, SubTabs, type TabDef, Tabs, type Theme, ThemeToggle, type UsePausedVizOptions, type VizFrame, type VizLoop, type VizLoopDeps, type VizLoopOptions, applyTheme, caseKind, caseTooltip, casesInSource, createVizLoop, groupByCategory, readCaseParam, readTheme, sourcesPresent, useLangStore, usePausedViz, useShellLang, useThemeStore, withCaseParam };
|