1
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
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
//! Route load return-key harvesting.
use oxc_ast::ast::{
BindingPattern, Declaration, Expression, FunctionBody, ObjectPropertyKind, TSType, TSTypeName,
};
use oxc_span::GetSpan;
use crate::visitor::RouteLoadHarvestMode;
use super::{
ModuleInfoExtractor, count_returns_in_statements, extract_arrow_return_expr,
extract_function_body_final_return_expr, unwrap_paren_expr,
};
impl ModuleInfoExtractor {
/// Harvest route-data return-object keys from a framework-specific producer
/// export. `parse.rs` sets `route_load_harvest_mode` before the AST walk so
/// SvelteKit only harvests `load`, while React Router and Remix harvest
/// `loader` / `clientLoader`.
/// Abstains (sets `has_unharvestable_load`) on any unsafe shape, mirroring
/// the Pinia setup-store harvest abstain.
pub(super) fn try_harvest_load_export(&mut self, declaration: &Declaration<'_>) {
match declaration {
Declaration::FunctionDeclaration(function) => {
if function
.id
.as_ref()
.is_none_or(|id| !self.should_harvest_route_load_export(&id.name))
{
return;
}
let Some(body) = function.body.as_ref() else {
// A bodyless overload signature carries no keys; ignore.
return;
};
match load_terminal_return_expr(body) {
Ok(Some(returned)) => self.harvest_load_terminal(returned),
Ok(None) => {}
Err(()) => self.has_unharvestable_load = true,
}
}
Declaration::VariableDeclaration(var) => {
for declarator in &var.declarations {
// The binding must be a route data producer export.
let is_load_binding = matches!(
&declarator.id,
BindingPattern::BindingIdentifier(id) if self.should_harvest_route_load_export(&id.name)
);
if !is_load_binding {
continue;
}
// S4: a `: PageLoad` annotation is recognized but not
// required; harvest proceeds either way.
let _has_load_annotation = declarator
.type_annotation
.as_deref()
.and_then(|ann| ts_type_reference_base_name(&ann.type_annotation))
.is_some_and(|name| is_sveltekit_load_type_name(&name));
let Some(init) = declarator.init.as_ref() else {
continue;
};
self.harvest_load_init(init);
}
}
_ => {}
}
}
/// Harvest a `load` binding initializer: an arrow / function expression
/// (optionally wrapped in `satisfies PageLoad` / a TS `as` cast). Any other
/// shape (a wrapped factory `load = wrap(...)`, an identifier) abstains.
fn harvest_load_init(&mut self, init: &Expression<'_>) {
// Peel every TS-cast / satisfies / parenthesis wrapper layer (any order),
// so `(async () => ({...})) satisfies PageLoad` reaches the arrow.
let mut unwrapped = init;
loop {
match unwrapped {
Expression::TSSatisfiesExpression(sat) => unwrapped = &sat.expression,
Expression::TSAsExpression(as_expr) => unwrapped = &as_expr.expression,
Expression::ParenthesizedExpression(paren) => unwrapped = &paren.expression,
_ => break,
}
}
match unwrapped {
Expression::ArrowFunctionExpression(arrow) => {
if arrow.expression {
// `load = () => ({ ... })` single-expression body.
match extract_arrow_return_expr(arrow) {
Some(returned) => self.harvest_load_terminal(returned),
None => self.has_unharvestable_load = true,
}
return;
}
match load_terminal_return_expr(&arrow.body) {
Ok(Some(returned)) => self.harvest_load_terminal(returned),
Ok(None) => {}
Err(()) => self.has_unharvestable_load = true,
}
}
Expression::FunctionExpression(func) => match func.body.as_ref() {
Some(body) => match load_terminal_return_expr(body) {
Ok(Some(returned)) => self.harvest_load_terminal(returned),
Ok(None) => {}
Err(()) => self.has_unharvestable_load = true,
},
None => self.has_unharvestable_load = true,
},
// `export const load = wrappedLoad(...)` / a bare identifier: the
// terminal object is not a direct literal here, so abstain.
_ => self.has_unharvestable_load = true,
}
}
/// Harvest the keys from a terminal return expression, or abstain.
fn harvest_load_terminal(&mut self, returned: &Expression<'_>) {
match harvest_load_return_keys(returned) {
Ok(keys) => self.load_return_keys.extend(keys),
Err(()) => self.has_unharvestable_load = true,
}
}
pub(super) fn should_harvest_route_load_export(&self, name: &str) -> bool {
match self.route_load_harvest_mode {
RouteLoadHarvestMode::None => false,
RouteLoadHarvestMode::SvelteKitPage => name == "load",
RouteLoadHarvestMode::ConventionalRoute => matches!(name, "loader" | "clientLoader"),
}
}
}
/// Whether a TS type annotation names a SvelteKit load type (`PageLoad`,
/// `PageServerLoad`, `LayoutLoad`, `LayoutServerLoad`), used to recognize a
/// `load` declared via `: PageLoad` annotation or `satisfies PageLoad`. The
/// type may be generic (`PageLoad<{ ... }>`); only the base name is checked.
fn is_sveltekit_load_type_name(name: &str) -> bool {
matches!(
name,
"PageLoad" | "PageServerLoad" | "LayoutLoad" | "LayoutServerLoad"
)
}
/// Extract the base name of a `TSTypeReference` (`PageLoad<X>` -> `PageLoad`).
fn ts_type_reference_base_name(ty: &TSType<'_>) -> Option<String> {
let TSType::TSTypeReference(type_ref) = ty else {
return None;
};
match &type_ref.type_name {
TSTypeName::IdentifierReference(id) => Some(id.name.to_string()),
TSTypeName::QualifiedName(qualified) => Some(qualified.right.name.to_string()),
TSTypeName::ThisExpression(_) => None,
}
}
/// Harvest the load() return-object keys from a terminal return object literal.
/// Returns `Ok(keys)` with the property key names + spans, or `Err(())` to
/// signal an abstain (spread, non-object/non-literal return, or a computed key).
fn harvest_load_return_keys(
returned: &Expression<'_>,
) -> Result<Vec<fallow_types::extract::LoadReturnKey>, ()> {
let returned = unwrap_json_return_expr(unwrap_paren_expr(returned));
let Expression::ObjectExpression(obj) = returned else {
// A non-object terminal return (`return data`, `return makeData()`)
// cannot be key-harvested: abstain.
return Err(());
};
let mut keys = Vec::new();
for prop in &obj.properties {
match prop {
// A spread (`return { ...base, x }`) hides keys: abstain entirely.
ObjectPropertyKind::SpreadProperty(_) => return Err(()),
ObjectPropertyKind::ObjectProperty(prop) => {
// A computed key (`return { [k]: v }`) is unknowable: abstain.
if prop.computed {
return Err(());
}
let Some(name) = prop.key.static_name() else {
return Err(());
};
let span = prop.key.span();
keys.push(fallow_types::extract::LoadReturnKey {
name: name.to_string(),
span_start: span.start,
span_end: span.end,
});
}
}
}
Ok(keys)
}
fn unwrap_json_return_expr<'a>(returned: &'a Expression<'a>) -> &'a Expression<'a> {
let Expression::CallExpression(call) = returned else {
return returned;
};
let is_json_call = match &call.callee {
Expression::Identifier(callee) => callee.name == "json",
Expression::StaticMemberExpression(member) => member.property.name == "json",
_ => false,
};
if !is_json_call {
return returned;
}
let Some(first) = call
.arguments
.first()
.and_then(oxc_ast::ast::Argument::as_expression)
else {
return returned;
};
unwrap_paren_expr(first)
}
/// The terminal return object of a function/arrow `load` body, with the
/// multi-return abstain applied. `Ok(Some(obj))` = a single terminal-return
/// object literal; `Ok(None)` = no return (an empty/void body, no keys to
/// harvest, no abstain); `Err(())` = abstain (>1 return).
fn load_terminal_return_expr<'a, 'b>(
body: &'b FunctionBody<'a>,
) -> Result<Option<&'b Expression<'a>>, ()> {
if count_returns_in_statements(&body.statements) > 1 {
return Err(());
}
Ok(extract_function_body_final_return_expr(body))
}