use scythe_backend::manifest::BackendManifest;
use scythe_backend::naming::{composite_type_name, enum_type_name, enum_variant_name, fn_name, to_camel_case};
use scythe_backend::types::resolve_type;
use std::fmt::Write;
use scythe_core::analyzer::{AnalyzedQuery, CompositeInfo, EnumInfo};
use scythe_core::errors::{ErrorCode, ScytheError};
use scythe_core::parser::QueryCommand;
use crate::GeneratedCode;
use crate::backend_options::reject_unknown_options;
use crate::backend_trait::GroupedQueryFn;
use crate::backend_trait::{CodegenBackend, ResolvedColumn, ResolvedParam};
use crate::backends::typescript_common::{
TsFieldCase, TsRowType, escape_ts_template_literal, generate_grouped_interface_structs,
generate_ts_grouped_fold_body, generate_ts_interface_row_struct,
generate_ts_json_composite_interface_with_field_case, generate_ts_nested_interface_with_field_case,
generate_ts_union_row_struct, generate_zod_enum, generate_zod_grouped_structs, generate_zod_row_struct,
generate_zod_union_row_struct, parse_bool_option, ts_index_access, ts_member_access, ts_property_key,
ts_row_not_found_throw,
};
fn ts_parse_composite_fields_helper(name: &str) -> String {
format!(
"function parse{name}Fields(text: string): (string | null)[] {{\n\
\t// ~keep Splits a PostgreSQL composite's text form (\"(a,b,c)\") into its raw field\n\
\t// tokens, honoring its escaping rules: an empty unquoted field is SQL NULL (returned as\n\
\t// null); a field needing quoting (comma, paren, quote, backslash, leading/trailing\n\
\t// space, or the empty string) is wrapped in double quotes; every other field is\n\
\t// unquoted and taken literally. Inside a quoted field `record_out` writes a literal\n\
\t// '\"' as '\"\"' and a literal '\\\\' as '\\\\\\\\' -- reading '\"\"' as a closing quote both\n\
\t// truncates the value and desynchronizes every field after it. Verified against\n\
\t// PostgreSQL 16.\n\
\tconst fields: (string | null)[] = [];\n\
\tconst inner = text.slice(1, -1);\n\
\tlet i = 0;\n\
\tconst n = inner.length;\n\
\tfor (;;) {{\n\
\t\tlet chars = \"\";\n\
\t\tlet isNull = false;\n\
\t\tif (i < n && inner[i] === '\"') {{\n\
\t\t\ti++;\n\
\t\t\twhile (i < n) {{\n\
\t\t\t\tconst c = inner[i];\n\
\t\t\t\tif (c === \"\\\\\" && i + 1 < n) {{\n\
\t\t\t\t\tchars += inner[i + 1];\n\
\t\t\t\t\ti += 2;\n\
\t\t\t\t}} else if (c === '\"' && i + 1 < n && inner[i + 1] === '\"') {{\n\
\t\t\t\t\tchars += '\"';\n\
\t\t\t\t\ti += 2;\n\
\t\t\t\t}} else if (c === '\"') {{\n\
\t\t\t\t\ti++;\n\
\t\t\t\t\tbreak;\n\
\t\t\t\t}} else {{\n\
\t\t\t\t\tchars += c;\n\
\t\t\t\t\ti++;\n\
\t\t\t\t}}\n\
\t\t\t}}\n\
\t\t}} else {{\n\
\t\t\tconst start = i;\n\
\t\t\twhile (i < n && inner[i] !== \",\") {{\n\
\t\t\t\ti++;\n\
\t\t\t}}\n\
\t\t\tchars = inner.slice(start, i);\n\
\t\t\tisNull = chars.length === 0;\n\
\t\t}}\n\
\t\tfields.push(isNull ? null : chars);\n\
\t\tif (i < n && inner[i] === \",\") {{\n\
\t\t\ti++;\n\
\t\t\tcontinue;\n\
\t\t}}\n\
\t\tbreak;\n\
\t}}\n\
\treturn fields;\n\
}}"
)
}
fn ts_encode_composite_helper(composite: &CompositeInfo, naming: &scythe_backend::naming::NamingConfig) -> String {
let fields = composite
.fields
.iter()
.map(|field| format!("${{encode(value.{})}}", to_camel_case(&field.name)))
.collect::<Vec<_>>()
.join(",");
format!(
"function encode{name}(value: {name} | null): string | null {{\n\
\tif (value === null) return null;\n\
\tconst encode = (field: unknown): string => {{\n\
\t\tif (field === null || field === undefined) return \"\";\n\
\t\tconst text = String(field);\n\
\t\tif (text === \"\" || /[(),\\\"\\\\\\s]/.test(text)) {{\n\
\t\t\treturn `\"${{text.replaceAll(\"\\\\\", \"\\\\\\\\\").replaceAll('\\\"', '\\\"\\\"')}}\"`;\n\
\t\t}}\n\
\t\treturn text;\n\
\t}};\n\
\treturn `({fields})`;\n\
}}",
name = composite_type_name(&composite.sql_name, naming),
)
}
fn ts_parse_composite_bytes_helper(name: &str) -> String {
format!(
"function parse{name}Bytes(hex: string): Buffer {{\n\
\t// ~keep PostgreSQL's default bytea text output is hex: \"\\x48656c6c6f\". Decode the hex\n\
\t// digits after the \"\\x\" prefix back into a Buffer.\n\
\treturn Buffer.from(hex.slice(2), \"hex\");\n\
}}"
)
}
fn ts_parse_composite_offset_datetime_helper(name: &str) -> String {
format!(
"function parse{name}OffsetDateTime(raw: string): Date {{\n\
\t// ~keep PostgreSQL's default timestamptz text output uses a space instead of \"T\"\n\
\t// (\"2024-01-15 10:30:00+00\") and omits the offset's minutes when they are zero (\"+00\"\n\
\t// rather than \"+00:00\"); normalize both before parsing.\n\
\tlet s = raw.replace(\" \", \"T\");\n\
\tconst sign = s[s.length - 3];\n\
\tif (sign === \"+\" || sign === \"-\") {{\n\
\t\ts = s + \":00\";\n\
\t}}\n\
\treturn new Date(s);\n\
}}"
)
}
fn ts_composite_needs_bytes_helper(composite: &CompositeInfo) -> bool {
composite.fields.iter().any(|f| f.neutral_type == "bytes")
}
fn ts_composite_needs_offset_datetime_helper(composite: &CompositeInfo) -> bool {
composite.fields.iter().any(|f| f.neutral_type == "datetime_tz")
}
fn ts_composite_field_from_text(
neutral_type: &str,
field_type: &str,
raw: &str,
nullable: bool,
composite_name: &str,
) -> String {
let converted = if neutral_type.strip_prefix("composite::").is_some() {
format!("parse{field_type}({raw}) as {field_type}")
} else if neutral_type.starts_with("enum::") {
format!("{raw} as {field_type}")
} else {
match neutral_type {
"bool" => format!("{raw} === \"t\""),
"int16" | "int32" | "int64" | "float32" | "float64" => format!("Number({raw})"),
"bytes" => format!("parse{composite_name}Bytes({raw} as string)"),
"datetime" => format!("new Date(({raw} as string).replace(\" \", \"T\"))"),
"datetime_tz" => format!("parse{composite_name}OffsetDateTime({raw} as string)"),
_ => format!("{raw} as {field_type}"),
}
};
if nullable {
format!("{raw} === null ? null : {converted}")
} else {
converted
}
}
fn ts_composite_field_overrides(
columns: &[ResolvedColumn],
var: &str,
field_case: TsFieldCase,
) -> Vec<(String, String)> {
columns
.iter()
.filter(|c| c.neutral_type.starts_with("composite::"))
.map(|c| {
let key = ts_property_key(&c.field_name);
let driver_key = match field_case {
TsFieldCase::Snake => &c.name,
TsFieldCase::Camel => &c.field_name,
};
let member = ts_member_access(var, driver_key);
(key, format!("parse{}({member}) as {}", c.lang_type, c.full_type))
})
.collect()
}
const DEFAULT_MANIFEST_PG: &str = include_str!("../../manifests/typescript-kysely.toml");
const DEFAULT_MANIFEST_REDSHIFT: &str = include_str!("../../manifests/typescript-kysely.redshift.toml");
const DEFAULT_MANIFEST_MYSQL: &str = include_str!("../../manifests/typescript-kysely.mysql.toml");
const DEFAULT_MANIFEST_SQLITE: &str = include_str!("../../manifests/typescript-kysely.sqlite.toml");
const DEFAULT_MANIFEST_MSSQL: &str = include_str!("../../manifests/typescript-kysely.mssql.toml");
pub struct TypescriptKyselyBackend {
manifest: BackendManifest,
row_type: TsRowType,
outer_join_unions: bool,
structs_only: bool,
field_case: TsFieldCase,
}
impl TypescriptKyselyBackend {
pub fn new(engine: &str) -> Result<Self, ScytheError> {
let default_toml = match engine {
"postgresql" | "postgres" | "pg" => DEFAULT_MANIFEST_PG,
"redshift" => DEFAULT_MANIFEST_REDSHIFT,
"mysql" | "mariadb" => DEFAULT_MANIFEST_MYSQL,
"sqlite" | "sqlite3" => DEFAULT_MANIFEST_SQLITE,
"mssql" => DEFAULT_MANIFEST_MSSQL,
_ => {
return Err(ScytheError::new(
ErrorCode::InvalidConfig,
format!(
"typescript-kysely only supports PostgreSQL/Redshift/MySQL/MariaDB/SQLite/MSSQL, got engine '{}'",
engine
),
));
}
};
let manifest = super::parse_manifest(default_toml)?;
Ok(Self {
manifest,
row_type: TsRowType::default(),
outer_join_unions: false,
structs_only: false,
field_case: TsFieldCase::default(),
})
}
fn header_with_kysely_import(&self, needs_kysely: bool) -> String {
let mut header = self.camel_case_plugin_note();
if self.structs_only {
if self.row_type == TsRowType::Zod {
header.push_str("import { z } from \"zod\";\n");
}
return header;
}
let kysely_type = if needs_kysely { "type Kysely, " } else { "" };
let _ = writeln!(
header,
"import {{ {kysely_type}type QueryExecutorProvider, sql }} from \"kysely\";"
);
if self.row_type == TsRowType::Zod {
header.push_str("import { z } from \"zod\";\n");
}
header
}
fn camel_case_plugin_note(&self) -> String {
if self.field_case != TsFieldCase::Camel {
return String::new();
}
"// scythe: this file was generated with field_case = \"camelCase\".\n\
// Kysely does not remap rows -- register CamelCasePlugin on your Kysely\n\
// instance or every field below reads back undefined at runtime:\n\
// new Kysely({ dialect, plugins: [new CamelCasePlugin()] })\n"
.to_string()
}
}
fn interpolate_kysely_params(sql: &str, exprs: &[String]) -> String {
super::rewrite_pg_placeholders(sql, |n| {
let idx = n.saturating_sub(1) as usize;
match exprs.get(idx) {
Some(expr) => format!("${{{}}}", expr),
None => format!("${{p{n}}}"),
}
})
}
fn kysely_param_expr(
analyzed: &AnalyzedQuery,
param: &ResolvedParam,
member: String,
naming: &scythe_backend::naming::NamingConfig,
) -> String {
analyzed
.params
.iter()
.find(|candidate| candidate.name == param.name)
.and_then(|candidate| candidate.neutral_type.strip_prefix("composite::"))
.map_or(member.clone(), |sql_name| {
format!("encode{}({member})", composite_type_name(sql_name, naming))
})
}
fn write_batch_transaction_body(out: &mut String, loop_open: &str, sql_text: &str) {
let _ = writeln!(out, "\tconst run = async (trx: Kysely<DB>) => {{");
let _ = writeln!(out, "\t\t{loop_open}");
let _ = writeln!(out, "\t\t\tawait sql`{sql_text}`.execute(trx);");
let _ = writeln!(out, "\t\t}}");
let _ = writeln!(out, "\t}};");
let _ = writeln!(out, "\tif (db.isTransaction) {{");
let _ = writeln!(out, "\t\tawait run(db);");
let _ = writeln!(out, "\t}} else {{");
let _ = writeln!(out, "\t\tawait db.transaction().execute(run);");
let _ = writeln!(out, "\t}}");
let _ = write!(out, "}}");
}
impl CodegenBackend for TypescriptKyselyBackend {
fn name(&self) -> &str {
"typescript-kysely"
}
fn manifest(&self) -> &scythe_backend::manifest::BackendManifest {
&self.manifest
}
fn manifest_mut(&mut self) -> &mut scythe_backend::manifest::BackendManifest {
&mut self.manifest
}
fn supported_engines(&self) -> &[&str] {
&["postgresql", "redshift", "mysql", "mariadb", "sqlite", "mssql"]
}
fn file_header(&self) -> String {
self.header_with_kysely_import(true)
}
fn file_header_for_results(&self, generated: &[GeneratedCode]) -> String {
let needs_kysely = generated
.iter()
.filter_map(|code| code.query_fn.as_deref())
.any(|fragment| fragment.contains("Kysely<"));
self.header_with_kysely_import(needs_kysely)
}
fn generate_struct_decl(
&self,
struct_name: &str,
query_name: &str,
columns: &[ResolvedColumn],
) -> Result<String, ScytheError> {
if self.row_type == TsRowType::Zod {
if self.outer_join_unions {
return Ok(generate_zod_union_row_struct(struct_name, query_name, columns));
}
return Ok(generate_zod_row_struct(struct_name, query_name, columns));
}
if self.outer_join_unions {
return Ok(generate_ts_union_row_struct(struct_name, query_name, columns, None));
}
Ok(generate_ts_interface_row_struct(struct_name, query_name, columns))
}
fn generate_query_fn(
&self,
analyzed: &AnalyzedQuery,
struct_name: &str,
columns: &[ResolvedColumn],
params: &[ResolvedParam],
) -> Result<String, ScytheError> {
if self.structs_only {
return Ok(String::new());
}
let func_name = fn_name(&analyzed.name, &self.manifest.naming);
let mut out = String::new();
let cleaned = super::clean_sql_with_optional(&analyzed.sql, &analyzed.optional_params, &analyzed.params);
let escaped = escape_ts_template_literal(&cleaned);
let exprs: Vec<String> = params
.iter()
.map(|param| kysely_param_expr(analyzed, param, param.field_name.clone(), &self.manifest.naming))
.collect();
let sql_text = interpolate_kysely_params(&escaped, &exprs);
let write_fn_sig = |out: &mut String, name: &str, generic: &str, sig_params: &[(String, String)], ret: &str| {
let params_inline = sig_params
.iter()
.map(|(n, t)| format!("{n}: {t}"))
.collect::<Vec<_>>()
.join(", ");
let oneliner = format!("export async function {name}{generic}({params_inline}): {ret} {{");
if oneliner.len() <= 80 {
let _ = writeln!(out, "{oneliner}");
} else {
let _ = writeln!(out, "export async function {name}{generic}(");
for (n, t) in sig_params {
let _ = writeln!(out, "\t{n}: {t},");
}
let _ = writeln!(out, "): {ret} {{");
}
};
let query_sig_params: Vec<(String, String)> =
std::iter::once(("db".to_string(), "QueryExecutorProvider".to_string()))
.chain(params.iter().map(|p| (p.field_name.clone(), p.full_type.clone())))
.collect();
match &analyzed.command {
QueryCommand::One => {
let _ = writeln!(out, "/** Fetch a single {}. */", struct_name);
let ret = format!("Promise<{}>", struct_name);
write_fn_sig(&mut out, &func_name, "", &query_sig_params, &ret);
let _ = writeln!(
out,
"\tconst result = await sql<{}>`{}`.execute(db);",
struct_name, sql_text
);
let _ = writeln!(out, "\tconst row = result.rows[0];");
let _ = writeln!(out, "\tif (row === undefined) {{");
let _ = writeln!(out, "\t\t{}", ts_row_not_found_throw(&analyzed.name));
let _ = writeln!(out, "\t}}");
let overrides = ts_composite_field_overrides(columns, "row", self.field_case);
if overrides.is_empty() {
let _ = writeln!(out, "\treturn row;");
} else {
let _ = writeln!(out, "\treturn {{");
let _ = writeln!(out, "\t\t...row,");
for (key, expr) in &overrides {
let _ = writeln!(out, "\t\t{key}: {expr},");
}
let _ = writeln!(out, "\t}};");
}
let _ = write!(out, "}}");
}
QueryCommand::Opt => {
let _ = writeln!(out, "/** Fetch a single {} or null. */", struct_name);
let ret = format!("Promise<{} | null>", struct_name);
write_fn_sig(&mut out, &func_name, "", &query_sig_params, &ret);
let _ = writeln!(
out,
"\tconst result = await sql<{}>`{}`.execute(db);",
struct_name, sql_text
);
let overrides = ts_composite_field_overrides(columns, "row", self.field_case);
if overrides.is_empty() {
let _ = writeln!(out, "\treturn result.rows[0] ?? null;");
} else {
let _ = writeln!(out, "\tconst row = result.rows[0];");
let _ = writeln!(out, "\tif (row === undefined) {{");
let _ = writeln!(out, "\t\treturn null;");
let _ = writeln!(out, "\t}}");
let _ = writeln!(out, "\treturn {{");
let _ = writeln!(out, "\t\t...row,");
for (key, expr) in &overrides {
let _ = writeln!(out, "\t\t{key}: {expr},");
}
let _ = writeln!(out, "\t}};");
}
let _ = write!(out, "}}");
}
QueryCommand::Many => {
let _ = writeln!(out, "/** Fetch all {} rows. */", struct_name);
let ret = format!("Promise<{}[]>", struct_name);
write_fn_sig(&mut out, &func_name, "", &query_sig_params, &ret);
let _ = writeln!(
out,
"\tconst result = await sql<{}>`{}`.execute(db);",
struct_name, sql_text
);
let overrides = ts_composite_field_overrides(columns, "row", self.field_case);
if overrides.is_empty() {
let _ = writeln!(out, "\treturn result.rows;");
} else {
let _ = writeln!(out, "\treturn result.rows.map((row) => ({{");
let _ = writeln!(out, "\t\t...row,");
for (key, expr) in &overrides {
let _ = writeln!(out, "\t\t{key}: {expr},");
}
let _ = writeln!(out, "\t}}));");
}
let _ = write!(out, "}}");
}
QueryCommand::Batch => {
let batch_fn_name = format!("{}Batch", func_name);
if params.len() > 1 {
let params_type_name = format!("{}BatchParams", struct_name);
let item_exprs: Vec<String> = params
.iter()
.map(|param| {
kysely_param_expr(
analyzed,
param,
ts_member_access("item", ¶m.field_name),
&self.manifest.naming,
)
})
.collect();
let batch_sql = interpolate_kysely_params(&escaped, &item_exprs);
let _ = writeln!(out, "/** Params for {} batch operation. */", struct_name);
let _ = writeln!(out, "export interface {} {{", params_type_name);
for p in params {
let _ = writeln!(out, "\t{}: {};", ts_property_key(&p.field_name), p.full_type);
}
let _ = writeln!(out, "}}");
let _ = writeln!(out);
let _ = writeln!(
out,
"/** Execute {} for each item in the batch within a transaction. */",
analyzed.name
);
let batch_sig_params = vec![
("db".to_string(), "Kysely<DB>".to_string()),
("items".to_string(), format!("{params_type_name}[]")),
];
write_fn_sig(
&mut out,
&batch_fn_name,
"<DB = any>",
&batch_sig_params,
"Promise<void>",
);
write_batch_transaction_body(&mut out, "for (const item of items) {", &batch_sql);
} else if params.len() == 1 {
let item = kysely_param_expr(analyzed, ¶ms[0], "item".to_string(), &self.manifest.naming);
let batch_sql = interpolate_kysely_params(&escaped, &[item]);
let _ = writeln!(
out,
"/** Execute {} for each item in the batch within a transaction. */",
analyzed.name
);
let batch_sig_params = vec![
("db".to_string(), "Kysely<DB>".to_string()),
("items".to_string(), format!("{}[]", params[0].full_type)),
];
write_fn_sig(
&mut out,
&batch_fn_name,
"<DB = any>",
&batch_sig_params,
"Promise<void>",
);
write_batch_transaction_body(&mut out, "for (const item of items) {", &batch_sql);
} else {
let _ = writeln!(
out,
"/** Execute {} for each item in the batch within a transaction. */",
analyzed.name
);
let batch_sig_params = vec![
("db".to_string(), "Kysely<DB>".to_string()),
("count".to_string(), "number".to_string()),
];
write_fn_sig(
&mut out,
&batch_fn_name,
"<DB = any>",
&batch_sig_params,
"Promise<void>",
);
write_batch_transaction_body(&mut out, "for (let i = 0; i < count; i++) {", &sql_text);
}
}
QueryCommand::Exec => {
let _ = writeln!(out, "/** Execute a query returning no rows. */");
write_fn_sig(&mut out, &func_name, "", &query_sig_params, "Promise<void>");
let _ = writeln!(out, "\tawait sql`{}`.execute(db);", sql_text);
let _ = write!(out, "}}");
}
QueryCommand::ExecResult | QueryCommand::ExecRows => {
let _ = writeln!(out, "/** Execute a query and return the number of affected rows. */");
write_fn_sig(&mut out, &func_name, "", &query_sig_params, "Promise<number>");
let _ = writeln!(out, "\tconst result = await sql`{}`.execute(db);", sql_text);
let _ = writeln!(out, "\treturn Number(result.numAffectedRows ?? 0n);");
let _ = write!(out, "}}");
}
QueryCommand::Grouped => {
unreachable!("Grouped command is routed through generate_grouped_query_fn, not generate_query_fn")
}
}
Ok(out)
}
fn generate_grouped_structs(
&self,
parent_struct_name: &str,
child_struct_name: &str,
parent_columns: &[ResolvedColumn],
child_columns: &[ResolvedColumn],
_key_column: &str,
) -> Result<String, ScytheError> {
if self.row_type == TsRowType::Zod {
return Ok(generate_zod_grouped_structs(
child_struct_name,
parent_struct_name,
parent_columns,
child_columns,
));
}
Ok(generate_grouped_interface_structs(
child_struct_name,
parent_struct_name,
parent_columns,
child_columns,
))
}
fn generate_grouped_query_fn(&self, request: &GroupedQueryFn<'_>) -> Result<String, ScytheError> {
let analyzed = request.analyzed;
let parent_struct_name = request.parent_struct_name;
let child_struct_name = request.child_struct_name;
let all_columns = request.all_columns;
let parent_columns = request.parent_columns;
let child_columns = request.child_columns;
let params = request.params;
let key_column = request.key_column;
if self.structs_only {
return Ok(String::new());
}
let func_name = fn_name(&analyzed.name, &self.manifest.naming);
let cleaned = super::clean_sql_with_optional(&analyzed.sql, &analyzed.optional_params, &analyzed.params);
let escaped = escape_ts_template_literal(&cleaned);
let exprs: Vec<String> = params
.iter()
.map(|param| kysely_param_expr(analyzed, param, param.field_name.clone(), &self.manifest.naming))
.collect();
let sql_text = interpolate_kysely_params(&escaped, &exprs);
let mut out = String::new();
let param_list = params
.iter()
.map(|p| format!("{}: {}", p.field_name, p.full_type))
.collect::<Vec<_>>()
.join(", ");
let inline_params = if params.is_empty() {
"db: QueryExecutorProvider".to_string()
} else {
format!("db: QueryExecutorProvider, {}", param_list)
};
let ret = format!("Promise<{parent_struct_name}[]>");
let oneliner = format!("export async function {func_name}({inline_params}): {ret} {{");
if oneliner.len() <= 80 {
let _ = writeln!(out, "/** Fetch grouped {} rows. */", analyzed.name);
let _ = writeln!(out, "{oneliner}");
} else {
let _ = writeln!(out, "/** Fetch grouped {} rows. */", analyzed.name);
let _ = writeln!(out, "export async function {func_name}(");
let _ = writeln!(out, "\tdb: QueryExecutorProvider,");
for p in params {
let _ = writeln!(out, "\t{}: {},", p.field_name, p.full_type);
}
let _ = writeln!(out, "): {ret} {{");
}
let _ = writeln!(
out,
"\tconst {{ rows: flatRows }} = await sql<Record<string, unknown>>`{sql_text}`.execute(db);"
);
let driver_key_for = |raw_name: &str| -> String {
match self.field_case {
TsFieldCase::Snake => raw_name.to_string(),
TsFieldCase::Camel => all_columns
.iter()
.find(|c| c.name == raw_name)
.map_or_else(|| raw_name.to_string(), |c| c.field_name.clone()),
}
};
let fold = generate_ts_grouped_fold_body(
parent_struct_name,
child_struct_name,
parent_columns,
child_columns,
key_column,
false,
|name, ty| {
let key = driver_key_for(name);
let member = ts_index_access("row", &key);
if let Some(col) = all_columns.iter().find(|c| c.name == name)
&& col.neutral_type.starts_with("composite::")
{
return format!("parse{}({member}) as {ty}", col.lang_type);
}
format!("{member} as {ty}")
},
);
out.push_str(&fold);
let _ = write!(out, "}}");
Ok(out)
}
fn generate_enum_def(&self, enum_info: &EnumInfo) -> Result<String, ScytheError> {
let type_name = enum_type_name(&enum_info.sql_name, &self.manifest.naming);
if self.row_type == TsRowType::Zod {
return Ok(generate_zod_enum(&type_name, &enum_info.values, &self.manifest.naming));
}
let mut out = String::new();
let values_name = format!("{}Values", type_name);
let _ = writeln!(out, "export const {} = {{", values_name);
for value in &enum_info.values {
let variant = enum_variant_name(value, &self.manifest.naming);
let _ = writeln!(out, "\t{}: \"{}\",", variant, value);
}
let _ = writeln!(out, "}} as const;");
let _ = writeln!(out);
let _ = write!(
out,
"export type {} = typeof {}[keyof typeof {}];",
type_name, values_name, values_name
);
Ok(out)
}
fn generate_composite_def(&self, composite: &CompositeInfo) -> Result<String, ScytheError> {
let name = composite_type_name(&composite.sql_name, &self.manifest.naming);
let mut out = String::new();
let _ = writeln!(out, "/** Composite type {}. */", composite.sql_name);
let _ = writeln!(out, "export interface {} {{", name);
if composite.fields.is_empty() {
let _ = write!(out, "}}");
return Ok(out);
}
let mut field_types: Vec<String> = Vec::with_capacity(composite.fields.len());
for field in &composite.fields {
let ts_type = resolve_type(&field.neutral_type, &self.manifest, field.nullable)
.map(|t| t.into_owned())
.map_err(|e| {
ScytheError::new(ErrorCode::InternalError, format!("composite field type error: {}", e))
})?;
let _ = writeln!(out, "\t{}: {};", ts_property_key(&to_camel_case(&field.name)), ts_type);
field_types.push(ts_type);
}
let _ = writeln!(out, "}}");
let _ = writeln!(out);
let _ = writeln!(
out,
"// ~keep board #204: whatever driver this wraps has no adapter for a user-defined"
);
let _ = writeln!(
out,
"// composite -- it hands back the raw text form as a plain string."
);
let _ = writeln!(out, "export function parse{name}(raw: unknown): {name} | null {{");
let _ = writeln!(out, "\tif (raw === null || raw === undefined) {{");
let _ = writeln!(out, "\t\treturn null;");
let _ = writeln!(out, "\t}}");
let _ = writeln!(out, "\tconst f = parse{name}Fields(raw as string);");
let _ = writeln!(out, "\treturn {{");
for (i, field) in composite.fields.iter().enumerate() {
let raw = format!("f[{i}]");
let conversion_type = resolve_type(&field.neutral_type, &self.manifest, false)
.map(|t| t.into_owned())
.map_err(|e| {
ScytheError::new(ErrorCode::InternalError, format!("composite field type error: {}", e))
})?;
let value_expr =
ts_composite_field_from_text(&field.neutral_type, &conversion_type, &raw, field.nullable, &name);
let _ = writeln!(
out,
"\t\t{}: {value_expr},",
ts_property_key(&to_camel_case(&field.name))
);
}
let _ = writeln!(out, "\t}};");
let _ = writeln!(out, "}}");
let _ = writeln!(out);
out.push_str(&ts_parse_composite_fields_helper(&name));
if ts_composite_needs_bytes_helper(composite) {
let _ = writeln!(out);
let _ = writeln!(out);
out.push_str(&ts_parse_composite_bytes_helper(&name));
}
if ts_composite_needs_offset_datetime_helper(composite) {
let _ = writeln!(out);
let _ = writeln!(out);
out.push_str(&ts_parse_composite_offset_datetime_helper(&name));
}
let _ = writeln!(out);
let _ = writeln!(out);
out.push_str(&ts_encode_composite_helper(composite, &self.manifest.naming));
Ok(out)
}
fn generate_nested_struct_def(
&self,
nested: &scythe_core::analyzer::NestedStructInfo,
) -> Result<Option<String>, ScytheError> {
if !self.manifest.types.containers.contains_key("json_nested") {
return Ok(None);
}
Ok(generate_ts_nested_interface_with_field_case(nested, &self.manifest, self.field_case).ok())
}
fn generate_composite_def_for_nested(&self, composite: &CompositeInfo) -> Result<String, ScytheError> {
let mut out = self.generate_composite_def(composite)?;
if self.manifest.types.containers.contains_key("json_nested") {
out.push_str("\n\n");
out.push_str(&generate_ts_json_composite_interface_with_field_case(
composite,
&self.manifest,
self.field_case,
)?);
}
Ok(out)
}
fn apply_options(&mut self, options: &std::collections::HashMap<String, String>) -> Result<(), ScytheError> {
reject_unknown_options(
&["row_type", "outer_join_unions", "structs_only", "field_case"],
options,
)?;
if let Some(value) = options.get("row_type") {
self.row_type = TsRowType::from_option(value)?;
}
if let Some(value) = options.get("outer_join_unions") {
self.outer_join_unions = parse_bool_option("outer_join_unions", value)?;
}
if let Some(value) = options.get("structs_only") {
self.structs_only = parse_bool_option("structs_only", value)?;
}
if let Some(value) = options.get("field_case") {
self.field_case = TsFieldCase::from_option(value)?;
self.manifest.naming.field_case = value.clone();
}
Ok(())
}
}
#[cfg(test)]
mod tests {
use super::{TsFieldCase, TypescriptKyselyBackend, ts_composite_field_overrides};
use crate::GeneratedCode;
use crate::backend_trait::CodegenBackend;
use scythe_core::analyzer::{
AnalyzedColumn, AnalyzedParam, AnalyzedQuery, CompositeFieldInfo, CompositeInfo, GroupByConfig,
NestedFieldInfo, NestedStructInfo,
};
use scythe_core::parser::QueryCommand;
fn make_grouped_query() -> AnalyzedQuery {
let parent_cols = vec![
AnalyzedColumn {
name: "id".to_string(),
neutral_type: "int32".to_string(),
nullable: false,
..Default::default()
},
AnalyzedColumn {
name: "name".to_string(),
neutral_type: "string".to_string(),
nullable: false,
..Default::default()
},
AnalyzedColumn {
name: "email".to_string(),
neutral_type: "string".to_string(),
nullable: false,
..Default::default()
},
];
let child_cols = vec![
AnalyzedColumn {
name: "order_id".to_string(),
neutral_type: "int32".to_string(),
nullable: false,
..Default::default()
},
AnalyzedColumn {
name: "total".to_string(),
neutral_type: "decimal".to_string(),
nullable: true,
..Default::default()
},
AnalyzedColumn {
name: "order_date".to_string(),
neutral_type: "datetime".to_string(),
nullable: false,
..Default::default()
},
];
let all_cols = [parent_cols.clone(), child_cols.clone()].concat();
AnalyzedQuery::build(|aq| {
aq.name = "GetUsersWithOrders".to_string();
aq.command = QueryCommand::Grouped;
aq.sql = "SELECT u.id, u.name, u.email, o.id AS order_id, o.total, o.created_at AS order_date\nFROM users u\nJOIN orders o ON o.user_id = u.id".to_string();
aq.columns = all_cols;
aq.params = vec![];
aq.deprecated = None;
aq.source_table = None;
aq.composites = vec![];
aq.enums = vec![];
aq.optional_params = vec![];
aq.group_by = Some(GroupByConfig {
table: "users".to_string(),
key_column: "id".to_string(),
parent_columns: parent_cols,
child_columns: child_cols,
});
aq.custom = vec![];
})
}
fn make_one_query(sql: &str, params: Vec<AnalyzedParam>) -> AnalyzedQuery {
AnalyzedQuery::build(|aq| {
aq.name = "GetUserById".to_string();
aq.command = QueryCommand::One;
aq.sql = sql.to_string();
aq.columns = vec![
AnalyzedColumn {
name: "id".to_string(),
neutral_type: "int32".to_string(),
nullable: false,
..Default::default()
},
AnalyzedColumn {
name: "name".to_string(),
neutral_type: "string".to_string(),
nullable: false,
..Default::default()
},
];
aq.params = params;
aq.deprecated = None;
aq.source_table = None;
aq.composites = vec![];
aq.enums = vec![];
aq.optional_params = vec![];
aq.group_by = None;
aq.custom = vec![];
})
}
#[test]
fn test_header_omits_the_kysely_import_when_nothing_needs_it() {
let backend = TypescriptKyselyBackend::new("postgresql").expect("backend");
let generated = vec![GeneratedCode {
query_fn: Some("export async function f(db: QueryExecutorProvider) {}".to_string()),
row_struct: None,
model_struct: None,
enum_def: None,
nested_struct_defs: Vec::new(),
..Default::default()
}];
let header = backend.file_header_for_results(&generated);
assert!(
!header.contains("type Kysely"),
"nothing in the file needs Kysely; got:\n{header}"
);
assert!(header.contains("type QueryExecutorProvider"), "got:\n{header}");
}
#[test]
fn test_header_imports_kysely_when_a_batch_fn_needs_it() {
let backend = TypescriptKyselyBackend::new("postgresql").expect("backend");
let generated = vec![GeneratedCode {
query_fn: Some("export async function fBatch<DB = any>(db: Kysely<DB>) {}".to_string()),
row_struct: None,
model_struct: None,
enum_def: None,
nested_struct_defs: Vec::new(),
..Default::default()
}];
let header = backend.file_header_for_results(&generated);
assert!(
header.contains("type Kysely,"),
"a batch fn needs the Kysely type; got:\n{header}"
);
}
#[test]
fn test_engine_selects_manifest_and_rejects_unsupported() {
assert!(TypescriptKyselyBackend::new("postgresql").is_ok());
assert!(TypescriptKyselyBackend::new("redshift").is_ok());
assert!(TypescriptKyselyBackend::new("mysql").is_ok());
assert!(TypescriptKyselyBackend::new("mariadb").is_ok());
assert!(TypescriptKyselyBackend::new("sqlite").is_ok());
assert!(TypescriptKyselyBackend::new("mssql").is_ok());
assert!(TypescriptKyselyBackend::new("oracle").is_err());
}
#[test]
fn test_redshift_engine_is_supported_and_uses_redshift_scalars() {
use crate::backend_trait::CodegenBackend;
let backend = TypescriptKyselyBackend::new("redshift").unwrap();
assert!(backend.supported_engines().contains(&"redshift"));
let manifest = backend.manifest();
assert_eq!(
manifest.types.scalars.get("super").map(String::as_str),
Some("Record<string, unknown>"),
"redshift manifest must map the SUPER scalar"
);
assert_eq!(
manifest.types.scalars.get("geometry").map(String::as_str),
Some("string"),
"redshift manifest must map the GEOMETRY scalar"
);
let postgres_manifest = TypescriptKyselyBackend::new("postgresql").unwrap();
assert!(
!postgres_manifest.manifest().types.scalars.contains_key("super"),
"the plain postgresql manifest must not carry redshift-only scalars"
);
}
#[test]
fn test_query_fn_uses_sql_tag_with_js_interpolation_not_dialect_placeholders() {
let backend = TypescriptKyselyBackend::new("postgresql").unwrap();
let query = make_one_query(
"SELECT id, name FROM users WHERE id = $1",
vec![AnalyzedParam {
name: "id".to_string(),
neutral_type: "int32".to_string(),
nullable: false,
position: 1,
source_relation: None,
}],
);
let result = crate::generate_with_backend(&query, &backend).unwrap();
let query_fn = result.query_fn.as_deref().unwrap();
assert!(
query_fn.contains("db: QueryExecutorProvider"),
"must accept the minimal QueryExecutorProvider Kysely's sql tag actually needs \
(Kysely, Transaction, ControlledTransaction, or a caller's own adapter all satisfy it), \
not the narrower Kysely<DB>; got:\n{query_fn}"
);
assert!(
!query_fn.contains("<DB = any>") && !query_fn.contains("Kysely<DB>"),
"the DB generic is unused once db is QueryExecutorProvider and must be dropped, not left vestigial; got:\n{query_fn}"
);
assert!(
query_fn.contains("sql<GetUserByIdRow>`SELECT id, name FROM users WHERE id = ${id}`.execute(db)"),
"must interpolate params through the sql tag, not emit dialect placeholder text; got:\n{query_fn}"
);
assert!(
!query_fn.contains("$1"),
"must not leak the postgres placeholder into the sql tag; got:\n{query_fn}"
);
assert!(
query_fn.contains(
"const row = result.rows[0];\n\tif (row === undefined) {\n\t\tthrow new Error(\"no row found for query: GetUserById\");\n\t}\n\treturn row;"
),
"`:one` must throw on a missing row, not return null; got:\n{query_fn}"
);
}
#[test]
fn test_query_fn_interpolates_bare_placeholders_for_mysql_sqlite_and_mssql() {
let expected_scalars = [
("mysql", "number", "string", "Date", "Record<string, unknown>"),
("sqlite", "number", "number", "string", "Record<string, unknown>"),
("mssql", "boolean", "string", "Date", "string"),
];
for (engine, bool_ty, decimal_ty, datetime_ty, json_ty) in expected_scalars {
let backend = TypescriptKyselyBackend::new(engine).unwrap();
let manifest = backend.manifest();
assert_eq!(
manifest.types.scalars.get("bool").map(String::as_str),
Some(bool_ty),
"engine {engine} bool scalar mismatch"
);
assert_eq!(
manifest.types.scalars.get("decimal").map(String::as_str),
Some(decimal_ty),
"engine {engine} decimal scalar mismatch"
);
assert_eq!(
manifest.types.scalars.get("datetime").map(String::as_str),
Some(datetime_ty),
"engine {engine} datetime scalar mismatch"
);
assert_eq!(
manifest.types.scalars.get("json").map(String::as_str),
Some(json_ty),
"engine {engine} json scalar mismatch"
);
let query = make_one_query(
"SELECT id, name FROM users WHERE id = ?",
vec![AnalyzedParam {
name: "id".to_string(),
neutral_type: "int32".to_string(),
nullable: false,
position: 1,
source_relation: None,
}],
);
let result = crate::generate_with_backend(&query, &backend).unwrap();
let query_fn = result.query_fn.as_deref().unwrap();
assert!(
query_fn.contains("WHERE id = ${id}`.execute(db)"),
"engine {engine} must interpolate bare '?' placeholders too; got:\n{query_fn}"
);
}
}
#[test]
fn test_query_fn_escapes_user_backtick_in_sql() {
let backend = TypescriptKyselyBackend::new("mysql").unwrap();
let query = make_one_query("SELECT `id`, `name` FROM `users`", vec![]);
let result = crate::generate_with_backend(&query, &backend).unwrap();
let query_fn = result.query_fn.as_deref().unwrap();
assert!(
query_fn.contains(r"SELECT \`id\`, \`name\` FROM \`users\`"),
"user backticks must be escaped; got:\n{query_fn}"
);
}
#[test]
fn test_query_fn_escapes_user_dollar_brace_but_keeps_own_param_bindings_live() {
let backend = TypescriptKyselyBackend::new("postgresql").unwrap();
let query = make_one_query(
"SELECT id FROM users WHERE name = 'literal ${not_a_binding}' AND id = $1",
vec![AnalyzedParam {
name: "id".to_string(),
neutral_type: "int32".to_string(),
nullable: false,
position: 1,
source_relation: None,
}],
);
let result = crate::generate_with_backend(&query, &backend).unwrap();
let query_fn = result.query_fn.as_deref().unwrap();
assert!(
query_fn.contains(r"'literal \${not_a_binding}'"),
"user's literal ${{}} must be escaped inert text; got:\n{query_fn}"
);
assert!(
query_fn.contains("AND id = ${id}"),
"scythe's own param binding must stay a live interpolation; got:\n{query_fn}"
);
}
#[test]
fn test_query_fn_escapes_user_backslash_in_sql() {
let backend = TypescriptKyselyBackend::new("postgresql").unwrap();
let query = make_one_query(r"SELECT id FROM users WHERE name = E'a\\b'", vec![]);
let result = crate::generate_with_backend(&query, &backend).unwrap();
let query_fn = result.query_fn.as_deref().unwrap();
assert!(
query_fn.contains(r"E'a\\\\b'"),
"user backslash must be doubled; got:\n{query_fn}"
);
}
#[test]
fn test_exec_result_reads_num_affected_rows() {
let backend = TypescriptKyselyBackend::new("postgresql").unwrap();
let mut query = make_one_query(
"DELETE FROM orders WHERE user_id = $1",
vec![AnalyzedParam {
name: "user_id".to_string(),
neutral_type: "int32".to_string(),
nullable: false,
position: 1,
source_relation: None,
}],
);
query.command = QueryCommand::ExecRows;
let result = crate::generate_with_backend(&query, &backend).unwrap();
let query_fn = result.query_fn.as_deref().unwrap();
assert!(
query_fn.contains("Number(result.numAffectedRows ?? 0n)"),
"got:\n{query_fn}"
);
}
#[test]
fn test_batch_uses_kysely_transaction() {
let backend = TypescriptKyselyBackend::new("postgresql").unwrap();
let mut query = make_one_query(
"INSERT INTO users (name) VALUES ($1)",
vec![AnalyzedParam {
name: "name".to_string(),
neutral_type: "string".to_string(),
nullable: false,
position: 1,
source_relation: None,
}],
);
query.command = QueryCommand::Batch;
let result = crate::generate_with_backend(&query, &backend).unwrap();
let query_fn = result.query_fn.as_deref().unwrap();
assert!(
query_fn.contains("db: Kysely<DB>") && query_fn.contains("<DB = any>"),
":batch calls db.transaction()/db.isTransaction, both Kysely/Transaction-specific, so it must \
keep the narrower Kysely<DB> parameter (unlike the widened QueryExecutorProvider commands); got:\n{query_fn}"
);
assert!(query_fn.contains("db.transaction().execute(run)"), "got:\n{query_fn}");
assert!(
query_fn.contains("sql`INSERT INTO users (name) VALUES (${item}"),
"got:\n{query_fn}"
);
assert!(query_fn.contains(".execute(trx)"), "got:\n{query_fn}");
}
#[test]
fn test_batch_reuses_existing_transaction_instead_of_nesting() {
let backend = TypescriptKyselyBackend::new("postgresql").unwrap();
let mut multi_query = make_one_query(
"INSERT INTO users (name, email) VALUES ($1, $2)",
vec![
AnalyzedParam {
name: "name".to_string(),
neutral_type: "string".to_string(),
nullable: false,
position: 1,
source_relation: None,
},
AnalyzedParam {
name: "email".to_string(),
neutral_type: "string".to_string(),
nullable: false,
position: 2,
source_relation: None,
},
],
);
multi_query.command = QueryCommand::Batch;
let multi_result = crate::generate_with_backend(&multi_query, &backend).unwrap();
let multi_fn = multi_result.query_fn.as_deref().unwrap();
assert!(
multi_fn.contains("if (db.isTransaction) {")
&& multi_fn.contains("await run(db);")
&& multi_fn.contains("} else {")
&& multi_fn.contains("await db.transaction().execute(run);"),
"multi-param batch must reuse an existing transaction via db.isTransaction; got:\n{multi_fn}"
);
assert!(
!multi_fn.contains("db.transaction().execute(async (trx) => {"),
"must not unconditionally open a nested transaction; got:\n{multi_fn}"
);
let mut single_query = make_one_query(
"INSERT INTO users (name) VALUES ($1)",
vec![AnalyzedParam {
name: "name".to_string(),
neutral_type: "string".to_string(),
nullable: false,
position: 1,
source_relation: None,
}],
);
single_query.command = QueryCommand::Batch;
let single_result = crate::generate_with_backend(&single_query, &backend).unwrap();
let single_fn = single_result.query_fn.as_deref().unwrap();
assert!(
single_fn.contains("if (db.isTransaction) {") && single_fn.contains("await run(db);"),
"single-param batch must reuse an existing transaction via db.isTransaction; got:\n{single_fn}"
);
let mut count_query = make_one_query("DELETE FROM sessions WHERE expired = true", vec![]);
count_query.command = QueryCommand::Batch;
let count_result = crate::generate_with_backend(&count_query, &backend).unwrap();
let count_fn = count_result.query_fn.as_deref().unwrap();
assert!(
count_fn.contains("if (db.isTransaction) {") && count_fn.contains("await run(db);"),
"count-based batch must reuse an existing transaction via db.isTransaction; got:\n{count_fn}"
);
assert!(
count_fn.contains("for (let i = 0; i < count; i++) {"),
"got:\n{count_fn}"
);
}
#[test]
fn test_grouped_typescript_kysely_structs() {
let backend = TypescriptKyselyBackend::new("postgresql").unwrap();
let query = make_grouped_query();
let result = crate::generate_with_backend(&query, &backend).unwrap();
let row_struct = result.row_struct.as_deref().unwrap();
assert!(
row_struct.contains("interface GetUsersWithOrdersChildRow"),
"missing child; got:\n{row_struct}"
);
assert!(
row_struct.contains("order_id: number"),
"child missing order_id; got:\n{row_struct}"
);
assert!(
row_struct.contains("interface GetUsersWithOrdersRow"),
"missing parent; got:\n{row_struct}"
);
assert!(
row_struct.contains("children: GetUsersWithOrdersChildRow[]"),
"missing children; got:\n{row_struct}"
);
}
#[test]
fn test_grouped_typescript_kysely_query_fn() {
let backend = TypescriptKyselyBackend::new("postgresql").unwrap();
let query = make_grouped_query();
let result = crate::generate_with_backend(&query, &backend).unwrap();
let query_fn = result.query_fn.as_deref().unwrap();
assert!(
query_fn.contains("getUsersWithOrders"),
"missing fn name; got:\n{query_fn}"
);
assert!(
query_fn.contains("Promise<GetUsersWithOrdersRow[]>"),
"wrong return type; got:\n{query_fn}"
);
assert!(
query_fn.contains("sql<Record<string, unknown>>`") && query_fn.contains(".execute(db)"),
"must use the sql tag; got:\n{query_fn}"
);
assert!(
query_fn.contains("row['id'] as number"),
"must cast through the unknown row shape; got:\n{query_fn}"
);
assert!(
query_fn.contains("new Map<unknown, GetUsersWithOrdersRow>()"),
"must use Map; got:\n{query_fn}"
);
assert!(
query_fn.contains("parent.children.push"),
"must fold children; got:\n{query_fn}"
);
}
#[test]
fn should_emit_camel_case_plugin_note_only_under_camel_case() {
let plain = TypescriptKyselyBackend::new("postgresql").unwrap();
assert!(
!plain.file_header().contains("CamelCasePlugin"),
"the default snake_case config needs no plugin, so it must not warn about one"
);
for structs_only in [false, true] {
let mut backend = TypescriptKyselyBackend::new("postgresql").unwrap();
let mut options = std::collections::HashMap::from([("field_case".to_string(), "camelCase".to_string())]);
if structs_only {
options.insert("structs_only".to_string(), "true".to_string());
}
backend.apply_options(&options).unwrap();
let header = backend.file_header();
assert!(
header.contains("CamelCasePlugin"),
"field_case = camelCase must warn (structs_only = {structs_only}); got:\n{header}"
);
assert!(
header.contains("undefined"),
"the warning has to state the consequence, not just name the plugin; got:\n{header}"
);
}
}
#[test]
fn test_grouped_fold_reads_by_field_name_under_camel_case() {
let mut backend = TypescriptKyselyBackend::new("postgresql").unwrap();
backend
.apply_options(&std::collections::HashMap::from([(
"field_case".to_string(),
"camelCase".to_string(),
)]))
.unwrap();
let query = make_grouped_query();
let result = crate::generate_with_backend(&query, &backend).unwrap();
let query_fn = result.query_fn.as_deref().unwrap();
assert!(
query_fn.contains("row['orderId']"),
"must read the camelCase field name; got:\n{query_fn}"
);
assert!(
query_fn.contains("row['orderDate']"),
"must read the camelCase field name; got:\n{query_fn}"
);
assert!(
!query_fn.contains("row['order_id']") && !query_fn.contains("row['order_date']"),
"must not read the raw SQL name once field_case renamed it; got:\n{query_fn}"
);
}
#[test]
fn test_composite_row_override_reads_camel_case_driver_key() {
use crate::backend_trait::ResolvedColumn;
let columns = vec![ResolvedColumn {
name: "home_address".to_string(),
field_name: "homeAddress".to_string(),
lang_type: "WidgetAddress".to_string(),
full_type: "WidgetAddress".to_string(),
neutral_type: "composite::widget_address".to_string(),
sql_type: "widget_address".to_string(),
nullable: false,
join_group: None,
nullable_before_join: false,
}];
assert_eq!(
ts_composite_field_overrides(&columns, "row", TsFieldCase::Camel),
vec![(
"homeAddress".to_string(),
"parseWidgetAddress(row.homeAddress) as WidgetAddress".to_string(),
)]
);
}
fn make_grouped_query_with_pascal_case_columns() -> AnalyzedQuery {
let mut query = make_grouped_query();
let rename = |name: &str| match name {
"order_id" => "OrderId".to_string(),
"order_date" => "OrderDate".to_string(),
other => other.to_string(),
};
for column in &mut query.columns {
column.name = rename(&column.name);
}
if let Some(group_by) = query.group_by.as_mut() {
for column in &mut group_by.child_columns {
column.name = rename(&column.name);
}
}
query
}
#[test]
fn test_grouped_fold_reads_the_raw_sql_name_by_default() {
let backend = TypescriptKyselyBackend::new("mssql").unwrap();
let query = make_grouped_query_with_pascal_case_columns();
let result = crate::generate_with_backend(&query, &backend).unwrap();
let query_fn = result.query_fn.as_deref().unwrap();
assert!(
query_fn.contains("row['OrderId']") && query_fn.contains("row['OrderDate']"),
"must read the key the driver actually returns; got:\n{query_fn}"
);
assert!(
!query_fn.contains("row['order_id']") && !query_fn.contains("row['order_date']"),
"must not read a snake_cased key the driver never produced; got:\n{query_fn}"
);
assert!(
query_fn.contains("order_id: row['OrderId']"),
"must still write the declared field name; got:\n{query_fn}"
);
}
fn make_one_query_with_snake_case_column() -> AnalyzedQuery {
AnalyzedQuery::build(|q| {
q.name = "GetSession".to_string();
q.command = QueryCommand::One;
q.sql = "SELECT id, user_id FROM sessions WHERE id = $1".to_string();
q.columns = vec![
AnalyzedColumn {
name: "id".to_string(),
neutral_type: "int32".to_string(),
nullable: false,
..Default::default()
},
AnalyzedColumn {
name: "user_id".to_string(),
neutral_type: "int32".to_string(),
nullable: false,
..Default::default()
},
];
q.params = vec![];
q.deprecated = None;
q.source_table = None;
q.composites = vec![];
q.enums = vec![];
q.optional_params = vec![];
q.group_by = None;
q.custom = vec![];
})
}
#[test]
fn test_field_case_option_renames_declared_struct_fields() {
let mut backend = TypescriptKyselyBackend::new("postgresql").unwrap();
backend
.apply_options(&std::collections::HashMap::from([(
"field_case".to_string(),
"camelCase".to_string(),
)]))
.unwrap();
let query = make_one_query_with_snake_case_column();
let result = crate::generate_with_backend(&query, &backend).unwrap();
let row_struct = result.row_struct.as_deref().unwrap();
assert!(
row_struct.contains("userId: number;"),
"field_case must rename the declared struct field; got:\n{row_struct}"
);
assert!(
!row_struct.contains("user_id"),
"must not leave the raw SQL name in the declaration; got:\n{row_struct}"
);
}
#[test]
fn test_camel_case_plugin_shapes_nested_json_interface_keys() {
let mut backend = TypescriptKyselyBackend::new("postgresql").unwrap();
backend
.apply_options(&std::collections::HashMap::from([(
"field_case".to_string(),
"camelCase".to_string(),
)]))
.unwrap();
let nested = NestedStructInfo {
name: "get_users_as_json_row_payload".to_string(),
fields: vec![NestedFieldInfo {
name: "secondary_status".to_string(),
neutral_type: "string".to_string(),
nullable: true,
}],
};
let generated = backend
.generate_nested_struct_def(&nested)
.unwrap()
.expect("nested JSON interface");
assert!(
generated.contains("secondaryStatus: string | null;"),
"got:\n{generated}"
);
assert!(!generated.contains("secondary_status:"), "got:\n{generated}");
}
#[test]
fn test_camel_case_plugin_shapes_json_composite_interface_keys() {
let mut backend = TypescriptKyselyBackend::new("postgresql").unwrap();
backend
.apply_options(&std::collections::HashMap::from([(
"field_case".to_string(),
"camelCase".to_string(),
)]))
.unwrap();
let composite = CompositeInfo {
sql_name: "user_address".to_string(),
fields: vec![CompositeFieldInfo {
name: "postal_code".to_string(),
neutral_type: "string".to_string(),
nullable: false,
}],
};
let generated = backend.generate_composite_def_for_nested(&composite).unwrap();
assert!(generated.contains("postalCode: string;"), "got:\n{generated}");
assert!(!generated.contains("postal_code: string;"), "got:\n{generated}");
}
#[test]
fn test_field_case_option_does_not_add_a_runtime_remap_to_one_query() {
let mut backend = TypescriptKyselyBackend::new("postgresql").unwrap();
backend
.apply_options(&std::collections::HashMap::from([(
"field_case".to_string(),
"camelCase".to_string(),
)]))
.unwrap();
let query = make_one_query_with_snake_case_column();
let result = crate::generate_with_backend(&query, &backend).unwrap();
let query_fn = result.query_fn.as_deref().unwrap();
assert!(
query_fn.contains("sql<GetSessionRow>`"),
"must still trust Kysely's own generic, no remap; got:\n{query_fn}"
);
assert!(
query_fn.contains("const row = result.rows[0];"),
"must read Kysely's row directly, unmodified; got:\n{query_fn}"
);
assert!(
query_fn.contains("throw new Error(\"no row found for query: GetSession\");"),
"`:one` must throw on a missing row; got:\n{query_fn}"
);
}
#[test]
fn test_field_case_option_rejects_invalid_value() {
let mut backend = TypescriptKyselyBackend::new("postgresql").unwrap();
let result = backend.apply_options(&std::collections::HashMap::from([(
"field_case".to_string(),
"PascalCase".to_string(),
)]));
assert!(result.is_err(), "expected 'PascalCase' to be rejected");
}
#[test]
fn test_outer_join_unions_option_applies_to_kysely_row_struct() {
use crate::backend_trait::ResolvedColumn;
let mut backend = TypescriptKyselyBackend::new("postgresql").unwrap();
backend
.apply_options(&std::collections::HashMap::from([(
"outer_join_unions".to_string(),
"true".to_string(),
)]))
.unwrap();
assert!(backend.outer_join_unions);
let columns = vec![
ResolvedColumn {
name: "id".to_string(),
field_name: "id".to_string(),
lang_type: "number".to_string(),
full_type: "number".to_string(),
neutral_type: "int32".to_string(),
sql_type: "int4".to_string(),
nullable: false,
join_group: None,
nullable_before_join: false,
},
ResolvedColumn {
name: "total".to_string(),
field_name: "total".to_string(),
lang_type: "string".to_string(),
full_type: "string | null".to_string(),
neutral_type: "decimal".to_string(),
sql_type: "numeric".to_string(),
nullable: true,
join_group: Some("o".to_string()),
nullable_before_join: false,
},
ResolvedColumn {
name: "notes".to_string(),
field_name: "notes".to_string(),
lang_type: "string".to_string(),
full_type: "string | null".to_string(),
neutral_type: "string".to_string(),
sql_type: "text".to_string(),
nullable: true,
join_group: Some("o".to_string()),
nullable_before_join: true,
},
];
let flat = crate::backends::typescript_common::generate_ts_interface_row_struct(
"GetUserOrdersRow",
"GetUserOrders",
&columns,
);
assert!(
flat.contains("total: string | null;") && flat.contains("notes: string | null;"),
"sanity check on the flat baseline; got:\n{flat}"
);
let row_struct = backend.generate_row_struct("GetUserOrders", &columns).unwrap();
assert_ne!(
row_struct, flat,
"outer_join_unions must change the emitted shape, not silently fall through to the flat interface"
);
assert!(
row_struct.contains("export type GetUserOrdersRow = {"),
"must emit a type alias (interfaces can't express a union), not `export interface`; got:\n{row_struct}"
);
assert!(
row_struct.contains("\t| { total: string; notes: string | null }"),
"matched branch: total ignores its own nullability (lang_type) since the join matched, \
notes keeps its own nullable full_type because it's nullable even on a match; got:\n{row_struct}"
);
assert!(
row_struct.contains("\t| { total: null; notes: null }"),
"unmatched branch: every projected column in the join group is null together; got:\n{row_struct}"
);
}
#[test]
fn test_zod_row_type_combined_with_outer_join_unions_emits_a_real_union_schema() {
use crate::backend_trait::ResolvedColumn;
let mut backend = TypescriptKyselyBackend::new("postgresql").unwrap();
backend
.apply_options(&std::collections::HashMap::from([
("row_type".to_string(), "zod".to_string()),
("outer_join_unions".to_string(), "true".to_string()),
]))
.unwrap();
let columns = vec![
ResolvedColumn {
name: "id".to_string(),
field_name: "id".to_string(),
lang_type: "number".to_string(),
full_type: "number".to_string(),
neutral_type: "int32".to_string(),
sql_type: "int4".to_string(),
nullable: false,
join_group: None,
nullable_before_join: false,
},
ResolvedColumn {
name: "total".to_string(),
field_name: "total".to_string(),
lang_type: "string".to_string(),
full_type: "string | null".to_string(),
neutral_type: "decimal".to_string(),
sql_type: "numeric".to_string(),
nullable: true,
join_group: Some("o".to_string()),
nullable_before_join: false,
},
ResolvedColumn {
name: "notes".to_string(),
field_name: "notes".to_string(),
lang_type: "string".to_string(),
full_type: "string | null".to_string(),
neutral_type: "string".to_string(),
sql_type: "text".to_string(),
nullable: true,
join_group: Some("o".to_string()),
nullable_before_join: true,
},
];
let row_struct = backend.generate_row_struct("GetUserOrders", &columns).unwrap();
assert!(
row_struct.contains(".and(z.union(["),
"must emit a real discriminated union, not the flat schema; got:\n{row_struct}"
);
assert!(
row_struct.contains("z.object({ total: z.string(), notes: z.string().nullable() })"),
"got:\n{row_struct}"
);
assert!(
row_struct.contains("z.object({ total: z.null(), notes: z.null() })"),
"got:\n{row_struct}"
);
assert!(
row_struct.contains("export type GetUserOrdersRow = z.infer<typeof GetUserOrdersRowSchema>;"),
"must still infer the row type from the schema; got:\n{row_struct}"
);
}
#[test]
fn test_zod_row_type_combined_with_outer_join_unions_falls_back_without_a_discriminant() {
use crate::backend_trait::ResolvedColumn;
let mut backend = TypescriptKyselyBackend::new("postgresql").unwrap();
backend
.apply_options(&std::collections::HashMap::from([
("row_type".to_string(), "zod".to_string()),
("outer_join_unions".to_string(), "true".to_string()),
]))
.unwrap();
let columns = vec![ResolvedColumn {
name: "id".to_string(),
field_name: "id".to_string(),
lang_type: "number".to_string(),
full_type: "number".to_string(),
neutral_type: "int32".to_string(),
sql_type: "int4".to_string(),
nullable: false,
join_group: None,
nullable_before_join: false,
}];
let row_struct = backend.generate_row_struct("GetUsers", &columns).unwrap();
assert!(
!row_struct.contains(".and("),
"no union without a discriminant; got:\n{row_struct}"
);
assert!(row_struct.contains("z.object({"), "got:\n{row_struct}");
}
#[test]
fn test_zod_row_type_without_outer_join_unions_is_unchanged() {
use crate::backend_trait::ResolvedColumn;
let mut backend = TypescriptKyselyBackend::new("postgresql").unwrap();
backend
.apply_options(&std::collections::HashMap::from([(
"row_type".to_string(),
"zod".to_string(),
)]))
.unwrap();
let columns = vec![ResolvedColumn {
name: "id".to_string(),
field_name: "id".to_string(),
lang_type: "number".to_string(),
full_type: "number".to_string(),
neutral_type: "int32".to_string(),
sql_type: "int4".to_string(),
nullable: false,
join_group: None,
nullable_before_join: false,
}];
let row_struct = backend.generate_row_struct("GetUsers", &columns).unwrap();
assert_eq!(
row_struct,
crate::backends::typescript_common::generate_zod_row_struct("GetUsersRow", "GetUsers", &columns)
);
}
#[test]
fn test_outer_join_unions_option_rejects_invalid_value() {
let mut backend = TypescriptKyselyBackend::new("postgresql").unwrap();
let result = backend.apply_options(&std::collections::HashMap::from([(
"outer_join_unions".to_string(),
"maybe".to_string(),
)]));
assert!(result.is_err(), "expected 'maybe' to be rejected");
}
#[test]
fn test_structs_only_suppresses_query_fn_and_kysely_import() {
let mut backend = TypescriptKyselyBackend::new("postgresql").unwrap();
backend
.apply_options(&std::collections::HashMap::from([(
"structs_only".to_string(),
"true".to_string(),
)]))
.unwrap();
let query = make_one_query("SELECT id, name FROM users WHERE id = $1", vec![]);
let result = crate::generate_with_backend(&query, &backend).unwrap();
assert_eq!(
result.query_fn.as_deref(),
Some(""),
"structs_only must suppress the query function"
);
assert!(
result
.row_struct
.as_deref()
.unwrap()
.contains("interface GetUserByIdRow"),
"row struct must still be emitted"
);
assert!(
!backend.file_header().contains("kysely"),
"got:\n{}",
backend.file_header()
);
let header_for_results = backend.file_header_for_results(&[GeneratedCode {
query_fn: Some(String::new()),
row_struct: result.row_struct.clone(),
model_struct: None,
enum_def: None,
nested_struct_defs: Vec::new(),
..Default::default()
}]);
assert!(!header_for_results.contains("kysely"), "got:\n{header_for_results}");
}
#[test]
fn test_structs_only_unset_leaves_query_fn_present() {
let backend = TypescriptKyselyBackend::new("postgresql").unwrap();
let query = make_one_query("SELECT id, name FROM users WHERE id = $1", vec![]);
let result = crate::generate_with_backend(&query, &backend).unwrap();
assert!(
!result.query_fn.as_deref().unwrap().is_empty(),
"without structs_only the query function must still be generated"
);
assert!(backend.file_header().contains("from \"kysely\""));
}
#[test]
fn test_structs_only_rejects_invalid_value() {
let mut backend = TypescriptKyselyBackend::new("postgresql").unwrap();
let result = backend.apply_options(&std::collections::HashMap::from([(
"structs_only".to_string(),
"maybe".to_string(),
)]));
assert!(result.is_err(), "expected 'maybe' to be rejected");
}
#[test]
fn test_structs_only_combined_with_zod_row_type_keeps_zod_import_and_schema() {
let mut backend = TypescriptKyselyBackend::new("postgresql").unwrap();
backend
.apply_options(&std::collections::HashMap::from([
("structs_only".to_string(), "true".to_string()),
("row_type".to_string(), "zod".to_string()),
]))
.unwrap();
let query = make_one_query("SELECT id, name FROM users WHERE id = $1", vec![]);
let result = crate::generate_with_backend(&query, &backend).unwrap();
assert_eq!(result.query_fn.as_deref(), Some(""));
assert!(
result.row_struct.as_deref().unwrap().contains("z.object({"),
"zod schema must still be emitted"
);
let header = backend.file_header();
assert!(header.contains("import { z } from \"zod\";"), "got:\n{header}");
assert!(!header.contains("kysely"), "got:\n{header}");
}
}